JavaEE Web API 8.0.1 · javax.ws.rs.sse.InboundSseEvent

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if current instance does not contain any data, `false` otherwise. isEmpty() Check if the event is empty (i.e. does not contain any data).
public String	Returns: event data de-serialized into a string. readData() Get the original event data as `String`.
public <T> T	Returns: event data de-serialized as an instance of a given type. readData(Class<T> Java type to be used for event data de-serialization. type) Read event data as a given Java type.
public <T> T	Returns: event data de-serialized as an instance of a given type. readData(GenericType<T> generic type to be used for event data de-serialization. type) Read event data as a given generic type.
public <T> T	Returns: event data de-serialized as an instance of a given type. readData(Class<T> Java type to be used for event data de-serialization. messageType, MediaType `media type` to be used for event data de-serialization. mediaType) Read event data as a given Java type.
public <T> T	Returns: event data de-serialized as an instance of a given type. readData(GenericType<T> generic type to be used for event data de-serialization. type, MediaType `media type` to be used for event data de-serialization. mediaType) Read event data as a given generic type.

Inherited from javax.ws.rs.sse.SseEvent:: getComment getId getName getReconnectDelay isReconnectDelaySet

Method Detail

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Check if the event is empty (i.e. does not contain any data). Returns:boolean `true` if current instance does not contain any data, `false` otherwise.

public boolean isEmpty()

Check if the event is empty (i.e. does not contain any data).

Returns:boolean: true if current instance does not contain any data, false otherwise.

readData back to summary

readData	back to summary
public String readData() Get the original event data as `String`. Returns:String event data de-serialized into a string. Exceptions ProcessingException: when provided type can't be read. The thrown exception wraps the original cause.

public String readData()

Get the original event data as String.

Returns:String

event data de-serialized into a string.

Exceptions

ProcessingException:: when provided type can't be read. The thrown exception wraps the original cause.

readData	back to summary
public <T> T readData(Class<T> type) Read event data as a given Java type. Parameters type:Class<T> Java type to be used for event data de-serialization. Returns:T event data de-serialized as an instance of a given type. Exceptions ProcessingException: when provided type can't be read. The thrown exception wraps the original cause.

readData

back to summary

public <T> T readData(Class<T> type)

Read event data as a given Java type.

Parameters

type:Class<T>: Java type to be used for event data de-serialization.

Returns:T

event data de-serialized as an instance of a given type.

Exceptions

ProcessingException:: when provided type can't be read. The thrown exception wraps the original cause.

readData	back to summary
public <T> T readData(GenericType<T> type) Read event data as a given generic type. Parameters type:GenericType<T> generic type to be used for event data de-serialization. Returns:T event data de-serialized as an instance of a given type. Exceptions ProcessingException: when provided type can't be read. The thrown exception wraps the original cause.

readData

back to summary

public <T> T readData(GenericType<T> type)

Read event data as a given generic type.

Parameters

type:GenericType<T>: generic type to be used for event data de-serialization.

Returns:T

event data de-serialized as an instance of a given type.

Exceptions

ProcessingException:: when provided type can't be read. The thrown exception wraps the original cause.

readData back to summary

readData	back to summary
public <T> T readData(Class<T> messageType, MediaType mediaType) Read event data as a given Java type. Parameters messageType:Class<T> Java type to be used for event data de-serialization. mediaType:MediaType `media type` to be used for event data de-serialization. Returns:T event data de-serialized as an instance of a given type. Exceptions ProcessingException: when provided type can't be read. The thrown exception wraps the original cause.

public <T> T readData(Class<T> messageType, MediaType mediaType)

Read event data as a given Java type.

Parameters

messageType:Class<T>: Java type to be used for event data de-serialization.
mediaType:MediaType: media type to be used for event data de-serialization.

Returns:T

event data de-serialized as an instance of a given type.

Exceptions

ProcessingException:: when provided type can't be read. The thrown exception wraps the original cause.

readData back to summary

readData	back to summary
public <T> T readData(GenericType<T> type, MediaType mediaType) Read event data as a given generic type. Parameters type:GenericType<T> generic type to be used for event data de-serialization. mediaType:MediaType `media type` to be used for event data de-serialization. Returns:T event data de-serialized as an instance of a given type. Exceptions ProcessingException: when provided type can't be read. The thrown exception wraps the original cause.

public <T> T readData(GenericType<T> type, MediaType mediaType)

Read event data as a given generic type.

Parameters

type:GenericType<T>: generic type to be used for event data de-serialization.
mediaType:MediaType: media type to be used for event data de-serialization.

Returns:T

event data de-serialized as an instance of a given type.

Exceptions

ProcessingException:: when provided type can't be read. The thrown exception wraps the original cause.

public Interface InboundSseEvent

Field Summary

Method Summary

Method Detail