com.github.agadar.nsapi.domain.nation

Class Nation

java.lang.Object

com.github.agadar.nsapi.domain.nation.Nation

public class Nation
extends Object

Representation of a nation. This class's fields have a 1:1 correspondence with the shards in NationShard.java.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
String	Admirable One of two adjectives for this nation, e.g.
String	Animal This nation's national animal.
String	AnimalTrait Information about this nation's national animal.
int	AverageIncome The average income of the population.
double	AverageIncomeTaxRate The income tax rate, expressed as a percentage.
String	Banner The Rift banner code of this nation's primary banner, or of a randomly chosen eligible banner if no primary banner is set.
List<String>	Banners The eligible Rift banner codes of this nation.
boolean	CanReceiveCampaignTelegrams True if the nation is not currently blocking campaign telegrams.
boolean	CanReceiveRecruitmentTelegrams True if the nation is not currently blocking recruitment telegrams.
String	Capital This nation's capital.
String	Category This nation's government's category e.g.
List<CensusScore>	Census This nation's census scale scores.
int	CensusRankInRegion The nation's regional census rank.
int	CensusRankInWorld The nation's world-wide census rank.
String	CrimeDescription Description of crime in this nation.
String	Currency This nation's currency name.
String	CustomCapital This nation's capital.
String	CustomLeader This nation's leader.
String	CustomReligion This nation's religion.
List<DeathCause>	Deaths List of death causes data in this nation.
String	Demonym Primary demonym.
String	Demonym2 Secondary demonym.
String	Demonym2Plural Plural of secondary demonym.
List<Dispatch>	Dispatches This nations's dispatches.
String	EconomyDescription Elaborate description of this nation's economy.
EconomySectors	EconomySectors Overview in percentages of the government's economy sectors.
List<String>	EndorsedBy List of nation names that endorsed this nation.
List<Dispatch>	Factbooks
long	FirstLogin UNIX timestamp of when the nation first logged in.
String	FlagUrl URL to the nation's flag image.
String	Founded Description of when this nation was founded.
Long	FoundedTime UNIX timestamp of when this nation was founded.
Freedom	Freedom The nation's civil rights, economy, and political freedoms scores.
String	FullName The nation's full name.
String	GeneralAssemblyVote The nation's vote for the current General Assembly resolution.
String	GovernmentDescription Elaborate description of the government.
GovernmentExpenditure	GovernmentExpenditure Overview in percentages of the government's expenditures.
String	GovernmentPriority The expenditure the government spends most on.
String	GovernmentType The nation's custom government type, e.g.
int	GrossDomesticProduct The nation's gross domestic product.
String	LastActivity Description of when this nation was last active.
long	LastLogin UNIX timestamp of when this nation was last logged in.
String	Leader This nation's leader.
String	MajorIndustry This nation's biggest industry.
String	Motto This nation's national motto.
String	Name This nation's name.
String	NotableFor Description of what this nation is most notable for.
int	NumberOfDispatches Number of dispatches written by this nation.
int	NumberOfFactbooks Number of factbooks written by this nation.
int	PoorestIncome Income of the poorest population.
int	Population The population, in millions.
String	PopulationDescription Description of this nation's population.
double	PublicSector The percentage of the economy that is State-Owned or Government.
List<Happening>	RecentHappenings List of the most recent of this nation's happenings.
List<String>	RecentLegislation List of this nation's most recent legislations.
String	RegionalInfluence The regional influence of this nation, e.g.
String	RegionName Name of the region this nation is in.
String	Religion This nation's religion.
int	RichestIncome Income of the richest population.
String	SecurityCouncilVote The nation's vote for the current Security Council resolution.
String	WorldAssemblyStatus String indicating whether the nation is a member of the World Assembly.
ZombieInfo	ZombieInfo This nation's statistics of the current or last zombie event.

Constructor Summary

Constructors

Constructor and Description
Nation()

Method Summary

Modifier and Type	Method and Description
String	BannerAsURL() Gives the URL that points to the image behind Banner.
List<String>	BannersAsURLs() Gives the URLs that point to the images behind Banners.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Admirable

public String Admirable

One of two adjectives for this nation, e.g. 'cultured', 'safe', etc.

Animal

public String Animal

This nation's national animal.

AnimalTrait

public String AnimalTrait

Information about this nation's national animal.

Banner

public String 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

public List<String> Banners

The eligible Rift banner codes of this nation.

Capital

public String Capital

This nation's capital. Has default value if none is set.

Category

public String Category

This nation's government's category e.g. 'Civil Rights Lovefest'.

Census

public List<CensusScore> Census

This nation's census scale scores.

CrimeDescription

public String CrimeDescription

Description of crime in this nation.

Currency

public String Currency

This nation's currency name.

CustomLeader

public String CustomLeader

This nation's leader. Blank if none is set.

CustomCapital

public String CustomCapital

This nation's capital. Blank if none is set.

CustomReligion

public String CustomReligion

This nation's religion. Blank if none is set.

Deaths

public List<DeathCause> Deaths

List of death causes data in this nation.

Demonym

public String Demonym

Primary demonym.

Demonym2

public String Demonym2

Secondary demonym.

Demonym2Plural

public String Demonym2Plural

Plural of secondary demonym.

NumberOfDispatches

public int NumberOfDispatches

Number of dispatches written by this nation.

Dispatches

public List<Dispatch> Dispatches

This nations's dispatches. Includes factbooks. Does not include dispatches' texts.

EndorsedBy

public List<String> EndorsedBy

List of nation names that endorsed this nation.

NumberOfFactbooks

public int NumberOfFactbooks

Number of factbooks written by this nation.

Factbooks

public List<Dispatch> Factbooks

FirstLogin

public long FirstLogin

UNIX timestamp of when the nation first logged in.

FlagUrl

public String FlagUrl

URL to the nation's flag image.

Founded

public String Founded

Description of when this nation was founded.

FoundedTime

public Long FoundedTime

UNIX timestamp of when this nation was founded.

Freedom

public Freedom Freedom

The nation's civil rights, economy, and political freedoms scores.

FullName

public String FullName

The nation's full name.

GeneralAssemblyVote

public String GeneralAssemblyVote

The nation's vote for the current General Assembly resolution.

GrossDomesticProduct

public int GrossDomesticProduct

The nation's gross domestic product.

GovernmentExpenditure

public GovernmentExpenditure GovernmentExpenditure

Overview in percentages of the government's expenditures.

GovernmentDescription

public String GovernmentDescription

Elaborate description of the government.

GovernmentPriority

public String GovernmentPriority

The expenditure the government spends most on.

RecentHappenings

public List<Happening> RecentHappenings

List of the most recent of this nation's happenings.

AverageIncome

public int AverageIncome

The average income of the population.

EconomyDescription

public String EconomyDescription

Elaborate description of this nation's economy.

RegionalInfluence

public String RegionalInfluence

The regional influence of this nation, e.g. 'Apprentice'.

LastActivity

public String LastActivity

Description of when this nation was last active.

LastLogin

public long LastLogin

UNIX timestamp of when this nation was last logged in.

Leader

public String Leader

This nation's leader. Has default value if none is set.

RecentLegislation

public List<String> RecentLegislation

List of this nation's most recent legislations.

MajorIndustry

public String MajorIndustry

This nation's biggest industry.

Motto

public String Motto

This nation's national motto.

Name

public String Name

This nation's name.

NotableFor

public String NotableFor

Description of what this nation is most notable for.

PoorestIncome

public int PoorestIncome

Income of the poorest population.

Population

public int Population

The population, in millions.

PublicSector

public double PublicSector

The percentage of the economy that is State-Owned or Government.

CensusRankInRegion

public int CensusRankInRegion

The nation's regional census rank.

RegionName

public String RegionName

Name of the region this nation is in.

Religion

public String Religion

This nation's religion. Has default value if none is set.

RichestIncome

public int RichestIncome

Income of the richest population.

SecurityCouncilVote

public String SecurityCouncilVote

The nation's vote for the current Security Council resolution.

EconomySectors

public EconomySectors EconomySectors

Overview in percentages of the government's economy sectors.

PopulationDescription

public String PopulationDescription

Description of this nation's population.

AverageIncomeTaxRate

public double AverageIncomeTaxRate

The income tax rate, expressed as a percentage.

CanReceiveRecruitmentTelegrams

public boolean CanReceiveRecruitmentTelegrams

True if the nation is not currently blocking recruitment telegrams.

CanReceiveCampaignTelegrams

public boolean CanReceiveCampaignTelegrams

True if the nation is not currently blocking campaign telegrams.

GovernmentType

public String GovernmentType

The nation's custom government type, e.g. 'Crowned Confederacy'.

WorldAssemblyStatus

public String 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 int CensusRankInWorld

The nation's world-wide census rank.

ZombieInfo

public ZombieInfo ZombieInfo

This nation's statistics of the current or last zombie event.

Constructor Detail

Nation

public Nation()

Method Detail

BannerAsURL

public String BannerAsURL()

Gives the URL that points to the image behind Banner.

Returns:

the URL that points to the image behind Banner

BannersAsURLs

public List<String> BannersAsURLs()

Gives the URLs that point to the images behind Banners.

Returns:

the URLs that point to the images behind Banners.