The Spring Framework

org.springframework.core.enums
Class StaticLabeledEnum

java.lang.Object
  extended by org.springframework.core.enums.AbstractLabeledEnum
      extended by org.springframework.core.enums.StaticLabeledEnum
All Implemented Interfaces:
Serializable, Comparable, LabeledEnum

public abstract class StaticLabeledEnum
extends AbstractLabeledEnum

Base class for static type-safe labeled enum instances. Usage example:

 public class FlowSessionStatus extends StaticLabeledEnum {

     // public static final instances!
     public static FlowSessionStatus CREATED = new FlowSessionStatus(0, "Created");
     public static FlowSessionStatus ACTIVE = new FlowSessionStatus(1, "Active");
     public static FlowSessionStatus PAUSED = new FlowSessionStatus(2, "Paused");
     public static FlowSessionStatus SUSPENDED = new FlowSessionStatus(3, "Suspended");
     public static FlowSessionStatus ENDED = new FlowSessionStatus(4, "Ended");
     
     // private constructor!
     private FlowSessionStatus(int code, String label) {
         super(code, label);
     }
     
     // custom behavior
 }

Since:
1.2.6
Author:
Keith Donald
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.springframework.core.enums.LabeledEnum
CODE_ORDER, DEFAULT_ORDER, LABEL_ORDER
 
Constructor Summary
protected StaticLabeledEnum(int code, String label)
          Create a new StaticLabeledEnum instance.
 
Method Summary
 Comparable getCode()
          Return this enumeration's code.
 String getLabel()
          Return a descriptive, optional label.
protected  Object readResolve()
          Return the resolved type safe static enum instance.
 short shortValue()
          Return the code of this LabeledEnum instance as a short.
 
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

StaticLabeledEnum

protected StaticLabeledEnum(int code,
                            String label)
Create a new StaticLabeledEnum instance.

Parameters:
code - the short 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.


getLabel

public String getLabel()
Description copied from interface: LabeledEnum
Return a descriptive, optional label.


shortValue

public short shortValue()
Return the code of this LabeledEnum instance as a short.


readResolve

protected Object readResolve()
Return the resolved type safe static enum instance.


The Spring Framework

Copyright © 2002-2007 The Spring Framework.