org.dmd.dmt.shared.types

Class KeyedType

java.lang.Object

org.dmd.dmt.shared.types.KeyedType

All Implemented Interfaces:

Serializable, DmcMappedAttributeIF

public class KeyedType
extends Object
implements DmcMappedAttributeIF, Serializable

The KeyedType class is used to exercise functionality associated with types that support the DmcMappedAttributeIF. Mapped types can be used with attributes with valueType TREEMAPPED or HASHMAPPED.

The standard string format for a value of this type is "key value", where the key is the first space delimited string optionally followed by a value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyedType() Mandatory zero arg constructor.
KeyedType(KeyedType kt) Convenience copy constructor.
KeyedType(String s)

Method Summary

Modifier and Type	Method and Description
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.
String	getValue()
void	serializeIt(DmcOutputStreamIF dos)
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, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyedType

public KeyedType()

Mandatory zero arg constructor.

KeyedType

public KeyedType(KeyedType kt)

Convenience copy constructor.

Parameters:

kt - the original KeyedType.

KeyedType

public KeyedType(String s)

Method Detail

getValue

public String getValue()

serializeIt

public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception

Throws:

Exception

deserializeIt

public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception

Throws:

Exception

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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object