org.dmd.dmc.types

Class NameContainer

java.lang.Object

org.dmd.dmc.types.NameContainer

All Implemented Interfaces:

Serializable, DmcMappedAttributeIF

public class NameContainer
extends Object
implements DmcMappedAttributeIF, Serializable

The NameContainer is designed to hold a typed DmcObjectName value. This allows for the transport of individually identified name values in things like the the Dark Matter Protocol GetRequest.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NameContainer()
NameContainer(DmcTypeDmcObjectName<?> n)

Method Summary

Modifier and Type	Method and Description
NameContainer	cloneIt()
void	deserializeIt(DmcInputStreamIF dis)
boolean	equals(Object obj)
Object	getKey() Returns the key associated with this attribute value.
String	getKeyAsString() Returns the key value represented as a string.
DmcObjectName	getName()
int	hashCode()
void	serializeIt(DmcOutputStreamIF dos)
String	toString()
boolean	valuesAreEqual(DmcMappedAttributeIF obj) This method is used by the Modifier mechanism to determine whether or not a change has occurred as a result of applying the modifier.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NameContainer

public NameContainer()

NameContainer

public NameContainer(DmcTypeDmcObjectName<?> n)

Method Detail

getName

public DmcObjectName getName()

serializeIt

public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception

Throws:

Exception

deserializeIt

public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception

Throws:

Exception

cloneIt

public NameContainer cloneIt()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getKey

public Object getKey()

Description copied from interface: DmcMappedAttributeIF

Returns the key associated with this attribute value.

Specified by:

getKey in interface DmcMappedAttributeIF

Returns:

The key value.

getKeyAsString

public String getKeyAsString()

Description copied from interface: DmcMappedAttributeIF

Returns the key value represented as a string. we could just call the toString() method on the Object, but having this forces you implement an appropriate String conversion method for the key.

Specified by:

getKeyAsString in interface DmcMappedAttributeIF

Returns:

A String.

valuesAreEqual

public boolean valuesAreEqual(DmcMappedAttributeIF obj)

Description copied from interface: DmcMappedAttributeIF

This method is used by the Modifier mechanism to determine whether or not a change has occurred as a result of applying the modifier. Having this method forces you to implement a value comparison function, as opposed to relying on you to remember to overload the equals method on your values. When the value is put in the map, we get back the existing value if the key already existed. The add() method will then call this function to determine if a change really took place; if this method returns false, we report the change (by passing back the new value), otherwise we return null from the add().

You should ensure that you compare both the key and the value in your comparison.

Specified by:

valuesAreEqual in interface DmcMappedAttributeIF

Parameters:

obj - Another mapped attribute.

Returns:

true if the value of this attribute matches the value of the object passed in and false otherwise.