org.omg.dds.sub

Interface Subscriber.DataState

All Superinterfaces:

Cloneable, DDSObject

Enclosing interface:

Subscriber

public static interface Subscriber.DataState
extends DDSObject, Cloneable

A DataState encapsulates sets of sample states, view states, and instance states as a convenience. Instances of DataState may be unmodifiable, in which case methods that would change them shall throw UnsupportedOperationException.

Method Summary

Methods

Modifier and Type	Method and Description
Subscriber.DataState	clone()
boolean	equals(Object other)
Set<InstanceState>	getInstanceStates() Get the current set of instance states.
Set<SampleState>	getSampleStates() Get the current set of sample states.
Set<ViewState>	getViewStates() Get the current set of view states.
int	hashCode()
Subscriber.DataState	with(InstanceState state) Add the given InstanceState to this DataState.
Subscriber.DataState	with(SampleState state) Add the given SampleState to this DataState.
Subscriber.DataState	with(ViewState state) Add the given ViewState to this DataState.
Subscriber.DataState	withAnyInstanceState() Add all InstanceState values to this DataState.
Subscriber.DataState	withAnySampleState() Add all SampleState values to this DataState.
Subscriber.DataState	withAnyViewState() Add all ViewState values to this DataState.
Subscriber.DataState	withNotAliveInstanceStates() Add InstanceState.NOT_ALIVE_DISPOSED and InstanceState.NOT_ALIVE_NO_WRITERS to this DataState.

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Method Detail

getSampleStates

Set<SampleState> getSampleStates()

Get the current set of sample states. The resulting unmodifiable collection may be empty, but it shall never be null.

Returns:

the current set of sample states.

getViewStates

Set<ViewState> getViewStates()

Get the current set of view states. The resulting unmodifiable collection may be empty, but it shall never be null.

Returns:

the current set of view states.

getInstanceStates

Set<InstanceState> getInstanceStates()

Get the current set of instance states. The resulting unmodifiable collection may be empty, but it shall never be null.

Returns:

the current set of instance states.

with

Subscriber.DataState with(SampleState state)

Add the given SampleState to this DataState.

Parameters:

state - the state to add.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

with

Subscriber.DataState with(ViewState state)

Add the given ViewState to this DataState.

Parameters:

state - the state to add.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

with

Subscriber.DataState with(InstanceState state)

Add the given InstanceState to this DataState.

Parameters:

state - the state to add.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

withAnySampleState

Subscriber.DataState withAnySampleState()

Add all SampleState values to this DataState.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

withAnyViewState

Subscriber.DataState withAnyViewState()

Add all ViewState values to this DataState.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

withAnyInstanceState

Subscriber.DataState withAnyInstanceState()

Add all InstanceState values to this DataState.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

withNotAliveInstanceStates

Subscriber.DataState withNotAliveInstanceStates()

Add InstanceState.NOT_ALIVE_DISPOSED and InstanceState.NOT_ALIVE_NO_WRITERS to this DataState.

Returns:

this

Throws:

UnsupportedOperationException - if this DataState is unmodifiable.

clone

Subscriber.DataState clone()

equals

boolean equals(Object other)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object