LostCityRumour.RumourType (FreeCol Code Documentation)

java.lang.Object
- java.lang.Enum<LostCityRumour.RumourType>
- - net.sf.freecol.common.model.LostCityRumour.RumourType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LostCityRumour.RumourType>

Enclosing class:

LostCityRumour
```
public static enum LostCityRumour.RumourType
extends java.lang.Enum<LostCityRumour.RumourType>
```
Constants describing types of Lost City Rumours.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`BURIAL_GROUND`
`CIBOLA`
`COLONIST`
`EXPEDITION_VANISHES`
`FOUNTAIN_OF_YOUTH`
`LEARN`
`MOUNDS`
`NO_SUCH_RUMOUR`
`NOTHING`
`RUINS`
`TRIBAL_CHIEF`

Constructor Summary

Constructors
Modifier Constructor Description

private RumourType()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAlternateDescriptionKey(java.lang.String variant)`
`java.lang.String`	`getDescriptionKey()`
`private java.lang.String`	`getKey()`	Get the stem key for this LCR type.
`static LostCityRumour.RumourType`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static LostCityRumour.RumourType[]`	`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

NO_SUCH_RUMOUR

public static final LostCityRumour.RumourType NO_SUCH_RUMOUR

BURIAL_GROUND

public static final LostCityRumour.RumourType BURIAL_GROUND

EXPEDITION_VANISHES

public static final LostCityRumour.RumourType EXPEDITION_VANISHES

NOTHING

public static final LostCityRumour.RumourType NOTHING

LEARN

public static final LostCityRumour.RumourType LEARN

TRIBAL_CHIEF

public static final LostCityRumour.RumourType TRIBAL_CHIEF

COLONIST

public static final LostCityRumour.RumourType COLONIST

MOUNDS

public static final LostCityRumour.RumourType MOUNDS

RUINS

public static final LostCityRumour.RumourType RUINS

CIBOLA

public static final LostCityRumour.RumourType CIBOLA

FOUNTAIN_OF_YOUTH

public static final LostCityRumour.RumourType FOUNTAIN_OF_YOUTH

Constructor Detail
- RumourType
```
private RumourType()
```

Method Detail
- values
```
public static LostCityRumour.RumourType[] 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 (LostCityRumour.RumourType c : LostCityRumour.RumourType.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static LostCityRumour.RumourType 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
- getKey
```
private java.lang.String getKey()
```
  Get the stem key for this LCR type.
  
  Returns:
  
  The stem key.
- getDescriptionKey
```
public java.lang.String getDescriptionKey()
```
- getAlternateDescriptionKey
```
public java.lang.String getAlternateDescriptionKey(java.lang.String variant)
```