public static interface OutboundSseEvent.Builder
OutboundSseEvent
インスタンスの作成に使用されるビルダークラス。修飾子と型 | メソッドと説明 |
---|---|
OutboundSseEvent | build() OutboundSseEvent をビルドします。 |
OutboundSseEvent.Builder | comment(StringSE comment) イベントに関連付けられたコメント文字列を設定します。 |
OutboundSseEvent.Builder | data(ClassSE type, ObjectSE data) イベントデータと java 型のイベントデータを設定します。 |
OutboundSseEvent.Builder | data(GenericType type, ObjectSE data) イベントデータと一般的な java 型のイベントデータを設定します。 |
OutboundSseEvent.Builder | data(ObjectSE data) イベントデータと java 型のイベントデータを設定します。 |
OutboundSseEvent.Builder | id(StringSE id) イベント ID を設定します。 |
OutboundSseEvent.Builder | mediaType(MediaType mediaType) イベントデータの media type を設定します。 |
OutboundSseEvent.Builder | name(StringSE name) イベント名を設定します。 |
OutboundSseEvent.Builder | reconnectDelay(long milliseconds) SSE イベントソースへの接続が失われた場合に、イベントレシーバーが再接続を試行するまで待機する時間を示す再接続遅延(ミリ秒単位)を設定します。 |
OutboundSseEvent.Builder id(StringSE id)
SSE "id"
フィールドの値として送信されます。このフィールドはオプションです。
id
- イベント ID。OutboundSseEvent.Builder name(StringSE name)
SSE "event"
フィールドの値として送信されます。このフィールドはオプションです。
name
- イベント名。OutboundSseEvent.Builder reconnectDelay(long milliseconds)
SSE "retry"
フィールドの値として送信されます。このフィールドはオプションです。
OutboundSseEvent
インスタンスにこのフィールドの値がないことは、SseEvent.getReconnectDelay()
から返される SseEvent.RECONNECT_NOT_SET
値によって示されます。
milliseconds
- ミリ秒単位の再接続遅延。負の値は、再接続遅延の設定を解除します。OutboundSseEvent.Builder mediaType(MediaType mediaType)
media type
を設定します。 この情報は必須です。デフォルト値は MediaType.TEXT_PLAIN
です。
mediaType
- イベントデータの MediaType
。null
であってはなりません。NullPointerExceptionSE
- mediaType
パラメーターが null
の場合。OutboundSseEvent.Builder comment(StringSE comment)
コメントは、イベントデータが直列化される前に、イベントとともに直列化されます。イベントにデータが含まれていない場合は、コメントのみを含む別の「イベント」が送信されます。イベントデータが設定されている場合、この情報はオプションです。
このメソッドを複数回呼び出すと、前のコメントが新しいコメントに置き換えられることに注意してください。複数行コメントを作成するには、複数行コメント文字列を使用する必要があります。
comment
- コメント文字列。OutboundSseEvent.Builder data(ClassSE type, ObjectSE data)
型情報は MessageBodyWriter
ルックアップに使用されます。
このメソッドを複数回呼び出すと、以前の偶数データが新しいデータに置き換えられることに注意してください。
type
- 提供されるデータの java 型。null
であってはなりません。data
- イベントデータ。null
であってはなりません。NullPointerExceptionSE
- type
または data
パラメーターのいずれかが null
の場合。OutboundSseEvent.Builder data(GenericType type, ObjectSE data)
型情報は MessageBodyWriter
ルックアップに使用されます。
このメソッドを複数回呼び出すと、以前の偶数データが新しいデータに置き換えられることに注意してください。
type
- 提供されるデータのジェネリクス型。null
であってはなりません。data
- イベントデータ。null
であってはなりません。NullPointerExceptionSE
- type
または data
パラメーターのいずれかが null
の場合。OutboundSseEvent.Builder data(ObjectSE data)
これは、イベントデータの実行時型からイベントデータ型情報を取得する便利なメソッドです。提供されたイベントデータは、GenericEntity
として表すことができます。
このメソッドを複数回呼び出すと、以前の偶数データが新しいデータに置き換えられることに注意してください。
data
- イベントデータ。null
であってはなりません。NullPointerExceptionSE
- data
パラメーターが null
の場合。OutboundSseEvent build()
OutboundSseEvent
をビルドします。2 つの有効な構成があります。
comment
が設定されている場合、他のすべてのパラメーターはオプションです。イベント data
および media type
が設定されている場合、イベントデータはコメントの後に直列化されます。comment
が設定されていない場合は、少なくともイベント data
を設定する必要があります。他のすべてのパラメーターはオプションです。OutboundSseEvent
インスタンス。IllegalStateExceptionSE
- 無効な構成で呼び出された場合(コメントもイベントデータも設定されていません)。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.