org.sape.carbon.services.console
Class OperationsImpactEnum

java.lang.Object
  |
  +--org.sape.carbon.core.util.enum.BaseEnum
        |
        +--org.sape.carbon.services.console.OperationsImpactEnum
All Implemented Interfaces:
Serializable

public class OperationsImpactEnum
extends BaseEnum
implements Serializable

This is the base template for a new enumeration.

Copyright 2002 Sapient

Since:
carbon 1.0
Version:
$Revision: 1.4 $($Author: ghinkl $ / $Date: 2003/04/04 01:11:49 $)
Author:
Greg Hinkle, January 2002
See Also:
Serialized Form

Nested Class Summary
static class OperationsImpactEnum.OperationsImpactEnumNotFoundException
          This class is a typesafe retriever excepection for an enumeration
 
Nested classes inherited from class org.sape.carbon.core.util.enum.BaseEnum
 
Field Summary
static OperationsImpactEnum ACTION
           
static OperationsImpactEnum ACTION_INFO
           
static OperationsImpactEnum INFO
           
static OperationsImpactEnum UNKNOWN
           
 
Fields inherited from class org.sape.carbon.core.util.enum.BaseEnum
name, ordinal
 
Constructor Summary
private OperationsImpactEnum(String name, int ordinal)
          Constructs a enumeration of type OperationsImpactEnum
 
Method Summary
static OperationsImpactEnum getByName(String name)
          Looks up a OperationsImpactEnum by its string representation
static OperationsImpactEnum getByOrdinal(int ordinal)
          Looks up a OperationsImpactEnum by its ordinal representation
static Iterator iterator()
          Retrieves and iterator by ascending ordinal order for all enumerations of this type.
(package private)  Object readResolve()
          Overrides part of serialization to return a reference to an enumeration instance that is managed by the Enumeration Subsystem.
 
Methods inherited from class org.sape.carbon.core.util.enum.BaseEnum
equals, getByName, getByOrdinal, getName, getOrdinal, hashCode, iterator, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ACTION

public static final OperationsImpactEnum ACTION

ACTION_INFO

public static final OperationsImpactEnum ACTION_INFO

INFO

public static final OperationsImpactEnum INFO

UNKNOWN

public static final OperationsImpactEnum UNKNOWN
Constructor Detail

OperationsImpactEnum

private OperationsImpactEnum(String name,
                             int ordinal)
Constructs a enumeration of type OperationsImpactEnum

Parameters:
name - the String representation of this enumeration
Method Detail

getByName

public static final OperationsImpactEnum getByName(String name)
                                            throws OperationsImpactEnum.OperationsImpactEnumNotFoundException
Looks up a OperationsImpactEnum by its string representation

Parameters:
name - the String name of a enumeration instance
Returns:
an specific OperationsImpactEnum
Throws:
OperationsImpactEnum.OperationsImpactEnumNotFoundException - when there is no enumeration instance for the given name

getByOrdinal

public static OperationsImpactEnum getByOrdinal(int ordinal)
                                         throws OperationsImpactEnum.OperationsImpactEnumNotFoundException
Looks up a OperationsImpactEnum by its ordinal representation

Parameters:
ordinal - the integer ordinal value of a specific enumeration instance
Returns:
an specific OperationsImpactEnum
Throws:
OperationsImpactEnum.OperationsImpactEnumNotFoundException - when there is no enumeration instance for the given ordinal

iterator

public static Iterator iterator()
Retrieves and iterator by ascending ordinal order for all enumerations of this type.

Returns:
an iterator over all OperationsImpactEnum

readResolve

final Object readResolve()
                  throws ObjectStreamException
Overrides part of serialization to return a reference to an enumeration instance that is managed by the Enumeration Subsystem. These

ObjectStreamException


Copyright 1999-2003 Sapient Corporation. All Rights Reserved.