Disaster.Effects (FreeCol Code Documentation)

java.lang.Object
- java.lang.Enum<Disaster.Effects>
- - net.sf.freecol.common.model.Disaster.Effects

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Disaster.Effects>

Enclosing class:

Disaster
```
public static enum Disaster.Effects
extends java.lang.Enum<Disaster.Effects>
```
Whether to apply one, many or all applicable disasters.

Enum Constant Summary

Enum Constants
Enum Constant Description

ALL

ONE

SEVERAL

Constructor Summary

Constructors
Modifier Constructor Description

private Effects()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Disaster.Effects`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Disaster.Effects[]`	`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
  - ONE
```
public static final Disaster.Effects ONE
```
  - SEVERAL
```
public static final Disaster.Effects SEVERAL
```
  - ALL
```
public static final Disaster.Effects ALL
```
- Constructor Detail
  - Effects
```
private Effects()
```
- Method Detail
  - values
```
public static Disaster.Effects[] 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 (Disaster.Effects c : Disaster.Effects.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Disaster.Effects 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