org.omg.dds.core

Interface EntityQos<P extends QosPolicy>

All Superinterfaces:

DDSObject, Map<Class<? extends P>,P>, Serializable

All Known Subinterfaces:

DataReaderQos, DataWriterQos, DomainParticipantFactoryQos, DomainParticipantQos, PublisherQos, SubscriberQos, TopicQos

@Extensibility(value=MUTABLE_EXTENSIBILITY)
public interface EntityQos<P extends QosPolicy>
extends Map<Class<? extends P>,P>, Serializable, DDSObject

The Data-Distribution Service (DDS) relies on the use of QoS. A QoS (Quality of Service) is a set of characteristics that controls some aspect of the behavior of the DDS Service. QoS is comprised of individual QoS policies (objects of type deriving from QosPolicy). QoS (i.e., a collection of QosPolicy objects) may be associated with all Entity objects in the system such as Topic, DataWriter, DataReader, Publisher, Subscriber, and DomainParticipant. Some QosPolicy values may not be consistent with other ones. When a set of QosPolicy is passed (Entity.setQos(EntityQos) operations), the set resulting from adding the new policies on top of the previous is checked for consistency. If the resulting QoS is inconsistent, the change of QoS operation fails and the previous values are retained. Objects of this type are immutable.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
<POLICY extends P> POLICY	get(Class<POLICY> id)
PolicyFactory	getPolicyFactory() Provides an instance of PolicyFactory.
EntityQos<P>	withPolicies(P... policy) Copy this object and override the values of the given policies.
EntityQos<P>	withPolicy(P policy) Copy this object and override the value of the given policy.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

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

getEnvironment

Method Detail

get

<POLICY extends P> POLICY get(Class<POLICY> id)

Returns:

a reference to the corresponding policy in this EntityQos.

See Also:

Map.get(Object)

withPolicy

EntityQos<P> withPolicy(P policy)

Copy this object and override the value of the given policy.

Returns:

a new object

Throws:

IllegalArgumentException - if the given policy is not applicable to the concrete type of this EntityQos.

See Also:

withPolicies(QosPolicy...)

withPolicies

EntityQos<P> withPolicies(P... policy)

Copy this object and override the values of the given policies.

Returns:

a new object

Throws:

IllegalArgumentException - if any given policy is not applicable to the concrete type of this EntityQos.

See Also:

withPolicy(QosPolicy)

getPolicyFactory

PolicyFactory getPolicyFactory()

Provides an instance of PolicyFactory.

Returns:

An instance of PolicyFactory