RTI Connext Java API  Version 6.1.1

Keyed string built-in type. More...

Inheritance diagram for KeyedString:
Copyable

Public Member Functions

 KeyedString ()
 Default Constructor. More...
 
 KeyedString (String key, String value)
 
 KeyedString (KeyedString src)
 Copy constructor. More...
 
Object copy_from (Object src)
 Copy value of a data type from source. More...
 

Public Attributes

String key
 Instance key associated with the specified value. More...
 
String value
 String value. More...
 

Detailed Description

Keyed string built-in type.

Constructor & Destructor Documentation

◆ KeyedString() [1/3]

Default Constructor.

The default constructor initializes the newly created object with empty key and value.

Referenced by KeyedString.copy_from(), and KeyedString.KeyedString().

◆ KeyedString() [2/3]

KeyedString ( String  key,
String  value 
)

Creates a KeyedString with a key and a value

References KeyedString.key, and KeyedString.value.

◆ KeyedString() [3/3]

Copy constructor.

Parameters
src<<in>> Object to copy from.
Exceptions
NullPointerExceptionif src is null.

References KeyedString.copy_from(), KeyedString.key, KeyedString.KeyedString(), and KeyedString.value.

Member Function Documentation

◆ copy_from()

Object copy_from ( Object  src)

Copy value of a data type from source.

Copy data into this object from another. This copy is intended to be a deep copy, so that all data members (recursively) are copied (not just resetting Object references).

This operation returns the object that is copied if copy is successful.

Parameters
src<<in>> The Object which contains the data to be copied.
Returns
Generally, return this but special cases (such as Enum) exist.
Exceptions
NullPointerExceptionIf src is null.
ClassCastExceptionIf src is not the same type as this.

Implements Copyable.

References KeyedString.key, KeyedString.KeyedString(), and KeyedString.value.

Referenced by KeyedStringTypeSupport.get_type_name(), and KeyedString.KeyedString().

Member Data Documentation

◆ key

◆ value