WorldShard (NationStates API Java Wrapper 1.2.0 API)

java.lang.Object
- java.lang.Enum<WorldShard>
- - com.github.agadar.nsapi.enums.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.
`CensusDescriptions` Descriptions of the current or selected census.
`CensusId` Id of the current census.
`CensusName` Name of the current or selected census.
`CensusRanks` The census scores of the world's nations.
`CensusScale` The scale of the current or selected census.
`CensusTitle` The title of the current or selected census.
`Dispatches` The latest hottest or selected dispatches.
`FeaturedRegion` Name of today's featured region.
`Happenings` List of the most recent or selected happenings.
`Nations` List of all nations in the world.
`NewestNations` List of newest nations.
`NumberOfNations` The number of nations in the world.
`NumberOfRegions` The number of regions in the world.
`Regions` List of all regions in the world.
`RegionsByTag` List of regions selected by tag.
`SelectedDispatch` The selected dispatch.
`SelectedPoll` 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.
  - CensusId
```
public static final WorldShard CensusId
```
    Id of the current census.
  - CensusDescriptions
```
public static final WorldShard CensusDescriptions
```
    Descriptions of the current or selected census.
  - CensusName
```
public static final WorldShard CensusName
```
    Name of the current or selected census.
  - CensusRanks
```
public static final WorldShard CensusRanks
```
    The census scores of the world's nations.
  - CensusScale
```
public static final WorldShard CensusScale
```
    The scale of the current or selected census.
  - CensusTitle
```
public static final WorldShard CensusTitle
```
    The title of the current or selected census.
  - SelectedDispatch
```
public static final WorldShard SelectedDispatch
```
    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.
  - FeaturedRegion
```
public static final WorldShard FeaturedRegion
```
    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.
  - NewestNations
```
public static final WorldShard NewestNations
```
    List of newest nations.
  - NumberOfNations
```
public static final WorldShard NumberOfNations
```
    The number of nations in the world.
  - NumberOfRegions
```
public static final WorldShard NumberOfRegions
```
    The number of regions in the world.
  - SelectedPoll
```
public static final WorldShard SelectedPoll
```
    The selected poll.
  - Regions
```
public static final WorldShard Regions
```
    List of all regions in the world.
  - RegionsByTag
```
public static final WorldShard RegionsByTag
```
    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

CensusId

CensusDescriptions

CensusName

CensusRanks

CensusScale

CensusTitle

SelectedDispatch

Dispatches

FeaturedRegion

Happenings

Nations

NewestNations

NumberOfNations

NumberOfRegions

SelectedPoll

Regions

RegionsByTag

Method Detail

values

valueOf

shardName