org.springframework.core.enums
Class StringCodedLabeledEnum

java.lang.Object
  org.springframework.core.enums.AbstractLabeledEnum
      org.springframework.core.enums.AbstractGenericLabeledEnum
          org.springframework.core.enums.StringCodedLabeledEnum

All Implemented Interfaces:

Serializable, Comparable, LabeledEnum

public class StringCodedLabeledEnum
extends AbstractGenericLabeledEnum

Implementation of LabeledEnum which uses a String as the code type.

Should almost always be subclassed, but for some simple situations it may be used directly. Note that you will not be able to use unique type-based functionality like LabeledEnumResolver.getLabeledEnumSet(type) in this case.

Since:

1.2.2

Author:

Keith Donald, Juergen Hoeller

See Also:

LabeledEnumResolver.getLabeledEnumSet(Class), Serialized Form

Field Summary

Fields inherited from interface org.springframework.core.enums.LabeledEnum

CODE_ORDER, DEFAULT_ORDER, LABEL_ORDER

Constructor Summary

StringCodedLabeledEnum(String code, String label)
Create a new StringCodedLabeledEnum instance.

Method Summary

Comparable	getCode() Return this enumeration's code.
String	getStringCode() Return the String code of this LabeledEnum instance.

Methods inherited from class org.springframework.core.enums.AbstractGenericLabeledEnum

getLabel

Methods inherited from class org.springframework.core.enums.AbstractLabeledEnum

compareTo, equals, getType, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringCodedLabeledEnum

public StringCodedLabeledEnum(String code,
                              String label)

Create a new StringCodedLabeledEnum instance.

Parameters:

code - the String code

label - the label (can be null)

Method Detail

getCode

public Comparable getCode()

Description copied from interface: LabeledEnum

Return this enumeration's code.

Each code should be unique within enumerations of the same type.

getStringCode

public String getStringCode()

Return the String code of this LabeledEnum instance.