Log4j 1.1

pl.psnc.expres.remote.protocol.notification
Enum State

java.lang.Object
  extended by java.lang.Enum<State>
      extended by pl.psnc.expres.remote.protocol.notification.State
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<State>

public enum State
extends java.lang.Enum<State>

State enum - defines a set of possible operations/modules states. The enumeration name is internationalised.

Author:
Dominik Stoklosa (~osa~)
Email address
osa@man.poznan.pl

Enum Constant Summary
DONE
          The task is done
ERROR
          There was an error while processing request
EXPERIMENT_DONE
          The experiment done
OK
          OK - message received without error
TN_NOTIFICATION
          Notification from translation node - chunk is ready
 
Method Summary
static State getByName(java.lang.String name)
          Get instance of this enun value by the given name
static State getByNameKey(java.lang.String nameKey)
          Get instance of this enun value by the given name key
 java.lang.String getDescription()
          Get internationalised description of a correlation state
 java.lang.String getName()
          Get internationalised name of a correlation state
 java.lang.String getNameKey()
          Get value of field: nameKey
 java.lang.String toString()
           
static State valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static State[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

OK

public static final State OK
OK - message received without error


ERROR

public static final State ERROR
There was an error while processing request


DONE

public static final State DONE
The task is done


EXPERIMENT_DONE

public static final State EXPERIMENT_DONE
The experiment done


TN_NOTIFICATION

public static final State TN_NOTIFICATION
Notification from translation node - chunk is ready

Method Detail

values

public static State[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (State c : State.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static State valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<State>

getName

public java.lang.String getName()
Get internationalised name of a correlation state

Returns:
internationalised name of a correlation state

getDescription

public java.lang.String getDescription()
Get internationalised description of a correlation state

Returns:
internationalised description of a correlation state

getNameKey

public java.lang.String getNameKey()
Get value of field: nameKey

Returns:
the nameKey

getByName

public static State getByName(java.lang.String name)
Get instance of this enun value by the given name

Parameters:
name - enum name
Returns:
instance of this enun value by the given name or NULL if such enum was not found.

getByNameKey

public static State getByNameKey(java.lang.String nameKey)
Get instance of this enun value by the given name key

Parameters:
nameKey - enum name key
Returns:
instance of this enun value by the given name key or NULL if such enum was not found.

Log4j 1.1

Copyright 2007-2008 by VLAB