org.dmd.dmc.types

Class DmcTypeStringName

java.lang.Object

org.dmd.dmc.DmcAttribute<VALUE>

org.dmd.dmc.types.DmcTypeDmcObjectName<StringName>

org.dmd.dmc.types.DmcTypeStringName

All Implemented Interfaces:

Serializable, Cloneable, Comparable<String>

Direct Known Subclasses:

DmcTypeStringNameMV, DmcTypeStringNameSET, DmcTypeStringNameSV

public abstract class DmcTypeStringName
extends DmcTypeDmcObjectName<StringName>
implements Serializable

The DmcTypeStringName class provides support for simple, String based names for objects.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.dmd.dmc.DmcAttribute

attrInfo, ID

Constructor Summary

Constructors

Constructor and Description
DmcTypeStringName()
DmcTypeStringName(DmcAttributeInfo ai)

Method Summary

Modifier and Type	Method and Description
StringName	cloneValue(StringName original) This method must be overridden to clone whatever value is stored in this attribute.
StringName	deserializeValue(DmcInputStreamIF dis) Read a StringName.
void	serializeValue(DmcOutputStreamIF dos, StringName value) Write a StringName.
StringName	typeCheck(Object value) Derived classes must overload this method to determine if the value passed in conforms with their type criteria.

Methods inherited from class org.dmd.dmc.DmcAttribute

add, addModsMV, addModsSV, cloneIt, compareTo, contains, containsKey, del, deserializeIt, formatValue, formatValueAsCompactJSON, formatValueAsJSON, getAttributeInfo, getByKey, getID, getMV, getMVnth, getMVSize, getName, getNew, getSV, hasValue, modifierFormat, serializeIt, set, setAttributeInfo, setMVnth, toOIF, toOIF, valueChangedMV, valueChangedSV

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DmcTypeStringName

public DmcTypeStringName()

DmcTypeStringName

public DmcTypeStringName(DmcAttributeInfo ai)

Method Detail

typeCheck

public StringName typeCheck(Object value)
                     throws DmcValueException

Description copied from class: DmcAttribute

Derived classes must overload this method to determine if the value passed in conforms with their type criteria.

Overrides:

typeCheck in class DmcTypeDmcObjectName<StringName>

Parameters:

value - the value to be checked

Returns:

a value holder

Throws:

DmcValueException - if the value is incorrect

cloneValue

public StringName cloneValue(StringName original)

Description copied from class: DmcAttribute

This method must be overridden to clone whatever value is stored in this attribute. The concept of clone constructors was considered, but this doesn't work for enumerated values.

Overrides:

cloneValue in class DmcTypeDmcObjectName<StringName>

Parameters:

original - the original value

Returns:

A clone of the value.

serializeValue

public void serializeValue(DmcOutputStreamIF dos,
                           StringName value)
                    throws Exception

Write a StringName.

Overrides:

serializeValue in class DmcTypeDmcObjectName<StringName>

Parameters:

dos - The output stream.

value - The value to be serialized.

Throws:

Exception

deserializeValue

public StringName deserializeValue(DmcInputStreamIF dis)
                            throws Exception

Read a StringName.

Overrides:

deserializeValue in class DmcTypeDmcObjectName<StringName>

Parameters:

dis - the input stream.

Returns:

A value read from the input stream.

Throws:

Exception