KeyedString Class Reference

Keyed string built-in type. More...

Inheritance diagram for KeyedString:

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...
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]

KeyedString

(

)

Default Constructor.

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

Referenced by KeyedString.copy_from().

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]

KeyedString

(

KeyedString

src

)

Copy constructor.

Parameters

src	<<in>> Object to copy from.

Exceptions

NullPointerException

if src is null.

References KeyedString.copy_from().

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

NullPointerException	If src is null.
ClassCastException	If src is not the same type as this.

Implements Copyable.

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

Referenced by KeyedString.KeyedString().

Member Data Documentation

key

String key

Instance key associated with the specified value.

Referenced by KeyedString.copy_from(), KeyedStringDataWriter.dispose(), KeyedStringDataWriter.dispose_w_timestamp(), KeyedStringDataReader.get_key_value(), KeyedStringDataWriter.get_key_value(), KeyedString.KeyedString(), KeyedStringDataReader.lookup_instance(), KeyedStringDataWriter.lookup_instance(), KeyedStringDataWriter.register_instance(), KeyedStringDataWriter.register_instance_w_timestamp(), KeyedStringDataWriter.unregister_instance(), KeyedStringDataWriter.unregister_instance_w_timestamp(), KeyedStringDataWriter.write(), and KeyedStringDataWriter.write_w_timestamp().

value

String value

String value.

Referenced by KeyedString.copy_from(), KeyedString.KeyedString(), KeyedStringDataWriter.write(), and KeyedStringDataWriter.write_w_timestamp().