com.github.agadar.nationstates.enumerator

Enum Council

java.lang.Object

java.lang.Enum<Council>

com.github.agadar.nationstates.enumerator.Council

All Implemented Interfaces:

Serializable, Comparable<Council>

public enum Council
extends Enum<Council>

The different councils within the World Assembly.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Council.Adapter Converts an integer to a Council enum value and vice versa.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERAL_ASSEMBLY The General Assembly
SECURITY_COUNCIL The Security Council

Method Summary

Modifier and Type	Method and Description
static Council	fromInt(int councilNumber) Returns the Council instance that has the given council number.
int	toInt() Return the underlying council number.
static Council	valueOf(String name) Returns the enum constant of this type with the specified name.
static Council[]	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

GENERAL_ASSEMBLY

public static final Council GENERAL_ASSEMBLY

The General Assembly

SECURITY_COUNCIL

public static final Council SECURITY_COUNCIL

The Security Council

Method Detail

values

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

Returns:

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

valueOf

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

toInt

public int toInt()

Return the underlying council number.

Returns:

the underlying council number

fromInt

public static Council fromInt(int councilNumber)

Returns the Council instance that has the given council number.

Parameters:

councilNumber - the council number

Returns:

the corresponding Council