com.novell.nds.dirxml.engine.gcv

Class GCEnumValue.EnumChoice

java.lang.Object

com.novell.nds.dirxml.engine.gcv.GCEnumValue.EnumChoice

All Implemented Interfaces:

java.lang.Comparable

Enclosing class:

GCEnumValue

public static class GCEnumValue.EnumChoice
extends java.lang.Object
implements java.lang.Comparable

Class representing a single enum choice.

Constructor Summary

Constructors

Constructor and Description
EnumChoice(java.lang.String value, java.lang.String displayName) Construct an EnumChoice instance.
EnumChoice(java.lang.String value, java.lang.String displayName, java.lang.String displayNameRef) Construct an EnumChoice instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o) Implementation of Comparable interface.
boolean	equals(java.lang.Object o) Return true if the passed Object is an EnumChoice instance and this instance's value matches the passed instance's value.
java.lang.String	getDisplayName() Return the display name String for this instance.
java.lang.String	getDisplayNameRef() Return the display name localization reference for this instance.
java.lang.String	getValue() Return the value for this instance.
boolean	hasBeenModified() Return true if this instance has been modified.
int	hashCode() Return the hash code for this instance.
void	localize(LocalizedMessageSource messageSource) Localize the display name if there is a localization refs for it.
void	resetModified() Reset the modified flag for this instance such that hasBeenModified() will return false.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumChoice

public EnumChoice(java.lang.String value,
                  java.lang.String displayName)
           throws GCVException

Construct an EnumChoice instance.

Parameters:

value - String value for choice.

displayName - String for use in user interface naming the enum choice.

Throws:

GCVException - thrown if:

• value is null or empty
• displayName is null or empty

EnumChoice

public EnumChoice(java.lang.String value,
                  java.lang.String displayName,
                  java.lang.String displayNameRef)
           throws GCVException

Construct an EnumChoice instance.

Parameters:

value - String value for choice.

displayName - String for use in user interface naming the enum choice.

Throws:

GCVException - thrown if:

• value is null or empty
• displayName is null or empty

Method Detail

hasBeenModified

public boolean hasBeenModified()

Return true if this instance has been modified.

The instance is considered to have been modified if a change was made that affects the persistent representation since:

1. The instance was constructed from an XML representation.
2. resetModified() was last called

Returns:

true or false

See Also:

resetModified()

resetModified

public void resetModified()

Reset the modified flag for this instance such that hasBeenModified() will return false.

See Also:

hasBeenModified()

getValue

public java.lang.String getValue()

Return the value for this instance.

Returns:

non-null, non-empty value.

getDisplayName

public java.lang.String getDisplayName()

Return the display name String for this instance.

Returns:

non-null, non-empty String.

getDisplayNameRef

public java.lang.String getDisplayNameRef()

Return the display name localization reference for this instance.

Returns:

non-empty String, or null.

hashCode

public int hashCode()

Return the hash code for this instance. The hash code is the hash code of the value String.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code

equals

public boolean equals(java.lang.Object o)

Return true if the passed Object is an EnumChoice instance and this instance's value matches the passed instance's value.

Overrides:

equals in class java.lang.Object

Returns:

true or false

compareTo

public int compareTo(java.lang.Object o)

Implementation of Comparable interface. Returns -1 if passed Object is not an EnumChoice, otherwise, returns getValue().compareTo(((EnumChoice)o).getValue()).

Specified by:

compareTo in interface java.lang.Comparable

Returns:

comparison result.

localize

public void localize(LocalizedMessageSource messageSource)

Localize the display name if there is a localization refs for it.

If the display name localization refs, but the localized string cannot be located in the passed LocalizedMessageSource it is left unlocalized.

Parameters:

messageSource - Source for localized strings.