インターフェース SyntheticObserverBuilder<T>
- 型パラメーター:
T- この合成オブザーバーの観測されたイベントの種類
public interface SyntheticObserverBuilder<T>合成オブザーバーのビルダー。インスタンスは再利用できません。合成オブザーバーごとに、新しいインスタンスをSyntheticComponents.addObserver(Class)またはSyntheticComponents.addObserver(Type)で作成する必要があります。- 導入:
- 4.0
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 SyntheticObserverBuilder<T>async(boolean isAsync)必要に応じて、この合成オブザーバーを非同期としてマークします。SyntheticObserverBuilder<T>declaringClass(ClassInfo declaringClass)この合成オブザーバーを「宣言」する Bean クラスを設定します。SyntheticObserverBuilder<T>declaringClass(ClassSE<?> declaringClass)この合成オブザーバーを「宣言」する Bean クラスを設定します。SyntheticObserverBuilder<T>observeWith(ClassSE<? extends SyntheticObserver<T>> observerClass)合成オブザーバーのイベント通知関数のクラスを設定します。SyntheticObserverBuilder<T>priority(int priority)この合成オブザーバーの優先度を設定します。SyntheticObserverBuilder<T>qualifier(AnnotationInfo qualifierAnnotation)この合成オブザーバーの一連の修飾子に、指定されたアノテーションを追加します。SyntheticObserverBuilder<T>qualifier(AnnotationSE qualifierAnnotation)この合成オブザーバーの一連の修飾子に、指定されたアノテーションを追加します。SyntheticObserverBuilder<T>qualifier(ClassSE<? extends AnnotationSE> annotationType)この合成オブザーバーの修飾子のセットに、指定された型のマーカーアノテーションを追加します。SyntheticObserverBuilder<T>transactionPhase(TransactionPhase transactionPhase)この合成オブザーバーに通知する必要があるTransactionPhaseを設定します。SyntheticObserverBuilder<T>withParam(StringSE key, boolean value)パラメーターマップにboolean-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, boolean[] value)パラメーターマップにboolean配列値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, double value)パラメーターマップにdouble-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, double[] value)パラメーターマップにdouble配列値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, int value)パラメーターマップにint-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, int[] value)パラメーターマップにint配列値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, long value)パラメーターマップにlong-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, long[] value)パラメーターマップにlong配列値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, AnnotationInfo value)パラメーターマップにアノテーション値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, AnnotationInfo[] value)アノテーション配列値パラメーターをパラメーターマップに追加します。SyntheticObserverBuilder<T>withParam(StringSE key, ClassInfo value)パラメーターマップにClass-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, ClassInfo[] value)パラメーターマップにClass配列値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, AnnotationSE value)パラメーターマップにアノテーション値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, AnnotationSE[] value)アノテーション配列値パラメーターをパラメーターマップに追加します。SyntheticObserverBuilder<T>withParam(StringSE key, ClassSE<?> value)パラメーターマップにClass-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, ClassSE<?>[] value)パラメーターマップにClass配列値パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, EnumSE<?> value)パラメーターマップに列挙型パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, EnumSE<?>[] value)列挙型配列値パラメーターをパラメーターマップに追加します。SyntheticObserverBuilder<T>withParam(StringSE key, StringSE value)パラメーターマップにString-valued パラメーターを追加します。SyntheticObserverBuilder<T>withParam(StringSE key, StringSE[] value)パラメーターマップにString配列値パラメーターを追加します。
メソッドの詳細
declaringClass
SyntheticObserverBuilder<T> declaringClass(ClassSE<?> declaringClass)
この合成オブザーバーを「宣言」する Bean クラスを設定します。呼び出されない場合は、この合成オブザーバーを作成する拡張機能を宣言するクラスが使用されます。
- パラメーター:
declaringClass- この合成オブザーバーを「宣言」する Bean クラスは、nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder - 例外:
IllegalStateExceptionSE- このメソッドが複数回呼び出された場合
declaringClass
SyntheticObserverBuilder<T> declaringClass(ClassInfo declaringClass)
この合成オブザーバーを「宣言」する Bean クラスを設定します。呼び出されない場合は、この合成オブザーバーを作成する拡張機能を宣言するクラスが使用されます。
- パラメーター:
declaringClass- この合成オブザーバーを「宣言」する Bean クラスは、nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder - 例外:
IllegalStateExceptionSE- このメソッドが複数回呼び出された場合
qualifier
SyntheticObserverBuilder<T> qualifier(ClassSE<? extends AnnotationSE> annotationType)
この合成オブザーバーの修飾子のセットに、指定された型のマーカーアノテーションを追加します。このメソッドは、複数の修飾子を追加するために複数回呼び出すことができます。呼び出されない場合、この合成オブザーバーには修飾子がありません。
- パラメーター:
annotationType- マーカーアノテーションの型。nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder
qualifier
SyntheticObserverBuilder<T> qualifier(AnnotationInfo qualifierAnnotation)
この合成オブザーバーの一連の修飾子に、指定されたアノテーションを追加します。このメソッドは、複数の修飾子を追加するために複数回呼び出すことができます。呼び出されない場合、この合成オブザーバーには修飾子がありません。
- パラメーター:
qualifierAnnotation- アノテーション、nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder
qualifier
SyntheticObserverBuilder<T> qualifier(AnnotationSE qualifierAnnotation)
この合成オブザーバーの一連の修飾子に、指定されたアノテーションを追加します。このメソッドは、複数の修飾子を追加するために複数回呼び出すことができます。呼び出されない場合、この合成オブザーバーには修飾子がありません。
- パラメーター:
qualifierAnnotation- アノテーション、nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder
priority
SyntheticObserverBuilder<T> priority(int priority)
この合成オブザーバーの優先度を設定します。呼び出されない場合、この合成オブザーバーのデフォルトの優先度は
Priority.APPLICATION+ 500 になります。- パラメーター:
priority- この合成オブザーバーの優先度- 戻り値:
- この
SyntheticObserverBuilder - 例外:
IllegalStateExceptionSE- このメソッドが複数回呼び出された場合
async
SyntheticObserverBuilder<T> async(boolean isAsync)
必要に応じて、この合成オブザーバーを非同期としてマークします。呼び出されない場合、この合成オブザーバーは非同期になりません。
- パラメーター:
isAsync- この合成オブザーバーを非同期にするかどうか- 戻り値:
- この
SyntheticObserverBuilder - 例外:
IllegalStateExceptionSE- このメソッドが複数回呼び出された場合
transactionPhase
SyntheticObserverBuilder<T> transactionPhase(TransactionPhase transactionPhase)
この合成オブザーバーに通知する必要があるTransactionPhaseを設定します。TransactionPhase.IN_PROGRESS以外が渡された場合、この合成オブザーバーはトランザクションオブザーバーになります。呼び出されない場合、この合成オブザーバーはトランザクションオブザーバーにはなりません。つまり、デフォルトは
TransactionPhase.IN_PROGRESSです。トランザクションオブザーバーを非同期にすることはできないことに注意してください。この合成オブザーバーがトランザクションと非同期の両方になるように構成されている場合、その登録は失敗します。
- パラメーター:
transactionPhase-TransactionPhase、nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder - 例外:
IllegalStateExceptionSE- このメソッドが複数回呼び出された場合
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, boolean value)
パラメーターマップにboolean-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, boolean[] value)
boolean配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, int value)
パラメーターマップにint-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, int[] value)
int配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, long value)
パラメーターマップにlong-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, long[] value)
long配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, double value)
パラメーターマップにdouble-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, double[] value)
double配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, StringSE value)
パラメーターマップにString-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, StringSE[] value)
String配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, EnumSE<?> value)
enum 値のパラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, EnumSE<?>[] value)
enum 配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, ClassSE<?> value)
パラメーターマップにClass-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, ClassInfo value)
パラメーターマップにClass-valued パラメーターを追加します。パラメーターマップは、イベントが発生したときにイベント通知関数に渡されます。イベント通知関数のパラメーターマップから検索すると、値は
ClassInfoではなくClassSE のインスタンスになります。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, ClassSE<?>[] value)
Class配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, ClassInfo[] value)
Class配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。イベント通知関数のパラメーターマップから検索すると、値は
ClassInfoではなくClassSE のインスタンスになります。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, AnnotationInfo value)
アノテーション値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。イベント通知関数のパラメーターマップから検索すると、値は
AnnotationInfoではなく、アノテーション型のインスタンスになります。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, AnnotationSE value)
アノテーション値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, AnnotationInfo[] value)
アノテーションの配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。イベント通知関数のパラメーターマップから検索すると、値は
AnnotationInfoではなく、対応するアノテーション型のインスタンスになります。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
withParam
SyntheticObserverBuilder<T> withParam(StringSE key, AnnotationSE[] value)
アノテーションの配列値パラメーターをパラメーターマップに追加します。パラメーターマップは、イベントの発生時にイベント通知関数に渡されます。- パラメーター:
key- パラメーターキー。nullであってはなりませんvalue- パラメーター値- 戻り値:
- この
SyntheticObserverBuilder
observeWith
SyntheticObserverBuilder<T> observeWith(ClassSE<? extends SyntheticObserver<T>> observerClass)
合成オブザーバーイベント通知関数のクラスを設定します。CDI コンテナーは、合成オブザーバーに通知する必要があるたびに、イベント通知関数のインスタンスを作成します。クラスはpublicであり、publicゼロパラメーターコンストラクターを持つ必要があります。Bean であってはなりません。呼び出されないと、合成オブザーバーの登録は失敗します。
- パラメーター:
observerClass- イベント通知関数クラスは、nullであってはなりません- 戻り値:
- この
SyntheticObserverBuilder - 例外:
IllegalStateExceptionSE- このメソッドが複数回呼び出された場合