NationShard (NationStates API Java Wrapper 3.0.0 API)

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

All Implemented Interfaces:

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

Author:

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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ADMIRABLE` One of two adjectives for this nation, e.g.
`ANIMAL` This nation's national animal.
`ANIMAL_TRAIT` Information about this nation's national animal.
`AVERAGE_INCOME` The average income of the population.
`AVERAGE_INCOME_TAX_RATE` The income tax rate, expressed as a percentage.
`BANNER` The Rift banner code of this nation's primary banner, or of a randomly chosen eligible banner if no primary banner is set.
`BANNERS` The eligible Rift banner codes of this nation.
`CAN_RECEIVE_CAMPAIGN_TELEGRAMS` True if the nation is not currently blocking campaign telegrams.
`CAN_RECEIVE_RECRUITMENT_TELEGRAMS` True if the nation is not currently blocking recruitment telegrams.
`CAPITAL` This nation's capital.
`CATEGORY` This nation's government's category e.g.
`CENSUS` This nation's census scale scores.
`CRIME_DESCRIPTION` Description of crime in this nation.
`CURRENCY` This nation's currency name.
`CUSTOM_CAPITAL` This nation's capital.
`CUSTOM_LEADER` This nation's leader.
`CUSTOM_RELIGION` This nation's religion.
`DEATHS` List of death causes data in this nation.
`DEMONYM` Primary demonym.
`DEMONYM2` Secondary demonym.
`DEMONYM2_PLURAL` Plural of secondary demonym.
`DISPATCHES` This nations's dispatches.
`ECONOMY_DESCRIPTION` Elaborate description of this nation's economy.
`ECONOMY_SECTORS` Overview in percentages of the government's economy sectors.
`ENDORSED_BY` List of nation names that endorsed this nation.
`FACTBOOKS` This nation's factbooks.
`FIRST_LOGIN` UNIX timestamp of when the nation first logged in.
`FLAG_URL` URL to the nation's flag image.
`FOUNDED` UNIX timestamp of when this nation was founded.
`FOUNDED_DESCRIPTION` Description of when this nation was founded.
`FREEDOM` The nation's civil rights, economy, and political freedoms scores.
`FULL_NAME` The nation's full name.
`GENERAL_ASSEMBLY_VOTE` The nation's vote for the current General Assembly resolution.
`GOVERNMENT_DESCRIPTION` Elaborate description of the government.
`GOVERNMENT_EXPENDITURE` Overview in percentages of the government's expenditures.
`GOVERNMENT_PRIORITY` The expenditure the government spends most on.
`GOVERNMENT_TYPE` The nation's custom government type, e.g.
`GROSS_DOMESTIC_PRODUCT` The nation's gross domestic product.
`LAST_ACTIVITY` Description of when this nation was last active.
`LAST_LOGIN` UNIX timestamp of when this nation was last logged in.
`LEADER` This nation's leader.
`MAJOR_INDUSTRY` This nation's biggest industry.
`MOTTO` This nation's national motto.
`NAME` This nation's name.
`NOTABLE_FOR` Description of what this nation is most notable for.
`NUMBER_OF_DISPATCHES` Number of dispatches written by this nation.
`NUMBER_OF_FACTBOOKS` Number of factbooks written by this nation.
`POOREST_INCOME` Income of the poorest population.
`POPULATION` The population, in millions.
`POPULATION_DESCRIPTION` Description of this nation's population.
`PUBLIC_SECTOR` The percentage of the economy that is State-Owned or Government.
`RECENT_HAPPENINGS` List of the most recent of this nation's happenings.
`RECENT_LEGISLATION` List of this nation's most recent legislations.
`REGION_NAME` Name of the region this nation is in.
`REGIONAL_CENSUS_RANK` The nation's regional census rank.
`REGIONAL_INFLUENCE` The regional influence of this nation, e.g.
`RELIGION` This nation's religion.
`RICHEST_INCOME` Income of the richest population.
`SECURITY_COUNCIL_VOTE` The nation's vote for the current Security Council resolution.
`WORLD_ASSEMBLY_STATUS` String indicating whether the nation is a member of the World Assembly.
`WORLD_CENSUS_RANK` The nation's world-wide census rank
`ZOMBIE_INFO` This nation's statistics of the current or last zombie event.

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 NationShard`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static NationShard[]`	`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
  - ADMIRABLE
```
public static final NationShard ADMIRABLE
```
    One of two adjectives for this nation, e.g. 'cultured', 'safe', etc.
  - ANIMAL
```
public static final NationShard ANIMAL
```
    This nation's national animal.
  - ANIMAL_TRAIT
```
public static final NationShard ANIMAL_TRAIT
```
    Information about this nation's national animal.
  - BANNER
```
public static final NationShard BANNER
```
    The Rift banner code of this nation's primary banner, or of a randomly chosen eligible banner if no primary banner is set. Can be prepended by '/images/banners/' and appended by '.jpg' to convert into an image URL.
  - BANNERS
```
public static final NationShard BANNERS
```
    The eligible Rift banner codes of this nation. Codes can be prepended by '/images/banners/' and appended by '.jpg' to convert into image URLs.
  - CAPITAL
```
public static final NationShard CAPITAL
```
    This nation's capital. Has default value if none is set.
  - CATEGORY
```
public static final NationShard CATEGORY
```
    This nation's government's category e.g. 'Civil Rights Lovefest'.
  - CENSUS
```
public static final NationShard CENSUS
```
    This nation's census scale scores.
  - CRIME_DESCRIPTION
```
public static final NationShard CRIME_DESCRIPTION
```
    Description of crime in this nation.
  - CURRENCY
```
public static final NationShard CURRENCY
```
    This nation's currency name.
  - CUSTOM_LEADER
```
public static final NationShard CUSTOM_LEADER
```
    This nation's leader. Blank if none is set.
  - CUSTOM_CAPITAL
```
public static final NationShard CUSTOM_CAPITAL
```
    This nation's capital. Blank if none is set.
  - CUSTOM_RELIGION
```
public static final NationShard CUSTOM_RELIGION
```
    This nation's religion. Blank if none is set.
  - DEATHS
```
public static final NationShard DEATHS
```
    List of death causes data in this nation.
  - DEMONYM
```
public static final NationShard DEMONYM
```
    Primary demonym.
  - DEMONYM2
```
public static final NationShard DEMONYM2
```
    Secondary demonym.
  - DEMONYM2_PLURAL
```
public static final NationShard DEMONYM2_PLURAL
```
    Plural of secondary demonym.
  - NUMBER_OF_DISPATCHES
```
public static final NationShard NUMBER_OF_DISPATCHES
```
    Number of dispatches written by this nation.
  - DISPATCHES
```
public static final NationShard DISPATCHES
```
    This nations's dispatches. Includes factbooks. Does not include dispatches' texts.
  - ENDORSED_BY
```
public static final NationShard ENDORSED_BY
```
    List of nation names that endorsed this nation.
  - NUMBER_OF_FACTBOOKS
```
public static final NationShard NUMBER_OF_FACTBOOKS
```
    Number of factbooks written by this nation.
  - FACTBOOKS
```
public static final NationShard FACTBOOKS
```
    This nation's factbooks. Subset of Dispatches. Does not include dispatches' texts.
  - FIRST_LOGIN
```
public static final NationShard FIRST_LOGIN
```
    UNIX timestamp of when the nation first logged in.
  - FLAG_URL
```
public static final NationShard FLAG_URL
```
    URL to the nation's flag image.
  - FOUNDED_DESCRIPTION
```
public static final NationShard FOUNDED_DESCRIPTION
```
    Description of when this nation was founded.
  - FOUNDED
```
public static final NationShard FOUNDED
```
    UNIX timestamp of when this nation was founded.
  - FREEDOM
```
public static final NationShard FREEDOM
```
    The nation's civil rights, economy, and political freedoms scores.
  - FULL_NAME
```
public static final NationShard FULL_NAME
```
    The nation's full name.
  - GENERAL_ASSEMBLY_VOTE
```
public static final NationShard GENERAL_ASSEMBLY_VOTE
```
    The nation's vote for the current General Assembly resolution.
  - GROSS_DOMESTIC_PRODUCT
```
public static final NationShard GROSS_DOMESTIC_PRODUCT
```
    The nation's gross domestic product.
  - GOVERNMENT_EXPENDITURE
```
public static final NationShard GOVERNMENT_EXPENDITURE
```
    Overview in percentages of the government's expenditures.
  - GOVERNMENT_DESCRIPTION
```
public static final NationShard GOVERNMENT_DESCRIPTION
```
    Elaborate description of the government.
  - GOVERNMENT_PRIORITY
```
public static final NationShard GOVERNMENT_PRIORITY
```
    The expenditure the government spends most on.
  - RECENT_HAPPENINGS
```
public static final NationShard RECENT_HAPPENINGS
```
    List of the most recent of this nation's happenings.
  - AVERAGE_INCOME
```
public static final NationShard AVERAGE_INCOME
```
    The average income of the population.
  - ECONOMY_DESCRIPTION
```
public static final NationShard ECONOMY_DESCRIPTION
```
    Elaborate description of this nation's economy.
  - REGIONAL_INFLUENCE
```
public static final NationShard REGIONAL_INFLUENCE
```
    The regional influence of this nation, e.g. 'Apprentice'.
  - LAST_ACTIVITY
```
public static final NationShard LAST_ACTIVITY
```
    Description of when this nation was last active.
  - LAST_LOGIN
```
public static final NationShard LAST_LOGIN
```
    UNIX timestamp of when this nation was last logged in.
  - LEADER
```
public static final NationShard LEADER
```
    This nation's leader. Has default value if none is set.
  - RECENT_LEGISLATION
```
public static final NationShard RECENT_LEGISLATION
```
    List of this nation's most recent legislations.
  - MAJOR_INDUSTRY
```
public static final NationShard MAJOR_INDUSTRY
```
    This nation's biggest industry.
  - MOTTO
```
public static final NationShard MOTTO
```
    This nation's national motto.
  - NAME
```
public static final NationShard NAME
```
    This nation's name.
  - NOTABLE_FOR
```
public static final NationShard NOTABLE_FOR
```
    Description of what this nation is most notable for.
  - POOREST_INCOME
```
public static final NationShard POOREST_INCOME
```
    Income of the poorest population.
  - POPULATION
```
public static final NationShard POPULATION
```
    The population, in millions.
  - PUBLIC_SECTOR
```
public static final NationShard PUBLIC_SECTOR
```
    The percentage of the economy that is State-Owned or Government.
  - REGIONAL_CENSUS_RANK
```
public static final NationShard REGIONAL_CENSUS_RANK
```
    The nation's regional census rank.
  - REGION_NAME
```
public static final NationShard REGION_NAME
```
    Name of the region this nation is in.
  - RELIGION
```
public static final NationShard RELIGION
```
    This nation's religion. Has default value if none is set.
  - RICHEST_INCOME
```
public static final NationShard RICHEST_INCOME
```
    Income of the richest population.
  - SECURITY_COUNCIL_VOTE
```
public static final NationShard SECURITY_COUNCIL_VOTE
```
    The nation's vote for the current Security Council resolution.
  - ECONOMY_SECTORS
```
public static final NationShard ECONOMY_SECTORS
```
    Overview in percentages of the government's economy sectors.
  - POPULATION_DESCRIPTION
```
public static final NationShard POPULATION_DESCRIPTION
```
    Description of this nation's population.
  - AVERAGE_INCOME_TAX_RATE
```
public static final NationShard AVERAGE_INCOME_TAX_RATE
```
    The income tax rate, expressed as a percentage.
  - CAN_RECEIVE_RECRUITMENT_TELEGRAMS
```
public static final NationShard CAN_RECEIVE_RECRUITMENT_TELEGRAMS
```
    True if the nation is not currently blocking recruitment telegrams.
  - CAN_RECEIVE_CAMPAIGN_TELEGRAMS
```
public static final NationShard CAN_RECEIVE_CAMPAIGN_TELEGRAMS
```
    True if the nation is not currently blocking campaign telegrams.
  - GOVERNMENT_TYPE
```
public static final NationShard GOVERNMENT_TYPE
```
    The nation's custom government type, e.g. 'Crowned Confederacy'.
  - WORLD_ASSEMBLY_STATUS
```
public static final NationShard WORLD_ASSEMBLY_STATUS
```
    String indicating whether the nation is a member of the World Assembly. Corresponds to the 'WA' shard, but its XML-tag is 'UNSTATUS'.
  - WORLD_CENSUS_RANK
```
public static final NationShard WORLD_CENSUS_RANK
```
    The nation's world-wide census rank
  - ZOMBIE_INFO
```
public static final NationShard ZOMBIE_INFO
```
    This nation's statistics of the current or last zombie event.
- Method Detail
  - values
```
public static NationShard[] 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 (NationShard c : NationShard.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static NationShard 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 NationShard

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ADMIRABLE

ANIMAL

ANIMAL_TRAIT

BANNER

BANNERS

CAPITAL

CATEGORY

CENSUS

CRIME_DESCRIPTION

CURRENCY

CUSTOM_LEADER

CUSTOM_CAPITAL

CUSTOM_RELIGION

DEATHS

DEMONYM

DEMONYM2

DEMONYM2_PLURAL

NUMBER_OF_DISPATCHES

DISPATCHES

ENDORSED_BY

NUMBER_OF_FACTBOOKS

FACTBOOKS

FIRST_LOGIN

FLAG_URL

FOUNDED_DESCRIPTION

FOUNDED

FREEDOM

FULL_NAME

GENERAL_ASSEMBLY_VOTE

GROSS_DOMESTIC_PRODUCT

GOVERNMENT_EXPENDITURE

GOVERNMENT_DESCRIPTION

GOVERNMENT_PRIORITY

RECENT_HAPPENINGS

AVERAGE_INCOME

ECONOMY_DESCRIPTION

REGIONAL_INFLUENCE

LAST_ACTIVITY

LAST_LOGIN

LEADER

RECENT_LEGISLATION

MAJOR_INDUSTRY

MOTTO

NAME

NOTABLE_FOR

POOREST_INCOME

POPULATION

PUBLIC_SECTOR

REGIONAL_CENSUS_RANK

REGION_NAME

RELIGION

RICHEST_INCOME

SECURITY_COUNCIL_VOTE

ECONOMY_SECTORS

POPULATION_DESCRIPTION

AVERAGE_INCOME_TAX_RATE

CAN_RECEIVE_RECRUITMENT_TELEGRAMS

CAN_RECEIVE_CAMPAIGN_TELEGRAMS

GOVERNMENT_TYPE

WORLD_ASSEMBLY_STATUS

WORLD_CENSUS_RANK

ZOMBIE_INFO

Method Detail

values

valueOf

shardName