agi.foundation.stk

(agi.foundation.models-2024r3.jar)

Enum CityType

java.lang.Object

java.lang.Enum<CityType>

agi.foundation.stk.CityType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CityType>

public enum CityType
extends Enum<CityType>
implements Enumeration

Indicates the type of a city in a StkCityDatabase.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMINISTRATION_CENTER A city that serves as an administration center.
NATIONAL_CAPITAL A city that serves as the national capital.
POPULATED_PLACE A city that has been categorized as a populated place.
TERRITORIAL_CAPITAL A city that serves as the territorial capital.
UNSPECIFIED A city for which a type has not been specified.

Method Summary

Modifier and Type	Method and Description
static CityType	getDefault() Get the enum constant that is considered to be the default.
static CityType	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CityType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CityType[]	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

UNSPECIFIED

public static final CityType UNSPECIFIED

A city for which a type has not been specified.

POPULATED_PLACE

public static final CityType POPULATED_PLACE

A city that has been categorized as a populated place.

ADMINISTRATION_CENTER

public static final CityType ADMINISTRATION_CENTER

A city that serves as an administration center.

NATIONAL_CAPITAL

public static final CityType NATIONAL_CAPITAL

A city that serves as the national capital.

TERRITORIAL_CAPITAL

public static final CityType TERRITORIAL_CAPITAL

A city that serves as the territorial capital.

Method Detail

values

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

Returns:

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

valueOf

public static CityType valueOf(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:

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

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CityType getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CityType getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.