org.omg.dds.core.modifiable
Interface ModifiableValue<UNMOD_SELF extends Value<UNMOD_SELF,MOD_SELF>,MOD_SELF extends UNMOD_SELF>

Type Parameters:
UNMOD_SELF - The unmodifiable supertype of this interface.
MOD_SELF - This interface.
All Superinterfaces:
java.lang.Cloneable, DDSObject, java.io.Serializable, Value<UNMOD_SELF,MOD_SELF>
All Known Subinterfaces:
AliasType, AnnotationMember, AnnotationMemberValue, AnnotationType, AnnotationUsage, AnnotationUsageMember, ArrayType, Bit, BitSetType, CollectionType, EnumeratedConstant, EnumerationType, KeyedBytes, KeyedString, MapType, Member, MemberProperty, ModifiableAnnotationDescriptor, ModifiableDataReaderQos, ModifiableDataRepresentationQosPolicy, ModifiableDataWriterQos, ModifiableDeadlineQosPolicy, ModifiableDestinationOrderQosPolicy, ModifiableDomainParticipantFactoryQos, ModifiableDomainParticipantQos, ModifiableDurabilityQosPolicy, ModifiableDurabilityServiceQosPolicy, ModifiableEntityFactoryQosPolicy, ModifiableEntityQos<UNMOD_SELF,MOD_SELF>, ModifiableGroupDataQosPolicy, ModifiableHistoryQosPolicy, ModifiableLatencyBudgetQosPolicy, ModifiableLifespanQosPolicy, ModifiableLivelinessQosPolicy, ModifiableMemberDescriptor, ModifiableOwnershipQosPolicy, ModifiableOwnershipStrengthQosPolicy, ModifiablePartitionQosPolicy, ModifiablePresentationQosPolicy, ModifiablePublisherQos, ModifiableQosPolicy<UNMOD_SELF,MOD_SELF>, ModifiableReaderDataLifecycleQosPolicy, ModifiableReliabilityQosPolicy, ModifiableResourceLimitsQosPolicy, ModifiableSubscriberQos, ModifiableTimeBasedFilterQosPolicy, ModifiableTopicDataQosPolicy, ModifiableTopicQos, ModifiableTransportPriorityQosPolicy, ModifiableTypeConsistencyEnforcementQosPolicy, ModifiableTypeDescriptor, ModifiableUserDataQosPolicy, ModifiableWriterDataLifecycleQosPolicy, Module, QosPolicyCount, Sample<TYPE>, SequenceType, StringType, StructureType, Type, TypeLibrary, TypeLibraryElement, TypeObject, TypeProperty, UnionMember, UnionType
All Known Implementing Classes:
BuiltinTopicKey, DataAvailableStatus, DataOnReadersStatus, InconsistentTopicStatus, LivelinessChangedStatus, LivelinessLostStatus, ModifiableDuration, ModifiableInstanceHandle, ModifiableTime, OfferedDeadlineMissedStatus, OfferedIncompatibleQosStatus, ParticipantBuiltinTopicData, PublicationBuiltinTopicData, PublicationMatchedStatus, RequestedDeadlineMissedStatus, RequestedIncompatibleQosStatus, SampleLostStatus, SampleRejectedStatus, Status, SubscriptionBuiltinTopicData, SubscriptionMatchedStatus, TopicBuiltinTopicData

public interface ModifiableValue<UNMOD_SELF extends Value<UNMOD_SELF,MOD_SELF>,MOD_SELF extends UNMOD_SELF>
extends Value<UNMOD_SELF,MOD_SELF>

A value type that supports modification.


Method Summary
 MOD_SELF clone()
          Extends the concept of "cloneable" defined in java.lang by providing an explicit public Value.clone() method.
 MOD_SELF copyFrom(UNMOD_SELF other)
          Overwrite this object's state with the contents of the given object.
 UNMOD_SELF finishModification()
          If this value type has an unmodifiable counterpart class, return a new object of that class containing a copy of the state of this object.
 
Methods inherited from interface org.omg.dds.core.Value
equals, hashCode, modify
 
Methods inherited from interface org.omg.dds.core.DDSObject
getBootstrap
 

Method Detail

copyFrom

MOD_SELF copyFrom(UNMOD_SELF other)
Overwrite this object's state with the contents of the given object.

Returns:
this

finishModification

UNMOD_SELF finishModification()
If this value type has an unmodifiable counterpart class, return a new object of that class containing a copy of the state of this object. If not return null. Calling this method is optional in general; because modifiable interfaces extend "unmodifiable" ones, the former can typically be used wherever the latter is required.

Returns:
a new unmodifiable copy of this object or null.

clone

MOD_SELF clone()
Description copied from interface: Value
Extends the concept of "cloneable" defined in java.lang by providing an explicit public Value.clone() method.

Specified by:
clone in interface Value<UNMOD_SELF extends Value<UNMOD_SELF,MOD_SELF>,MOD_SELF extends UNMOD_SELF>
Returns:
a new object that with state identical to that of this object.


Copyright © 2010 Real-Time Innovations, Inc. (RTI)
Copyright © 2010 PrismTech, Ltd.
Copyright © 2010 Object Management Group, Inc. (OMG)
All Rights Reserved.