org.omg.dds.sub.Subscriber.DataState Interface Reference

A DataState encapsulates sets of sample states, view states, and instance states as a convenience. More...

Inheritance diagram for org.omg.dds.sub.Subscriber.DataState:

Collaboration diagram for org.omg.dds.sub.Subscriber.DataState:

Public Member Functions
DataState	clone ()
boolean	equals (Object other)
ServiceEnvironment	getEnvironment ()
Set< InstanceState >	getInstanceStates ()
	Get the current set of instance states. More...
Set< SampleState >	getSampleStates ()
	Get the current set of sample states. More...
Set< ViewState >	getViewStates ()
	Get the current set of view states. More...
int	hashCode ()
DataState	with (SampleState state)
	Add the given org.omg.dds.sub.SampleState to this DataState. More...
DataState	with (ViewState state)
	Add the given org.omg.dds.sub.ViewState to this DataState. More...
DataState	with (InstanceState state)
	Add the given org.omg.dds.sub.InstanceState to this DataState. More...
DataState	withAnyInstanceState ()
	Add all org.omg.dds.sub.InstanceState values to this DataState. More...
DataState	withAnySampleState ()
	Add all org.omg.dds.sub.SampleState values to this DataState. More...
DataState	withAnyViewState ()
	Add all org.omg.dds.sub.ViewState values to this DataState. More...
DataState	withNotAliveInstanceStates ()
	Add org.omg.dds.sub.InstanceState#NOT_ALIVE_DISPOSED and org.omg.dds.sub.InstanceState#NOT_ALIVE_NO_WRITERS to this DataState. More...

Detailed Description

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.

Definition at line 645 of file Subscriber.java.

Member Function Documentation

clone()

DataState org.omg.dds.sub.Subscriber.DataState.clone

(

)

equals()

boolean org.omg.dds.sub.Subscriber.DataState.equals

(

Object

other

)

getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns

the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

getInstanceStates()

Set<InstanceState> org.omg.dds.sub.Subscriber.DataState.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.

getSampleStates()

Set<SampleState> org.omg.dds.sub.Subscriber.DataState.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> org.omg.dds.sub.Subscriber.DataState.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.

hashCode()

int org.omg.dds.sub.Subscriber.DataState.hashCode

(

)

with() [1/3]

DataState org.omg.dds.sub.Subscriber.DataState.with

(

SampleState

state

)

Add the given org.omg.dds.sub.SampleState to this DataState.

Parameters

state

the state to add.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

with() [2/3]

DataState org.omg.dds.sub.Subscriber.DataState.with

(

ViewState

state

)

Add the given org.omg.dds.sub.ViewState to this DataState.

Parameters

state

the state to add.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

with() [3/3]

DataState org.omg.dds.sub.Subscriber.DataState.with

(

InstanceState

state

)

Add the given org.omg.dds.sub.InstanceState to this DataState.

Parameters

state

the state to add.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

withAnyInstanceState()

DataState org.omg.dds.sub.Subscriber.DataState.withAnyInstanceState

(

)

Add all org.omg.dds.sub.InstanceState values to this DataState.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

withAnySampleState()

DataState org.omg.dds.sub.Subscriber.DataState.withAnySampleState

(

)

Add all org.omg.dds.sub.SampleState values to this DataState.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

withAnyViewState()

DataState org.omg.dds.sub.Subscriber.DataState.withAnyViewState

(

)

Add all org.omg.dds.sub.ViewState values to this DataState.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

withNotAliveInstanceStates()

DataState org.omg.dds.sub.Subscriber.DataState.withNotAliveInstanceStates

(

)

Add org.omg.dds.sub.InstanceState#NOT_ALIVE_DISPOSED and org.omg.dds.sub.InstanceState#NOT_ALIVE_NO_WRITERS to this DataState.

Returns

this

Exceptions

UnsupportedOperationException

if this DataState is unmodifiable.

---

The documentation for this interface was generated from the following file:

• java5/common/java/code/org/omg/dds/sub/Subscriber.java