UUIDName (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.DmcObjectName
- - org.dmd.dmc.types.UUIDName

All Implemented Interfaces:

Serializable, Comparable<DmcObjectName>, DmcMappedAttributeIF, DmcObjectNameIF
```
public class UUIDName
extends DmcObjectName
implements DmcObjectNameIF, Serializable
```
The UUIDName provides naming based on UUIDLites.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String className

Fields
Modifier and Type	Field and Description
`static String`	`className`

Constructor Summary

Constructors
Constructor and Description

UUIDName()

UUIDName(long msb, long lsb)

UUIDName(String n)

UUIDName(UUIDLite l)

UUIDName(UUIDName n)

Constructors
Constructor and Description
`UUIDName()`
`UUIDName(long msb, long lsb)`
`UUIDName(String n)`
`UUIDName(UUIDLite l)`
`UUIDName(UUIDName n)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DmcObjectName`	`cloneIt()`
`int`	`compareTo(DmcObjectName o)` Compares the name to another name for order.
`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 is of the same type.
`Object`	`getKey()` Returns the portion of the name that provides a unique key for storage in maps and sets.
`String`	`getKeyAsString()` Returns the key value as a String.
`String`	`getNameClass()`
`String`	`getNameString()` Return the name of the object as a String.
`DmcObjectName`	`getNew()`
`String`	`getPresentationString()` Internally, names may not be particularly suited to display in user interfaces.
`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.
`String`	`toString()` Return the name as a string.
`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

- Field Detail
  - className
```
public static final String className
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UUIDName
```
public UUIDName()
```
  - UUIDName
```
public UUIDName(String n)
         throws DmcValueException
```
    Throws:
    
    DmcValueException
  - UUIDName
```
public UUIDName(UUIDLite l)
```
  - UUIDName
```
public UUIDName(UUIDName n)
```
  - UUIDName
```
public UUIDName(long msb,
                long lsb)
```
- Method Detail
  - getNameString
```
public String getNameString()
```
    Description copied from class: DmcObjectName
    
    Return the name of the object as a String. Regardless of how the name is internally represented, it must have a String representation.
    
    Specified by:
    
    getNameString in interface DmcObjectNameIF
    
    Specified by:
    
    getNameString in class DmcObjectName
    
    Returns:
    
    The name of the object.
  - toString
```
public String toString()
```
    Description copied from class: DmcObjectName
    
    Return the name as a string.
    
    Overrides:
    
    toString in class DmcObjectName
  - setNameString
```
public void setNameString(String n)
                   throws DmcValueException
```
    Description copied from class: DmcObjectName
    
    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. We need setNameString() so that we can create DmcTypeNamedObjectREF values based on a String.
    
    Specified by:
    
    setNameString in interface DmcObjectNameIF
    
    Specified by:
    
    setNameString in class DmcObjectName
    
    Parameters:
    
    n - The name value as a String.
    
    Throws:
    
    DmcValueException
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: DmcObjectName
    
    Implementors should check to see if the object is of the same type. If not, return false. If so, use whatever comparison strategy applies to your name.
    
    Specified by:
    
    equals in interface DmcObjectNameIF
    
    Specified by:
    
    equals in class DmcObjectName
    
    Parameters:
    
    obj - The comparison object.
    
    Returns:
    
    True if the names match.
  - hashCode
```
public int hashCode()
```
    Description copied from class: DmcObjectName
    
    Returns the hash code for this name.
    
    Specified by:
    
    hashCode in interface DmcObjectNameIF
    
    Specified by:
    
    hashCode in class DmcObjectName
    
    Returns:
    
    An int hash code.
  - deserializeIt
```
public void deserializeIt(DmcInputStreamIF dis)
                   throws Exception
```
    Description copied from class: DmcObjectName
    
    Likewise, they must also be individually deserializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.
    
    Specified by:
    
    deserializeIt in interface DmcObjectNameIF
    
    Specified by:
    
    deserializeIt in class DmcObjectName
    
    Parameters:
    
    dis - The input stream.
    
    Throws:
    
    Exception
  - serializeIt
```
public void serializeIt(DmcOutputStreamIF dos)
                 throws Exception
```
    Description copied from class: DmcObjectName
    
    The object name values must be individually serializable since they are part of a more complex type, namely the DmcTypeNamedObjectREF.
    
    Specified by:
    
    serializeIt in interface DmcObjectNameIF
    
    Specified by:
    
    serializeIt in class DmcObjectName
    
    Parameters:
    
    dos - The output stream.
    
    Throws:
    
    Exception
  - compareTo
```
public int compareTo(DmcObjectName o)
```
    Description copied from class: DmcObjectName
    
    Compares the name to another name for order.
    
    Specified by:
    
    compareTo in interface Comparable<DmcObjectName>
    
    Specified by:
    
    compareTo in class DmcObjectName
  - getKey
```
public Object getKey()
```
    Description copied from class: DmcObjectName
    
    Returns the portion of the name that provides a unique key for storage in maps and sets.
    
    Specified by:
    
    getKey in interface DmcMappedAttributeIF
    
    Specified by:
    
    getKey in class DmcObjectName
    
    Returns:
    
    The key value.
  - getKeyAsString
```
public String getKeyAsString()
```
    Description copied from class: DmcObjectName
    
    Returns the key value as a String.
    
    Specified by:
    
    getKeyAsString in interface DmcMappedAttributeIF
    
    Specified by:
    
    getKeyAsString in class DmcObjectName
    
    Returns:
    
    A String.
  - getNameClass
```
public String getNameClass()
```
    Specified by:
    
    getNameClass in interface DmcObjectNameIF
    
    Specified by:
    
    getNameClass in class DmcObjectName
    
    Returns:
    
    just the name of the name class e.g. StringName, IntegerName etc.
  - 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.
  - cloneIt
```
public DmcObjectName cloneIt()
```
    Specified by:
    
    cloneIt in class DmcObjectName
    
    Returns:
    
    A clone of the object name derivative.
  - getNew
```
public DmcObjectName getNew()
```
    Specified by:
    
    getNew in class DmcObjectName
    
    Returns:
    
    a new DmcObjectName derivative.
  - getPresentationString
```
public String getPresentationString()
```
    Description copied from class: DmcObjectName
    
    Internally, names may not be particularly suited to display in user interfaces. This method should be overloaded to provide an informative presentation name.
    
    Specified by:
    
    getPresentationString in class DmcObjectName
    
    Returns:
    
    A string.

Class UUIDName

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

className

Constructor Detail

UUIDName

UUIDName

UUIDName

UUIDName

UUIDName

Method Detail

getNameString

toString

setNameString

equals

hashCode

deserializeIt

serializeIt

compareTo

getKey

getKeyAsString

getNameClass

valuesAreEqual

cloneIt

getNew

getPresentationString