org.omg.dds.topic
Class BuiltinTopicKey

java.lang.Object
  extended by org.omg.dds.topic.BuiltinTopicKey
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, DDSObject, ModifiableValue<BuiltinTopicKey,BuiltinTopicKey>, Value<BuiltinTopicKey,BuiltinTopicKey>

@Extensibility(value=EXTENSIBLE_EXTENSIBILITY)
@Nested
public abstract class BuiltinTopicKey
extends java.lang.Object
implements ModifiableValue<BuiltinTopicKey,BuiltinTopicKey>

See Also:
Serialized Form

Constructor Summary
BuiltinTopicKey()
           
 
Method Summary
abstract  BuiltinTopicKey clone()
          Extends the concept of "cloneable" defined in java.lang by providing an explicit public Value.clone() method.
abstract  int[] getValue(int[] dst)
          Copy the value of this key into the first four positions of the given array.
static BuiltinTopicKey newBuiltinTopicKey(Bootstrap bootstrap)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.omg.dds.core.modifiable.ModifiableValue
copyFrom, finishModification
 
Methods inherited from interface org.omg.dds.core.Value
equals, hashCode, modify
 
Methods inherited from interface org.omg.dds.core.DDSObject
getBootstrap
 

Constructor Detail

BuiltinTopicKey

public BuiltinTopicKey()
Method Detail

newBuiltinTopicKey

public static BuiltinTopicKey newBuiltinTopicKey(Bootstrap bootstrap)
Parameters:
bootstrap - Identifies the Service instance to which the new object will belong.

getValue

public abstract int[] getValue(int[] dst)
Copy the value of this key into the first four positions of the given array. Service implementations that do not support the DDS-RTPS interoperability protocol may use a key length of only three, not four. Such implementations shall set index 3 in the given array to 0.

Parameters:
dst - An array of length at least four integers. Any items at index 4 or higher will not be modified.
Returns:
The input array.

clone

public abstract BuiltinTopicKey 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 ModifiableValue<BuiltinTopicKey,BuiltinTopicKey>
Specified by:
clone in interface Value<BuiltinTopicKey,BuiltinTopicKey>
Overrides:
clone in class java.lang.Object
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.