Game.FcgoState (FreeCol Code Documentation)

java.lang.Object
- java.lang.Enum<Game.FcgoState>
- - net.sf.freecol.common.model.Game.FcgoState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Game.FcgoState>

Enclosing class:

Game
```
private static enum Game.FcgoState
extends java.lang.Enum<Game.FcgoState>
```
State for the FCGO iterator, out here because it has to be static.

Enum Constant Summary

Enum Constants
Enum Constant Description

CONSUMED

INVALID

VALID

Constructor Summary

Constructors
Modifier Constructor Description

private FcgoState()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Game.FcgoState`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Game.FcgoState[]`	`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, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - INVALID
```
public static final Game.FcgoState INVALID
```
  - VALID
```
public static final Game.FcgoState VALID
```
  - CONSUMED
```
public static final Game.FcgoState CONSUMED
```
- Constructor Detail
  - FcgoState
```
private FcgoState()
```
- Method Detail
  - values
```
public static Game.FcgoState[] 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 (Game.FcgoState c : Game.FcgoState.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Game.FcgoState 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