com.sap.netweaver.bc.rf.util.enum
Class EnumWithDescription

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.util_api.jar]

java.lang.Object
  |
  +--com.sap.netweaver.bc.rf.util.flyweight.FlyWeight
        |
        +--com.sap.netweaver.bc.rf.util.enum.Enum
              |
              +--com.sap.netweaver.bc.rf.util.enum.EnumWithDescription

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

Direct Known Subclasses:

ContentMetadataType, IsolationLevel, LinkType, LockDepthType, LockKindType, LockScopeType, OrderMechanismType, OrderPositionType, PropertyType, PropertyUpdateType, ReceiverMode, Status, SupportedOption

public abstract class EnumWithDescription

extends Enum

Abstract class extending a type-safe enumeration by a description. You have to extend this class, add your public final static enumeration members and implement an appropriate private constructor:

 public class Status extends EnumWithDescription
 {
     public final static Status SUCCESS = new Status( 1, "Success" );
     public final static Status FAILURE = new Status( 2, "Failure" );

     private A( final int id, final String description )
     {
         super( id, description );
     }
 }
 

See Also:

Serialized Form

Constructor Summary

protected

EnumWithDescription(int id, java.lang.String description, boolean ignoreDuplicateRegistration) Construct instance of an enumeration with description.

Method Summary

java.lang.String	getDescription() Get description of the enumeration instance.
java.lang.String	toString() Get descriptive text for this enumeration instance.

Methods inherited from class com.sap.netweaver.bc.rf.util.enum.Enum

clone, compareTo, equals, getAllEnums, getAllEnumsInherited, getEnum, getEnumId, getEnumInherited, hashCode

Methods inherited from class com.sap.netweaver.bc.rf.util.flyweight.FlyWeight

getAllFlyWeights, getAllFlyWeightsInherited, getFlyWeight, getFlyWeightId, getFlyWeightInherited, removeAllFlyWeights, removeAllFlyWeightsInherited, removeFlyWeight, removeFlyWeightInherited

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumWithDescription

protected EnumWithDescription(int id,
                              java.lang.String description,
                              boolean ignoreDuplicateRegistration)

Construct instance of an enumeration with description.

Parameters:

id - enumeration id

description - enumeration description

ignoreDuplicateRegistration - when true, don't throw IllegalArgumentException exception when the id is already in use

Method Detail

getDescription

public java.lang.String getDescription()

Get description of the enumeration instance.

Returns:

description of the enumeration instance

toString

public java.lang.String toString()

Get descriptive text for this enumeration instance.

Overrides:

toString in class Enum

Returns:

descriptive text for this enumeration instance