com.github.agadar.nationstates.enumerator

Enum EmbassyStatus

java.lang.Object

java.lang.Enum<EmbassyStatus>

com.github.agadar.nationstates.enumerator.EmbassyStatus

All Implemented Interfaces:

Serializable, Comparable<EmbassyStatus>

public enum EmbassyStatus
extends Enum<EmbassyStatus>

Represents the different statusses an embassy can be in.

Author:

Agadar (https://github.com/Agadar/)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbassyStatus.Adapter Converts a String to an EmbassyStatus, and vice versa.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSING
DENIED
ESTABLISHED
INVITED
PENDING
REJECTED
REQUESTED

Method Summary

Modifier and Type	Method and Description
static EmbassyStatus	fromString(String underlying) Returns the EmbassyStatus with the supplied underlying string.
String	toString() Return the underlying string.
static EmbassyStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static EmbassyStatus[]	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

INVITED

public static final EmbassyStatus INVITED

REQUESTED

public static final EmbassyStatus REQUESTED

PENDING

public static final EmbassyStatus PENDING

REJECTED

public static final EmbassyStatus REJECTED

DENIED

public static final EmbassyStatus DENIED

CLOSING

public static final EmbassyStatus CLOSING

ESTABLISHED

public static final EmbassyStatus ESTABLISHED

Method Detail

values

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

Returns:

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

valueOf

public static EmbassyStatus 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

fromString

public static EmbassyStatus fromString(String underlying)

Returns the EmbassyStatus with the supplied underlying string.

Parameters:

underlying - string to find the EmbassyStatus of

Returns:

the corresponding EmbassyStatus

toString

public String toString()

Return the underlying string.

Overrides:

toString in class Enum<EmbassyStatus>

Returns:

the underlying string.