WorldShard (NationStates API Java Wrapper 3.0.0 API)

java.lang.Object
- java.lang.Enum<WorldShard>
- - com.github.agadar.nationstates.shard.WorldShard

All Implemented Interfaces:

Shard, Serializable, Comparable<WorldShard>
```
public enum WorldShard
extends Enum<WorldShard>
implements Shard
```
Shards available for World requests. These shards have a 1:1 correspondence with the variable fields in World.java.

Author:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CENSUS` The world's census scores.
`CENSUS_DESCRIPTIONS` Descriptions of the current or selected census.
`CENSUS_ID` Id of the current census.
`CENSUS_NAME` Name of the current or selected census.
`CENSUS_RANKS` The census scores of the world's nations.
`CENSUS_SCALE` The scale of the current or selected census.
`CENSUS_TITLE` The title of the current or selected census.
`DISPATCHES` The latest hottest or selected dispatches.
`FEATURED_REGION` Name of today's featured region.
`HAPPENINGS` List of the most recent or selected happenings.
`NATIONS` List of all nations in the world.
`NEWEST_NATIONS` List of newest nations.
`NUMBER_OF_NATIONS` The number of nations in the world.
`NUMBER_OF_REGIONS` The number of regions in the world.
`REGIONS` List of all regions in the world.
`REGIONS_BY_TAG` List of regions selected by tag.
`SELECTED_DISPATCH` The selected dispatch.
`SELECTED_POLL` The selected poll.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`shardName()` Returns the underlying name of the shard.
`static WorldShard`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static WorldShard[]`	`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
  - CENSUS
```
public static final WorldShard CENSUS
```
    The world's census scores.
  - CENSUS_ID
```
public static final WorldShard CENSUS_ID
```
    Id of the current census.
  - CENSUS_DESCRIPTIONS
```
public static final WorldShard CENSUS_DESCRIPTIONS
```
    Descriptions of the current or selected census.
  - CENSUS_NAME
```
public static final WorldShard CENSUS_NAME
```
    Name of the current or selected census.
  - CENSUS_RANKS
```
public static final WorldShard CENSUS_RANKS
```
    The census scores of the world's nations.
  - CENSUS_SCALE
```
public static final WorldShard CENSUS_SCALE
```
    The scale of the current or selected census.
  - CENSUS_TITLE
```
public static final WorldShard CENSUS_TITLE
```
    The title of the current or selected census.
  - SELECTED_DISPATCH
```
public static final WorldShard SELECTED_DISPATCH
```
    The selected dispatch. Includes the dispatch text. An id must be supplied.
  - DISPATCHES
```
public static final WorldShard DISPATCHES
```
    The latest hottest or selected dispatches. Does not include dispatches' texts.
  - FEATURED_REGION
```
public static final WorldShard FEATURED_REGION
```
    Name of today's featured region.
  - HAPPENINGS
```
public static final WorldShard HAPPENINGS
```
    List of the most recent or selected happenings.
  - NATIONS
```
public static final WorldShard NATIONS
```
    List of all nations in the world.
  - NEWEST_NATIONS
```
public static final WorldShard NEWEST_NATIONS
```
    List of newest nations.
  - NUMBER_OF_NATIONS
```
public static final WorldShard NUMBER_OF_NATIONS
```
    The number of nations in the world.
  - NUMBER_OF_REGIONS
```
public static final WorldShard NUMBER_OF_REGIONS
```
    The number of regions in the world.
  - SELECTED_POLL
```
public static final WorldShard SELECTED_POLL
```
    The selected poll.
  - REGIONS
```
public static final WorldShard REGIONS
```
    List of all regions in the world.
  - REGIONS_BY_TAG
```
public static final WorldShard REGIONS_BY_TAG
```
    List of regions selected by tag. Tags must be supplied.
- Method Detail
  - values
```
public static WorldShard[] 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 (WorldShard c : WorldShard.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static WorldShard 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
  - shardName
```
public String shardName()
```
    Description copied from interface: Shard
    
    Returns the underlying name of the shard.
    
    Specified by:
    
    shardName in interface Shard
    
    Returns:
    
    the underlying name of the shard

Enum WorldShard

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CENSUS

CENSUS_ID

CENSUS_DESCRIPTIONS

CENSUS_NAME

CENSUS_RANKS

CENSUS_SCALE

CENSUS_TITLE

SELECTED_DISPATCH

DISPATCHES

FEATURED_REGION

HAPPENINGS

NATIONS

NEWEST_NATIONS

NUMBER_OF_NATIONS

NUMBER_OF_REGIONS

SELECTED_POLL

REGIONS

REGIONS_BY_TAG

Method Detail

values

valueOf

shardName