Package de.intarsys.tools.enumeration
Class EnumItem
- java.lang.Object
-
- de.intarsys.tools.enumeration.EnumItem
-
- All Implemented Interfaces:
java.lang.Comparable
public abstract class EnumItem extends java.lang.Object implements java.lang.Comparable
The abstract superclass for an enumeration implementation.To implement an enumeration class:
- create a subclass of EnumItem - create a final public static attribute named META to the EnumMeta of the class. final public static EnumMeta META = getMeta(XYZ.class); - create a final public static attribute for every member of the enumeration. public static final XYZ ABC = new XYZ("abxc","My ABC");
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
EnumItem(java.lang.String id)
protected
EnumItem(java.lang.String id, int weight)
protected
EnumItem(java.lang.String id, Message message)
protected
EnumItem(java.lang.String id, Message message, int weight)
protected
EnumItem(java.lang.String id, java.lang.String label)
protected
EnumItem(java.lang.String id, java.lang.String label, int weight)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(java.lang.Object o)
java.lang.String
getDescription()
java.lang.String
getIconName()
java.lang.String
getId()
java.lang.String
getLabel()
java.lang.String
getLocalizedLabel()
Message
getMessage()
protected EnumMeta
getMeta()
protected static EnumMeta
getMeta(java.lang.Class clazz)
java.lang.String
getTip()
protected int
getWeight()
protected void
setDefault()
protected void
setIconName(java.lang.String iconName)
java.lang.String
toString()
-
-
-
Constructor Detail
-
EnumItem
protected EnumItem(java.lang.String id)
-
EnumItem
protected EnumItem(java.lang.String id, int weight)
-
EnumItem
protected EnumItem(java.lang.String id, Message message)
-
EnumItem
protected EnumItem(java.lang.String id, Message message, int weight)
-
EnumItem
protected EnumItem(java.lang.String id, java.lang.String label)
-
EnumItem
protected EnumItem(java.lang.String id, java.lang.String label, int weight)
-
-
Method Detail
-
getMeta
protected static EnumMeta getMeta(java.lang.Class clazz)
-
compareTo
public int compareTo(java.lang.Object o)
- Specified by:
compareTo
in interfacejava.lang.Comparable
-
getDescription
public java.lang.String getDescription()
-
getIconName
public java.lang.String getIconName()
-
getId
public java.lang.String getId()
-
getLabel
public java.lang.String getLabel()
-
getLocalizedLabel
public java.lang.String getLocalizedLabel()
-
getMessage
public Message getMessage()
-
getMeta
protected EnumMeta getMeta()
-
getTip
public java.lang.String getTip()
-
getWeight
protected int getWeight()
-
setDefault
protected void setDefault()
-
setIconName
protected void setIconName(java.lang.String iconName)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-