Enum FinchActionType

java.lang.Object
  extended by java.lang.Enum<FinchActionType>
      extended by FinchActionType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FinchActionType>

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

Enumerated data type that represents the different concrete FinchAction classes. Provides facilities for each of the enumerated types to describe themselves

Author:
Andrew H. Fagg

Enum Constant Summary
FINCH_BUZZ
           
FINCH_MOVE
           
FINCH_MOVE_GUARDED
           
FINCH_NOSE
           
FINCH_OBSTACLE_GUARDED
           
FINCH_ORIENTATION_GUARDED
           
 
Field Summary
private  java.lang.String description
          String description of the enumerated value.
 
Method Summary
static FinchActionType[] getActionList()
          Return the set of FinchAction types
 java.lang.String toString()
          Return a string that describes the enumerated value.
static FinchActionType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FinchActionType[] 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

FINCH_MOVE

public static final FinchActionType FINCH_MOVE

FINCH_MOVE_GUARDED

public static final FinchActionType FINCH_MOVE_GUARDED

FINCH_BUZZ

public static final FinchActionType FINCH_BUZZ

FINCH_NOSE

public static final FinchActionType FINCH_NOSE

FINCH_ORIENTATION_GUARDED

public static final FinchActionType FINCH_ORIENTATION_GUARDED

FINCH_OBSTACLE_GUARDED

public static final FinchActionType FINCH_OBSTACLE_GUARDED
Field Detail

description

private java.lang.String description
String description of the enumerated value. This string will be used in the GUI

Method Detail

values

public static FinchActionType[] 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 (FinchActionType c : FinchActionType.values())
    System.out.println(c);

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

valueOf

public static FinchActionType 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

getActionList

public static FinchActionType[] getActionList()
Return the set of FinchAction types

Returns:
An array containing all of the FinchAction types

toString

public java.lang.String toString()
Return a string that describes the enumerated value.

Overrides:
toString in class java.lang.Enum<FinchActionType>
Returns:
A string describing the FinchAction enumerated value