repicea.simulation.disturbances

Enum DisturbanceTypeProvider.DisturbanceType

java.lang.Object

java.lang.Enum<DisturbanceTypeProvider.DisturbanceType>

repicea.simulation.disturbances.DisturbanceTypeProvider.DisturbanceType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DisturbanceTypeProvider.DisturbanceType>, REpiceaTranslator.TextableEnum

Enclosing interface:

DisturbanceTypeProvider

public static enum DisturbanceTypeProvider.DisturbanceType
extends java.lang.Enum<DisturbanceTypeProvider.DisturbanceType>
implements REpiceaTranslator.TextableEnum

Enum Constant Summary

Enum Constants

Enum Constant and Description
Drought
Harvest
SpruceBudwormOutbreak
Windstorm

Method Summary

Modifier and Type	Method and Description
static java.util.List<DisturbanceTypeProvider.DisturbanceType>	getLargeScaleDisturbances() This method returns the list of large scale disturbances, mainly for a proper disturbance occurrence recording implementation.
void	setText(java.lang.String englishText, java.lang.String frenchText) This method sets the english and french text for the label, control or title.
java.lang.String	toString()
static DisturbanceTypeProvider.DisturbanceType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DisturbanceTypeProvider.DisturbanceType[]	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

Windstorm

public static final DisturbanceTypeProvider.DisturbanceType Windstorm

Drought

public static final DisturbanceTypeProvider.DisturbanceType Drought

Harvest

public static final DisturbanceTypeProvider.DisturbanceType Harvest

SpruceBudwormOutbreak

public static final DisturbanceTypeProvider.DisturbanceType SpruceBudwormOutbreak

Method Detail

values

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

Returns:

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

valueOf

public static DisturbanceTypeProvider.DisturbanceType 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

setText

public void setText(java.lang.String englishText,
                    java.lang.String frenchText)

Description copied from interface: REpiceaTranslator.TextableEnum

This method sets the english and french text for the label, control or title.

Specified by:

setText in interface REpiceaTranslator.TextableEnum

Parameters:

englishText - a String

frenchText - a String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DisturbanceTypeProvider.DisturbanceType>

getLargeScaleDisturbances

public static java.util.List<DisturbanceTypeProvider.DisturbanceType> getLargeScaleDisturbances()

This method returns the list of large scale disturbances, mainly for a proper disturbance occurrence recording implementation. The list is a copy of an internal list to ensure that the internal list cannot be modified.

Returns:

a List of DisturbanceType enum