Package de.chojo.universalis.entities

Enum Class City

java.lang.Object

java.lang.Enum<City>

de.chojo.universalis.entities.City

All Implemented Interfaces:

Serializable, Comparable<City>, Constable

public enum City
extends Enum<City>

An enum representing cities which can have retainers.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CRYSTARIUM	Crystarium
GRIDANIA	Gridania
ISHGARD	Ishgard
KUGANE	Kugane
LIMSA_LOMINSA	Limsa Lominsa
OLD_SHARLAYAN	Old Sharlayan
TULIYOLLAL	Tuliyollal
UL_DAH	Ul'dah
UNKNOWN	Unknown city

Method Summary

Modifier and Type	Method	Description
@NotNull String	cityName()	Name of the city
static City	fromId(int id)	Get a city by its id
static City	fromName(String name)	Get a city by its name
int	id()	The city id.
static City	valueOf(String name)	Returns the enum constant of this class with the specified name.
static City[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final City UNKNOWN

Unknown city

LIMSA_LOMINSA

public static final City LIMSA_LOMINSA

Limsa Lominsa

GRIDANIA

public static final City GRIDANIA

Gridania

UL_DAH

public static final City UL_DAH

Ul'dah

ISHGARD

public static final City ISHGARD

Ishgard

KUGANE

public static final City KUGANE

Kugane

CRYSTARIUM

public static final City CRYSTARIUM

Crystarium

OLD_SHARLAYAN

public static final City OLD_SHARLAYAN

Old Sharlayan

TULIYOLLAL

public static final City TULIYOLLAL

Tuliyollal

Method Details

values

public static City[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static City valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromId

public static City fromId(int id)

Get a city by its id

Parameters:

id - id

Returns:

city

Throws:

IllegalArgumentException - when id is invalid

fromName

public static City fromName(String name)

Get a city by its name

Parameters:

name - name

Returns:

city

Throws:

IllegalArgumentException - when name is invalid

cityName

@NotNull
public @NotNull String cityName()

Name of the city

Returns:

name

id

public int id()

The city id.

Returns:

id