パッケージ jakarta.ws.rs.sse

インターフェース InboundSseEvent

すべてのスーパーインターフェース:
SseEvent

public interface InboundSseEvent extends SseEvent
受信サーバー送信イベント。

サーバーから送信された受信イベントを受け入れるときに、クライアント側で使用されます。

導入:
2.1
作成者:
Marek Potociar
  • フィールドのサマリー

    インターフェース jakarta.ws.rs.sse.SseEvent から継承されたフィールド

    RECONNECT_NOT_SET
  • 方法の概要

    修飾子と型
    メソッド
    説明
    boolean
    イベントが空(つまり、データが含まれていない)かどうかを確認します。
    元のイベントデータを StringSE として取得します。
    <T> T
    イベントデータを特定のジェネリクス型として読み取ります。
    <T> T
    readData(GenericType<T> type, MediaType mediaType)
    イベントデータを特定のジェネリクス型として読み取ります。
    <T> T
    readData(ClassSE<T> type)
    特定の Java 型としてイベントデータを読み取ります。
    <T> T
    readData(ClassSE<T> messageType, MediaType mediaType)
    特定の Java 型としてイベントデータを読み取ります。

    インターフェース jakarta.ws.rs.sse.SseEvent から継承されたメソッド

    getComment, getId, getName, getReconnectDelay, isReconnectDelaySet
  • メソッドの詳細

    • isEmpty

      boolean isEmpty()
      イベントが空(つまり、データが含まれていない)かどうかを確認します。
      戻り値:
      現在のインスタンスにデータが含まれていない場合は true、それ以外の場合は false
    • readData

      StringSE readData()
      元のイベントデータを StringSE として取得します。
      戻り値:
      文字列に逆直列化されたイベントデータ。
      例外:
      ProcessingException - 提供された場合、型は読み取ることができません。スローされた例外は、元の原因をラップします。
    • readData

      <T> T readData(ClassSE<T> type)
      特定の Java 型としてイベントデータを読み取ります。
      型パラメーター:
      T - ジェネリクスイベントデータ型
      パラメーター:
      type - イベントデータの逆直列化に使用される Java 型。
      戻り値:
      特定の型のインスタンスとして逆直列化されたイベントデータ。
      例外:
      ProcessingException - 提供された場合、型は読み取ることができません。スローされた例外は、元の原因をラップします。
    • readData

      <T> T readData(GenericType<T> type)
      イベントデータを特定のジェネリクス型として読み取ります。
      型パラメーター:
      T - ジェネリクスイベントデータ型
      パラメーター:
      type - イベントデータの逆直列化に使用されるジェネリクス型。
      戻り値:
      特定の型のインスタンスとして逆直列化されたイベントデータ。
      例外:
      ProcessingException - 提供された場合、型は読み取ることができません。スローされた例外は、元の原因をラップします。
    • readData

      <T> T readData(ClassSE<T> messageType, MediaType mediaType)
      特定の Java 型としてイベントデータを読み取ります。
      型パラメーター:
      T - ジェネリクスイベントデータ型
      パラメーター:
      messageType - イベントデータの逆直列化に使用される Java 型。
      mediaType - イベントデータの逆直列化に使用される media type
      戻り値:
      特定の型のインスタンスとして逆直列化されたイベントデータ。
      例外:
      ProcessingException - 提供された場合、型は読み取ることができません。スローされた例外は、元の原因をラップします。
    • readData

      <T> T readData(GenericType<T> type, MediaType mediaType)
      イベントデータを特定のジェネリクス型として読み取ります。
      型パラメーター:
      T - ジェネリクスイベントデータ型
      パラメーター:
      type - イベントデータの逆直列化に使用されるジェネリクス型。
      mediaType - イベントデータの逆直列化に使用される media type
      戻り値:
      特定の型のインスタンスとして逆直列化されたイベントデータ。
      例外:
      ProcessingException - 提供された場合、型は読み取ることができません。スローされた例外は、元の原因をラップします。