A PushEvent is an immutable object that is transferred through a communication channel to push information to a downstream consumer. The event has three different types:

EventType#DATA – Provides access to a typed data element in the stream.
EventType#CLOSE – The stream is closed. After receiving this event, no more events will follow.
EventType#ERROR – The stream ran into an unrecoverable problem and is sending the reason downstream. The stream is closed and no more events will follow after this event.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	PushEvent.CloseEvent<T>
pack-priv static class	PushEvent.DataEvent<T>
pack-priv static class	PushEvent.ErrorEvent<T>
public static enum	PushEvent.EventType The type of a `PushEvent`.

Constructor Summary

Access	Constructor and Description
pack-priv	PushEvent() Package private default constructor.

Method Summary

Modifier and Type	Method and Description
public static < The payload type. T> PushEvent<T>	Returns: A new close event. close() Create a new close event.
public static < The payload type. T> PushEvent<T>	Returns: A new data event wrapping the specified payload. data(T The payload. payload) Create a new data event.
public static < The payload type. T> PushEvent<T>	Returns: A new error event with the specified error. error(Throwable The error. t) Create a new error event.
public T	Returns: The data payload. getData() Return the data for this event.
public Throwable	Returns: The error that terminated the stream. getFailure() Return the error that terminated the stream.
public abstract PushEvent.EventType	Returns: The type of this event. getType() Get the type of this event.
public boolean	Returns: `false` if this is a data event, otherwise `true`. isTerminal() Answer if no more events will follow after this event.
public < The new payload type. X> PushEvent<X>	Returns: The current error or close event mapped to a new payload type. nodata() Convenience to cast a close/error event to another payload type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

PushEvent	back to summary
pack-priv PushEvent() Package private default constructor.

Method Detail

close	back to summary
public static <T> PushEvent<T> close() Create a new close event. Parameters <T> The payload type. Returns:PushEvent<T> A new close event.

back to summary

public static <T> PushEvent<T> close()

Create a new close event.

Parameters

<T>: The payload type.

Returns:PushEvent<T>

A new close event.

data	back to summary
public static <T> PushEvent<T> data(T payload) Create a new data event. Parameters <T> The payload type. payload:T The payload. Returns:PushEvent<T> A new data event wrapping the specified payload.

error	back to summary
public static <T> PushEvent<T> error(Throwable t) Create a new error event. Parameters <T> The payload type. t:Throwable The error. Returns:PushEvent<T> A new error event with the specified error.

error

back to summary

public static <T> PushEvent<T> error(Throwable t)

Create a new error event.

Parameters

<T>: The payload type.
t:Throwable: The error.

Returns:PushEvent<T>

A new error event with the specified error.

getData back to summary

getData	back to summary
public T getData() Return the data for this event. Returns:T The data payload. Exceptions IllegalStateException: if this event is not a `EventType#DATA` event.

public T getData()

Return the data for this event.

Returns:T

The data payload.

Exceptions

IllegalStateException:: if this event is not a EventType#DATA event.

getFailure back to summary

getFailure	back to summary
public Throwable getFailure() Return the error that terminated the stream. Returns:Throwable The error that terminated the stream. Exceptions IllegalStateException: if this event is not an `EventType#ERROR` event.

public Throwable getFailure()

Return the error that terminated the stream.

Returns:Throwable

The error that terminated the stream.

Exceptions

IllegalStateException:: if this event is not an EventType#ERROR event.

getType	back to summary
public abstract PushEvent.EventType getType() Get the type of this event. Returns:PushEvent.EventType The type of this event.

getType

back to summary

public abstract PushEvent.EventType getType()

Get the type of this event.

Returns:PushEvent.EventType: The type of this event.

isTerminal back to summary

isTerminal	back to summary
public boolean isTerminal() Answer if no more events will follow after this event. Returns:boolean `false` if this is a data event, otherwise `true`.

public boolean isTerminal()

Answer if no more events will follow after this event.

Returns:boolean: false if this is a data event, otherwise true.

nodata back to summary

nodata	back to summary
public <X> PushEvent<X> nodata() Convenience to cast a close/error event to another payload type. Since the payload type is not needed for these events this is harmless. This therefore allows you to forward the close/error event downstream without creating anew event. Parameters <X> The new payload type. Returns:PushEvent<X> The current error or close event mapped to a new payload type. Exceptions IllegalStateException: if the event is a `EventType#DATA` event.

public <X> PushEvent<X> nodata()

Convenience to cast a close/error event to another payload type. Since the payload type is not needed for these events this is harmless. This therefore allows you to forward the close/error event downstream without creating anew event.

Parameters

<X>: The new payload type.

Returns:PushEvent<X>

The current error or close event mapped to a new payload type.

Exceptions

IllegalStateException:: if the event is a EventType#DATA event.

org.osgi.util.pushstream back to summary

pack-priv final Class PushEvent.CloseEvent<T>

Class Inheritance

extends PushEvent<T>

java.lang.Object
org.osgi.util.pushstream.PushEvent
org.osgi.util.pushstream.PushEvent.CloseEvent

Constructor Summary

Access	Constructor and Description
pack-priv	CloseEvent()

Method Summary

Modifier and Type	Method and Description
public PushEvent.EventType	getType() Implements abstract org.osgi.util.pushstream.PushEvent.getType. Get the type of this event.

Inherited from org.osgi.util.pushstream.PushEvent:: close data error getData getFailure isTerminal nodata

Constructor Detail

CloseEvent	back to summary
pack-priv CloseEvent()

Method Detail

getType	back to summary
public PushEvent.EventType getType() Implements abstract org.osgi.util.pushstream.PushEvent.getType. Doc from org.osgi.util.pushstream.PushEvent.getType. Get the type of this event. Returns:PushEvent.EventType The type of this event. Annotations @Override

getType

back to summary

public PushEvent.EventType getType()

Implements abstract org.osgi.util.pushstream.PushEvent.getType.

Doc from org.osgi.util.pushstream.PushEvent.getType.

Get the type of this event.

Returns:PushEvent.EventType

The type of this event.

Annotations

@Override

org.osgi.util.pushstream back to summary

pack-priv final Class PushEvent.DataEvent<T>

Class Inheritance

extends PushEvent<T>

java.lang.Object
org.osgi.util.pushstream.PushEvent
org.osgi.util.pushstream.PushEvent.DataEvent

Field Summary

Modifier and Type	Field and Description
private final T	data

Constructor Summary

Access	Constructor and Description
pack-priv	DataEvent(T data)

Method Summary

Modifier and Type	Method and Description
public T	getData() Overrides org.osgi.util.pushstream.PushEvent.getData. Return the data for this event.
public PushEvent.EventType	getType() Implements abstract org.osgi.util.pushstream.PushEvent.getType. Get the type of this event.
public boolean	isTerminal() Overrides org.osgi.util.pushstream.PushEvent.isTerminal. Answer if no more events will follow after this event.
public <X> PushEvent<X>	nodata() Overrides org.osgi.util.pushstream.PushEvent.nodata. Convenience to cast a close/error event to another payload type.

Inherited from org.osgi.util.pushstream.PushEvent:: close data error getFailure

Field Detail

data	back to summary
private final T data

Constructor Detail

DataEvent	back to summary
pack-priv DataEvent(T data)

Method Detail

getData	back to summary
public T getData() Overrides org.osgi.util.pushstream.PushEvent.getData. Doc from org.osgi.util.pushstream.PushEvent.getData. Return the data for this event. Returns:T The data payload. Annotations @Override

getData

back to summary

public T getData()

Overrides org.osgi.util.pushstream.PushEvent.getData.

Doc from org.osgi.util.pushstream.PushEvent.getData.

Return the data for this event.

Returns:T

The data payload.

Annotations

@Override

getType	back to summary
public PushEvent.EventType getType() Implements abstract org.osgi.util.pushstream.PushEvent.getType. Doc from org.osgi.util.pushstream.PushEvent.getType. Get the type of this event. Returns:PushEvent.EventType The type of this event. Annotations @Override

getType

back to summary

public PushEvent.EventType getType()

Implements abstract org.osgi.util.pushstream.PushEvent.getType.

Doc from org.osgi.util.pushstream.PushEvent.getType.

Get the type of this event.

Returns:PushEvent.EventType

The type of this event.

Annotations

@Override

isTerminal back to summary

isTerminal	back to summary
public boolean isTerminal() Overrides org.osgi.util.pushstream.PushEvent.isTerminal. Doc from org.osgi.util.pushstream.PushEvent.isTerminal. Answer if no more events will follow after this event. Returns:boolean `false` if this is a data event, otherwise `true`. Annotations @Override

public boolean isTerminal()

Overrides org.osgi.util.pushstream.PushEvent.isTerminal.

Doc from org.osgi.util.pushstream.PushEvent.isTerminal.

Answer if no more events will follow after this event.

Returns:boolean

false if this is a data event, otherwise true.

Annotations

@Override

nodata	back to summary
public <X> PushEvent<X> nodata() Overrides org.osgi.util.pushstream.PushEvent.nodata. Doc from org.osgi.util.pushstream.PushEvent.nodata. Convenience to cast a close/error event to another payload type. Since the payload type is not needed for these events this is harmless. This therefore allows you to forward the close/error event downstream without creating anew event. Parameters <X> The new payload type. Returns:PushEvent<X> The current error or close event mapped to a new payload type. Annotations @Override

nodata

back to summary

public <X> PushEvent<X> nodata()

Overrides org.osgi.util.pushstream.PushEvent.nodata.

Doc from org.osgi.util.pushstream.PushEvent.nodata.

Parameters

<X>: The new payload type.

Returns:PushEvent<X>

The current error or close event mapped to a new payload type.

Annotations

@Override

org.osgi.util.pushstream back to summary

pack-priv final Class PushEvent.ErrorEvent<T>

Class Inheritance

extends PushEvent<T>

java.lang.Object
org.osgi.util.pushstream.PushEvent
org.osgi.util.pushstream.PushEvent.ErrorEvent

Field Summary

Modifier and Type	Field and Description
private final Throwable	error

Constructor Summary

Access	Constructor and Description
pack-priv	ErrorEvent(Throwable error)

Method Summary

Modifier and Type	Method and Description
public Throwable	getFailure() Overrides org.osgi.util.pushstream.PushEvent.getFailure. Return the error that terminated the stream.
public PushEvent.EventType	getType() Implements abstract org.osgi.util.pushstream.PushEvent.getType. Get the type of this event.

Inherited from org.osgi.util.pushstream.PushEvent:: close data error getData isTerminal nodata

Field Detail

error	back to summary
private final Throwable error

Constructor Detail

ErrorEvent	back to summary
pack-priv ErrorEvent(Throwable error)

Method Detail

getFailure	back to summary
public Throwable getFailure() Overrides org.osgi.util.pushstream.PushEvent.getFailure. Doc from org.osgi.util.pushstream.PushEvent.getFailure. Return the error that terminated the stream. Returns:Throwable The error that terminated the stream. Annotations @Override

getFailure

back to summary

public Throwable getFailure()

Overrides org.osgi.util.pushstream.PushEvent.getFailure.

Doc from org.osgi.util.pushstream.PushEvent.getFailure.

Return the error that terminated the stream.

Returns:Throwable

The error that terminated the stream.

Annotations

@Override

getType	back to summary
public PushEvent.EventType getType() Implements abstract org.osgi.util.pushstream.PushEvent.getType. Doc from org.osgi.util.pushstream.PushEvent.getType. Get the type of this event. Returns:PushEvent.EventType The type of this event. Annotations @Override

getType

back to summary

public PushEvent.EventType getType()

Implements abstract org.osgi.util.pushstream.PushEvent.getType.

Doc from org.osgi.util.pushstream.PushEvent.getType.

Get the type of this event.

Returns:PushEvent.EventType

The type of this event.

Annotations

@Override

org.osgi.util.pushstream back to summary

public final Enum PushEvent.EventType

Class Inheritance

extends Enum<PushEvent.EventType>

java.lang.Object
java.lang.Enum
org.osgi.util.pushstream.PushEvent.EventType

The type of a PushEvent.

Field Summary

Modifier and Type	Field and Description
public static final PushEvent.EventType	CLOSE An event that indicates that the stream has terminated normally
public static final PushEvent.EventType	DATA A data event forming part of the stream
public static final PushEvent.EventType	ERROR An error event that indicates streaming has failed and that no more events will arrive

Constructor Summary

Access	Constructor and Description
private	EventType()

Method Summary

Modifier and Type	Method and Description
public static PushEvent.EventType	valueOf(String name)
public static PushEvent.EventType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CLOSE	back to summary
public static final PushEvent.EventType CLOSE An event that indicates that the stream has terminated normally

DATA	back to summary
public static final PushEvent.EventType DATA A data event forming part of the stream

ERROR	back to summary
public static final PushEvent.EventType ERROR An error event that indicates streaming has failed and that no more events will arrive

Constructor Detail

EventType	back to summary
private EventType()

Method Detail

valueOf	back to summary
public static PushEvent.EventType valueOf(String name)

values	back to summary
public static PushEvent.EventType[] values()

public abstract Class PushEvent<T>

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Class PushEvent.CloseEvent<T>

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Class PushEvent.DataEvent<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class PushEvent.ErrorEvent<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PushEvent.EventType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail