java.awt.event
クラス InvocationEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          java.awt.event.InvocationEvent

すべての実装されたインタフェース:

ActiveEvent, Serializable

public class InvocationEvent
extends AWTEvent
implements ActiveEvent

AWT イベントのディスパッチャースレッドによってディスパッチされたときに、Runnable 上で run() メソッドを実行するイベントです。このクラスは、新しいクラスを宣言して dispatch() を定義する代わりに、ActiveEvent の参照実装として使用できます。

このクラスのインスタンスは、invokeLater および invokeAndWait の呼び出しによって EventQueue に置かれます。これによりクライアントのコードでは、特別な場合のコードを書くことなく AWTEventListener オブジェクト内に、invokeLater および invokeAndWait に代わる関数を記述することができます。

導入されたバージョン:

1.2

関連項目:

ActiveEvent, EventQueue.invokeLater(java.lang.Runnable), EventQueue.invokeAndWait(java.lang.Runnable), AWTEventListener, 直列化された形式

フィールドの概要

protected boolean	catchExceptions true に設定した場合は、dispatch() が Throwable をキャッチしてそれを例外のインスタンス変数に格納します。
static int	INVOCATION_DEFAULT すべての InvocationEvent に対するデフォルトの識別子です。
static int	INVOCATION_FIRST 呼び出しイベント識別子を表す整数型の範囲の、最初の番号です。
static int	INVOCATION_LAST 呼び出しイベント識別子を表す整数型の範囲の、最後の番号です。
protected Object	notifier Runnable.run() メソッドの復帰後ただちに呼び出される notifyAll() メソッドを持つオブジェクトです (null の場合もある)。
protected Runnable	runnable 呼び出される run() メソッドを持つ Runnable オブジェクトです。

クラス java.awt.AWTEvent から継承されたフィールド

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

クラス java.util.EventObject から継承されたフィールド

source

コンストラクタの概要

protected	InvocationEvent(Object source, int id, Runnable runnable, Object notifier, boolean catchThrowables) InvocationEvent を構築します。
	InvocationEvent(Object source, Runnable runnable) InvocationEvent を構築します。
	InvocationEvent(Object source, Runnable runnable, Object notifier, boolean catchThrowables) InvocationEvent を構築します。

メソッドの概要

void	dispatch() Runnable の run() メソッドを実行し、notifier があれば run() が復帰するときに通知します。
Exception	getException() Runnable の run() メソッド実行時にキャッチされた Exception を返します。
Throwable	getThrowable() Runnable の run() メソッド実行時にキャッチされた Throwable を返します。
long	getWhen() このイベントが発生した時点のタイムスタンプを返します。
String	paramString() このイベントを特定するパラメータの文字列を返します。

クラス java.awt.AWTEvent から継承されたメソッド

consume, getID, isConsumed, setSource, toString

クラス java.util.EventObject から継承されたメソッド

getSource

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

INVOCATION_FIRST

public static final int INVOCATION_FIRST

呼び出しイベント識別子を表す整数型の範囲の、最初の番号です。

関連項目:

定数フィールド値

INVOCATION_DEFAULT

public static final int INVOCATION_DEFAULT

すべての InvocationEvent に対するデフォルトの識別子です。

関連項目:

定数フィールド値

INVOCATION_LAST

public static final int INVOCATION_LAST

呼び出しイベント識別子を表す整数型の範囲の、最後の番号です。

関連項目:

定数フィールド値

runnable

protected Runnable runnable

呼び出される run() メソッドを持つ Runnable オブジェクトです。

notifier

protected Object notifier

Runnable.run() メソッドの復帰後ただちに呼び出される notifyAll() メソッドを持つオブジェクトです (null の場合もある)。

catchExceptions

protected boolean catchExceptions

true に設定した場合は、dispatch() が Throwable をキャッチしてそれを例外のインスタンス変数に格納します。false の場合は、Throwable は EventDispatchThread のディスパッチループまで送られます。

コンストラクタの詳細

InvocationEvent

public InvocationEvent(Object source,
                       Runnable runnable)

InvocationEvent を構築します。この際、ディスパッチされたときに runnable の run メソッドを実行する発生元のオブジェクトを指定します。

これは簡易コンストラクタです。InvocationEvent(source, runnable) の形式で呼び出した場合、InvocationEvent(source, runnable, null, false) の呼び出しとまったく同じように動作します。

このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元の Object

runnable - 実行される run メソッドを持つ Runnable

例外:

IllegalArgumentException - source が null の場合

関連項目:

InvocationEvent(Object, Runnable, Object, boolean)

InvocationEvent

public InvocationEvent(Object source,
                       Runnable runnable,
                       Object notifier,
                       boolean catchThrowables)

InvocationEvent を構築します。この際、ディスパッチされたときに runnable の run メソッドを実行する発生元のオブジェクトを指定します。notifier が null でない場合は、run の復帰後ただちにそのオブジェクトの notifyAll() が呼び出されます。

InvocationEvent(source, runnable, notifier, catchThrowables) の形式で呼び出した場合、InvocationEvent(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables) の呼び出しとまったく同じように動作します。

このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元の Object

runnable - 実行される run メソッドを持つ Runnable

notifier - Runnable.run の復帰後に呼び出される notifyAll メソッドを持つ Object

catchThrowables - Runnable の run メソッドの実行時に、dispatch により Throwable がキャッチされるか、これらの Throwable が EventDispatchThread のディスパッチループまで送られるかを指定する

例外:

IllegalArgumentException - source が null の場合

関連項目:

InvocationEvent(Object, int, Runnable, Object, boolean)

InvocationEvent

protected InvocationEvent(Object source,
                          int id,
                          Runnable runnable,
                          Object notifier,
                          boolean catchThrowables)

InvocationEvent を構築します。 この際、ディスパッチされたときに runnable の run メソッドを実行する発生元のオブジェクトとイベントの識別子を指定します。notifier が null でない場合は、run の復帰後ただちにそのオブジェクトの notifyAll が呼び出されます。

無効な id を渡して、特定できない動作を発生させないようにしてください。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントの発生元の Object

id - イベントの識別子

runnable - 実行される run メソッドを持つ Runnable

notifier - Runnable.run の復帰後に呼び出される notifyAll メソッドを持つ Object

catchThrowables - Runnable の run メソッドの実行時に、dispatch により Throwable がキャッチされるか、これらの Throwable が EventDispatchThread のディスパッチループまで送られるかを指定する

例外:

IllegalArgumentException - source が null の場合

メソッドの詳細

dispatch

public void dispatch()

Runnable の run() メソッドを実行し、notifier があれば run() が復帰するときに通知します。

定義:

インタフェース ActiveEvent 内の dispatch

getException

public Exception getException()

Runnable の run() メソッド実行時にキャッチされた Exception を返します。

戻り値:

Exception がスローされた場合はその Exception に対する参照。Exception がスローされなかった場合、または InovocationEvent が例外をキャッチしなかった場合は null

getThrowable

public Throwable getThrowable()

Runnable の run() メソッド実行時にキャッチされた Throwable を返します。

戻り値:

Throwable がスローされた場合はその Throwable に対する参照。Throwable がスローされなかった場合、または InvocationEvent が Throwable をキャッチしなかった場合は null

導入されたバージョン:

1.5

getWhen

public long getWhen()

このイベントが発生した時点のタイムスタンプを返します。

戻り値:

このイベントのタイムスタンプ

導入されたバージョン:

1.4

paramString

public String paramString()

このイベントを特定するパラメータの文字列を返します。このメソッドは、イベントログの作成およびデバッグに使用します。

オーバーライド:

クラス AWTEvent 内の paramString

戻り値:

イベントを特定する文字列とその属性