インターフェース OutboundSseEvent.Builder

メソッドの詳細

• id

  OutboundSseEvent.Builder id(StringSE id)

  イベント ID を設定します。

  SSE "id" フィールドの値として送信されます。このフィールドはオプションです。

  パラメーター:

  id - イベント ID。

  戻り値:

  ビルダーインスタンスを更新しました。

• name

  OutboundSseEvent.Builder name(StringSE name)

  イベント名を設定します。

  SSE "event" フィールドの値として送信されます。このフィールドはオプションです。

  パラメーター:

  name - イベント名。

  戻り値:

  ビルダーインスタンスを更新しました。

• reconnectDelay

  OutboundSseEvent.Builder reconnectDelay(long milliseconds)

  SSE イベントソースへの接続が失われた場合に、イベントレシーバーが再接続を試行するまで待機する時間を示す再接続遅延（ミリ秒単位）を設定します。

  SSE "retry" フィールドの値として送信されます。このフィールドはオプションです。

  OutboundSseEvent インスタンスにこのフィールドの値がないことは、SseEvent.getReconnectDelay() から返される SseEvent.RECONNECT_NOT_SET 値によって示されます。

  パラメーター:

  milliseconds - ミリ秒単位の再接続遅延。負の値は、再接続遅延の設定を解除します。

  戻り値:

  ビルダーインスタンスを更新しました。

• mediaType

  OutboundSseEvent.Builder mediaType(MediaType mediaType)

  イベントデータの media type を設定します。

  この情報は必須です。デフォルト値は MediaType.TEXT_PLAIN です。

  パラメーター:

  mediaType - イベントデータの MediaType。null であってはなりません。

  戻り値:

  ビルダーインスタンスを更新しました。

  例外:

  NullPointerExceptionSE - mediaType パラメーターが null の場合。

• comment

  OutboundSseEvent.Builder comment(StringSE comment)

  イベントに関連付けられたコメント文字列を設定します。

  コメントは、イベントデータが直列化される前に、イベントとともに直列化されます。イベントにデータが含まれていない場合は、コメントのみを含む別の「イベント」が送信されます。イベントデータが設定されている場合、この情報はオプションです。

  このメソッドを複数回呼び出すと、前のコメントが新しいコメントに置き換えられることに注意してください。複数行コメントを作成するには、複数行コメント文字列を使用する必要があります。

  パラメーター:

  comment - コメント文字列。

  戻り値:

  ビルダーインスタンスを更新しました。

• data

  OutboundSseEvent.Builder data(ClassSE type, ObjectSE data)

  イベントデータと java 型のイベントデータを設定します。

  型情報は MessageBodyWriter ルックアップに使用されます。

  このメソッドを複数回呼び出すと、以前の偶数データが新しいデータに置き換えられることに注意してください。

  パラメーター:

  type - 提供されるデータの java 型。null であってはなりません。

  data - イベントデータ。null であってはなりません。

  戻り値:

  ビルダーインスタンスを更新しました。

  例外:

  NullPointerExceptionSE - type または data パラメーターのいずれかが null の場合。

• data

  OutboundSseEvent.Builder data(GenericType type, ObjectSE data)

  イベントデータと一般的な java 型のイベントデータを設定します。

  型情報は MessageBodyWriter ルックアップに使用されます。

  このメソッドを複数回呼び出すと、以前の偶数データが新しいデータに置き換えられることに注意してください。

  パラメーター:

  type - 提供されるデータのジェネリクス型。null であってはなりません。

  data - イベントデータ。null であってはなりません。

  戻り値:

  ビルダーインスタンスを更新しました。

  例外:

  NullPointerExceptionSE - type または data パラメーターのいずれかが null の場合。

• data

  OutboundSseEvent.Builder data(ObjectSE data)

  イベントデータと java 型のイベントデータを設定します。

  これは、イベントデータの実行時型からイベントデータ型情報を取得する便利なメソッドです。提供されたイベントデータは、GenericEntity として表すことができます。

  このメソッドを複数回呼び出すと、以前の偶数データが新しいデータに置き換えられることに注意してください。

  パラメーター:

  data - イベントデータ。null であってはなりません。

  戻り値:

  ビルダーインスタンスを更新しました。

  例外:

  NullPointerExceptionSE - data パラメーターが null の場合。

• build

  OutboundSseEvent build()

  OutboundSseEvent をビルドします。

  2 つの有効な構成があります。

  • comment が設定されている場合、他のすべてのパラメーターはオプションです。イベント data および media type が設定されている場合、イベントデータはコメントの後に直列化されます。
  • comment が設定されていない場合は、少なくともイベント data を設定する必要があります。他のすべてのパラメーターはオプションです。

  戻り値:

  新しい OutboundSseEvent インスタンス。

  例外:

  IllegalStateExceptionSE - 無効な構成で呼び出された場合（コメントもイベントデータも設定されていません）。