NationShard (NationStates API Java Wrapper 1.2.0 API)

java.lang.Object
- java.lang.Enum<NationShard>
- - com.github.agadar.nsapi.enums.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.
`AnimalTrait` Information about this nation's national animal.
`AverageIncome` The average income of the population.
`AverageIncomeTaxRate` 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.
`CanReceiveCampaignTelegrams` True if the nation is not currently blocking campaign telegrams.
`CanReceiveRecruitmentTelegrams` 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.
`CensusRankInRegion` The nation's regional census rank.
`CensusRankInWorld` The nation's world-wide census rank
`CrimeDescription` Description of crime in this nation.
`Currency` This nation's currency name.
`CustomCapital` This nation's capital.
`CustomLeader` This nation's leader.
`CustomReligion` This nation's religion.
`Deaths` List of death causes data in this nation.
`Demonym` Primary demonym.
`Demonym2` Secondary demonym.
`Demonym2Plural` Plural of secondary demonym.
`Dispatches` This nations's dispatches.
`EconomyDescription` Elaborate description of this nation's economy.
`EconomySectors` Overview in percentages of the government's economy sectors.
`EndorsedBy` List of nation names that endorsed this nation.
`Factbooks`
`FirstLogin` UNIX timestamp of when the nation first logged in.
`FlagUrl` URL to the nation's flag image.
`Founded` Description of when this nation was founded.
`FoundedTime` UNIX timestamp of when this nation was founded.
`Freedom` The nation's civil rights, economy, and political freedoms scores.
`FullName` The nation's full name.
`GeneralAssemblyVote` The nation's vote for the current General Assembly resolution.
`GovernmentDescription` Elaborate description of the government.
`GovernmentExpenditure` Overview in percentages of the government's expenditures.
`GovernmentPriority` The expenditure the government spends most on.
`GovernmentType` The nation's custom government type, e.g.
`GrossDomesticProduct` The nation's gross domestic product.
`LastActivity` Description of when this nation was last active.
`LastLogin` UNIX timestamp of when this nation was last logged in.
`Leader` This nation's leader.
`MajorIndustry` This nation's biggest industry.
`Motto` This nation's national motto.
`Name` This nation's name.
`NotableFor` Description of what this nation is most notable for.
`NumberOfDispatches` Number of dispatches written by this nation.
`NumberOfFactbooks` Number of factbooks written by this nation.
`PoorestIncome` Income of the poorest population.
`Population` The population, in millions.
`PopulationDescription` Description of this nation's population.
`PublicSector` The percentage of the economy that is State-Owned or Government.
`RecentHappenings` List of the most recent of this nation's happenings.
`RecentLegislation` List of this nation's most recent legislations.
`RegionalInfluence` The regional influence of this nation, e.g.
`RegionName` Name of the region this nation is in.
`Religion` This nation's religion.
`RichestIncome` Income of the richest population.
`SecurityCouncilVote` The nation's vote for the current Security Council resolution.
`WorldAssemblyStatus` String indicating whether the nation is a member of the World Assembly.
`ZombieInfo` 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.
  - AnimalTrait
```
public static final NationShard AnimalTrait
```
    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.
  - CrimeDescription
```
public static final NationShard CrimeDescription
```
    Description of crime in this nation.
  - Currency
```
public static final NationShard Currency
```
    This nation's currency name.
  - CustomLeader
```
public static final NationShard CustomLeader
```
    This nation's leader. Blank if none is set.
  - CustomCapital
```
public static final NationShard CustomCapital
```
    This nation's capital. Blank if none is set.
  - CustomReligion
```
public static final NationShard CustomReligion
```
    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.
  - Demonym2Plural
```
public static final NationShard Demonym2Plural
```
    Plural of secondary demonym.
  - NumberOfDispatches
```
public static final NationShard NumberOfDispatches
```
    Number of dispatches written by this nation.
  - Dispatches
```
public static final NationShard Dispatches
```
    This nations's dispatches. Includes factbooks. Does not include dispatches' texts.
  - EndorsedBy
```
public static final NationShard EndorsedBy
```
    List of nation names that endorsed this nation.
  - NumberOfFactbooks
```
public static final NationShard NumberOfFactbooks
```
    Number of factbooks written by this nation.
  - Factbooks
```
public static final NationShard Factbooks
```
  - FirstLogin
```
public static final NationShard FirstLogin
```
    UNIX timestamp of when the nation first logged in.
  - FlagUrl
```
public static final NationShard FlagUrl
```
    URL to the nation's flag image.
  - Founded
```
public static final NationShard Founded
```
    Description of when this nation was founded.
  - FoundedTime
```
public static final NationShard FoundedTime
```
    UNIX timestamp of when this nation was founded.
  - Freedom
```
public static final NationShard Freedom
```
    The nation's civil rights, economy, and political freedoms scores.
  - FullName
```
public static final NationShard FullName
```
    The nation's full name.
  - GeneralAssemblyVote
```
public static final NationShard GeneralAssemblyVote
```
    The nation's vote for the current General Assembly resolution.
  - GrossDomesticProduct
```
public static final NationShard GrossDomesticProduct
```
    The nation's gross domestic product.
  - GovernmentExpenditure
```
public static final NationShard GovernmentExpenditure
```
    Overview in percentages of the government's expenditures.
  - GovernmentDescription
```
public static final NationShard GovernmentDescription
```
    Elaborate description of the government.
  - GovernmentPriority
```
public static final NationShard GovernmentPriority
```
    The expenditure the government spends most on.
  - RecentHappenings
```
public static final NationShard RecentHappenings
```
    List of the most recent of this nation's happenings.
  - AverageIncome
```
public static final NationShard AverageIncome
```
    The average income of the population.
  - EconomyDescription
```
public static final NationShard EconomyDescription
```
    Elaborate description of this nation's economy.
  - RegionalInfluence
```
public static final NationShard RegionalInfluence
```
    The regional influence of this nation, e.g. 'Apprentice'.
  - LastActivity
```
public static final NationShard LastActivity
```
    Description of when this nation was last active.
  - LastLogin
```
public static final NationShard LastLogin
```
    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.
  - RecentLegislation
```
public static final NationShard RecentLegislation
```
    List of this nation's most recent legislations.
  - MajorIndustry
```
public static final NationShard MajorIndustry
```
    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.
  - NotableFor
```
public static final NationShard NotableFor
```
    Description of what this nation is most notable for.
  - PoorestIncome
```
public static final NationShard PoorestIncome
```
    Income of the poorest population.
  - Population
```
public static final NationShard Population
```
    The population, in millions.
  - PublicSector
```
public static final NationShard PublicSector
```
    The percentage of the economy that is State-Owned or Government.
  - CensusRankInRegion
```
public static final NationShard CensusRankInRegion
```
    The nation's regional census rank.
  - RegionName
```
public static final NationShard RegionName
```
    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.
  - RichestIncome
```
public static final NationShard RichestIncome
```
    Income of the richest population.
  - SecurityCouncilVote
```
public static final NationShard SecurityCouncilVote
```
    The nation's vote for the current Security Council resolution.
  - EconomySectors
```
public static final NationShard EconomySectors
```
    Overview in percentages of the government's economy sectors.
  - PopulationDescription
```
public static final NationShard PopulationDescription
```
    Description of this nation's population.
  - AverageIncomeTaxRate
```
public static final NationShard AverageIncomeTaxRate
```
    The income tax rate, expressed as a percentage.
  - CanReceiveRecruitmentTelegrams
```
public static final NationShard CanReceiveRecruitmentTelegrams
```
    True if the nation is not currently blocking recruitment telegrams.
  - CanReceiveCampaignTelegrams
```
public static final NationShard CanReceiveCampaignTelegrams
```
    True if the nation is not currently blocking campaign telegrams.
  - GovernmentType
```
public static final NationShard GovernmentType
```
    The nation's custom government type, e.g. 'Crowned Confederacy'.
  - WorldAssemblyStatus
```
public static final NationShard WorldAssemblyStatus
```
    String indicating whether the nation is a member of the World Assembly. Corresponds to the 'WA' shard, but its XML-tag is 'UNSTATUS'.
  - CensusRankInWorld
```
public static final NationShard CensusRankInWorld
```
    The nation's world-wide census rank
  - ZombieInfo
```
public static final NationShard ZombieInfo
```
    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

AnimalTrait

Banner

Banners

Capital

Category

Census

CrimeDescription

Currency

CustomLeader

CustomCapital

CustomReligion

Deaths

Demonym

Demonym2

Demonym2Plural

NumberOfDispatches

Dispatches

EndorsedBy

NumberOfFactbooks

Factbooks

FirstLogin

FlagUrl

Founded

FoundedTime

Freedom

FullName

GeneralAssemblyVote

GrossDomesticProduct

GovernmentExpenditure

GovernmentDescription

GovernmentPriority

RecentHappenings

AverageIncome

EconomyDescription

RegionalInfluence

LastActivity

LastLogin

Leader

RecentLegislation

MajorIndustry

Motto

Name

NotableFor

PoorestIncome

Population

PublicSector

CensusRankInRegion

RegionName

Religion

RichestIncome

SecurityCouncilVote

EconomySectors

PopulationDescription

AverageIncomeTaxRate

CanReceiveRecruitmentTelegrams

CanReceiveCampaignTelegrams

GovernmentType

WorldAssemblyStatus

CensusRankInWorld

ZombieInfo

Method Detail

values

valueOf

shardName