Package com.luciad.symbology.milstd2525b.model

Class TLcdEditableMS2525bObject.TextModifier

java.lang.Object

com.luciad.symbology.milstd2525b.model.TLcdEditableMS2525bObject.TextModifier

Enclosing class:

TLcdEditableMS2525bObject

public static class TLcdEditableMS2525bObject.TextModifier
extends Object

Encapsulates the type and constraints of a modifier, regardless of its origin (i.e. encoded in the symbol code (SIDC) or as a separate value).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDisplayName()	Returns the display name of this modifier.
String	getDisplayName(String aValue)	Returns a friendly name for the given enumeration value.
int	getLength()	Returns the maximum amount of characters in the modifier value.
String	getName()	Returns the name of the modifier.
Collection<String>	getPossibleValues()	If the modifier type is enumerated (boolean or enum), this returns the possible values.
TLcdEditableMS2525bObject.TextModifierType	getType()	Returns the type of the modifier value.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getName

public String getName()

Returns the name of the modifier. This is the key used in ILcdMS2525bCoded.

Returns:

the name of the modifier

getDisplayName

public String getDisplayName()

Returns the display name of this modifier.

Returns:

the display name of this modifier.

getType

public TLcdEditableMS2525bObject.TextModifierType getType()

Returns the type of the modifier value.

Returns:

the type of the modifier value

getPossibleValues

public Collection<String> getPossibleValues()

If the modifier type is enumerated (boolean or enum), this returns the possible values.

Returns:

the possible values for an enumerated modifier

getDisplayName

public String getDisplayName(String aValue)

Returns a friendly name for the given enumeration value.

Parameters:

aValue - one of the getPossibleValues()

Returns:

a friendly display name

getLength

public int getLength()

Returns the maximum amount of characters in the modifier value. For SIDC modifiers, this method returns the amount of characters that this modifier occupies in the SIDC String.

Returns:

the maximum amount of characters used for a text modifier or the amount of character in the SIDC modifier.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object