org.dmd.dmc

Interface DmcObjectNameIF

All Superinterfaces:

DmcMappedAttributeIF

All Known Subinterfaces:

DmcHierarchicObjectNameIF

All Known Implementing Classes:

CamelCaseName, DefinitionName, IntegerName, LongName, RuleName, StringName, UUIDName

public interface DmcObjectNameIF
extends DmcMappedAttributeIF

Method Summary

Modifier and Type	Method and Description
void	deserializeIt(DmcInputStreamIF dis) Likewise, they must also be individually deserializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.
boolean	equals(Object obj) Implementors should check to see if the object if of the same type.
String	getNameClass()
String	getNameString() Return the name of the object as a String.
int	hashCode() Returns the hash code for this name.
void	serializeIt(DmcOutputStreamIF dos) The object name values must be individually serializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.
void	setNameString(String n) Implementing classes must overload this method to initialize their name properly with the String form of their name.

Methods inherited from interface org.dmd.dmc.DmcMappedAttributeIF

getKey, getKeyAsString, valuesAreEqual

Method Detail

getNameString

String getNameString()

Return the name of the object as a String. Regardless of how the name is internally represented, it must have a String representation.

Returns:

The name of the object.

setNameString

void setNameString(String n)
            throws DmcValueException

Implementing classes must overload this method to initialize their name properly with the String form of their name. This can basically be seen as implying that you must have a constructor for your name implementation that takes a String as argument; however, because this is just an interface, we have no way of enforcing that concept. We need setNameString() so that we can create DmcTypeNamedObjectREF values based on a String.

Parameters:

n - The name value as a String.

Throws:

DmcValueException

equals

boolean equals(Object obj)

Implementors should check to see if the object if of the same type. If so, use whatever comparison strategy applies to your name. If not, fall back to a String comparison.

Overrides:

equals in class Object

Parameters:

obj - The comparison object.

Returns:

True if the names match.

hashCode

int hashCode()

Returns the hash code for this name.

Overrides:

hashCode in class Object

Returns:

An int hash code.

serializeIt

void serializeIt(DmcOutputStreamIF dos)
          throws Exception

The object name values must be individually serializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.

Parameters:

dos - The output stream.

Throws:

Exception

deserializeIt

void deserializeIt(DmcInputStreamIF dis)
            throws Exception

Likewise, they must also be individually deserializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.

Parameters:

dis - The input stream.

Throws:

Exception

getNameClass

String getNameClass()

Returns:

just the name of the name class e.g. StringName, IntegerName etc.