com.github.agadar.nsapi.enums

Enum CensusMode

java.lang.Object

java.lang.Enum<CensusMode>

com.github.agadar.nsapi.enums.CensusMode

All Implemented Interfaces:

Serializable, Comparable<CensusMode>

public enum CensusMode
extends Enum<CensusMode>

Available values for the Mode option for the Census shard.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
History The history of the census score.
RegionRank The nation's regional rank on the scale.
RegionRankPercent The nation's regional rank on the scale, as a percentage.
Score The nation's individual score, or the region's or world's average score.
WorldRank The nation's or region's world-wide rank on the scale.
WorldRankPercent The nation's or region's world-wide rank on the scale, as a percentage.

Method Summary

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

Score

public static final CensusMode Score

The nation's individual score, or the region's or world's average score.

WorldRank

public static final CensusMode WorldRank

The nation's or region's world-wide rank on the scale. e.g. '334' means '334th'. Inapplicable for world.

RegionRank

public static final CensusMode RegionRank

The nation's regional rank on the scale. e.g. '334' means '334th'. Inapplicable for regions and world.

WorldRankPercent

public static final CensusMode WorldRankPercent

The nation's or region's world-wide rank on the scale, as a percentage. e.g. '15' means 'Top 15%'. Inapplicable for world.

RegionRankPercent

public static final CensusMode RegionRankPercent

The nation's regional rank on the scale, as a percentage. e.g. '15' means 'Top 15%'. Inapplicable for regions and world.

History

public static final CensusMode History

The history of the census score. Cannot be combined with other modes.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Return the underlying option name.

Overrides:

toString in class Enum<CensusMode>

Returns:

the underlying option name