org.dmd.dmc.types

Class ClassInfoRef

java.lang.Object

org.dmd.dmc.types.ClassInfoRef

All Implemented Interfaces:

Serializable, Comparable<ClassInfoRef>, DmcMappedAttributeIF

public class ClassInfoRef
extends Object
implements DmcMappedAttributeIF, Comparable<ClassInfoRef>, Serializable

The ClassInfoRef class is used to represent class information via the Dark Matter ID (dmdID) defined on ClassDefinitions and stored statically in the DMSAG compact schemas generated from the DMO Generator utility. When serialized, only the integer id is sent.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassInfoRef()
ClassInfoRef(ClassInfoRef original)
ClassInfoRef(DmcClassInfo dci)
ClassInfoRef(Integer i)
ClassInfoRef(String cn)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ClassInfoRef o)
void	deserializeIt(DmcInputStreamIF dis)
boolean	equals(Object obj)
DmcClassInfo	getInfo()
Object	getKey() Returns the key associated with this attribute value.
String	getKeyAsString() Returns the key value represented as a string.
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

ClassInfoRef

public ClassInfoRef()

ClassInfoRef

public ClassInfoRef(Integer i)

ClassInfoRef

public ClassInfoRef(ClassInfoRef original)

ClassInfoRef

public ClassInfoRef(DmcClassInfo dci)

ClassInfoRef

public ClassInfoRef(String cn)

Method Detail

getInfo

public DmcClassInfo getInfo()

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.

serializeIt

public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception

Throws:

Exception

deserializeIt

public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception

Throws:

Exception

compareTo

public int compareTo(ClassInfoRef o)

Specified by:

compareTo in interface Comparable<ClassInfoRef>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object