com.github.agadar.nsapi.domain.world

Class World

java.lang.Object

com.github.agadar.nsapi.domain.world.World

public class World
extends Object

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

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
List<CensusScore>	Census The world's census scores.
CensusDescriptions	CensusDescriptions Descriptions of the current or selected census.
int	CensusId Id of the current census.
CensusName	CensusName Name of the current or selected census.
NationCensusScoreRanks	CensusRanks The census scores of the world's nations.
CensusScale	CensusScale The scale of the current or selected census.
CensusTitle	CensusTitle The title of the current or selected census.
List<Dispatch>	Dispatches The newest or selected dispatches.
String	FeaturedRegion Name of today's featured region.
List<Happening>	Happenings List of the most recent or selected happenings.
List<String>	Nations List of all nations in the world.
List<String>	NewestNations List of newest nations.
int	NumberOfNations The number of nations in the world.
int	NumberOfRegions The number of regions in the world.
Dispatch	SelectedDispatch The selected dispatch.
Poll	SelectedPoll The selected poll.

Constructor Summary

Constructors

Constructor and Description
World()

Method Summary

Modifier and Type	Method and Description
List<String>	Regions() If the Regions shard was used alone or together with RegionsByTag, then this returns the retrieved Regions.
List<String>	RegionsByTag() If the RegionsByTag shard was used alone or together with Regions, then this returns the retrieved RegionsByTag.

Methods inherited from class java.lang.Object

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

Field Detail

Census

public List<CensusScore> Census

The world's census scores.

CensusId

public int CensusId

Id of the current census.

CensusDescriptions

public CensusDescriptions CensusDescriptions

Descriptions of the current or selected census.

CensusName

public CensusName CensusName

Name of the current or selected census.

CensusRanks

public NationCensusScoreRanks CensusRanks

The census scores of the world's nations.

CensusScale

public CensusScale CensusScale

The scale of the current or selected census.

CensusTitle

public CensusTitle CensusTitle

The title of the current or selected census.

SelectedDispatch

public Dispatch SelectedDispatch

The selected dispatch. Includes the dispatch text.

Dispatches

public List<Dispatch> Dispatches

The newest or selected dispatches. Does not include dispatches' texts.

FeaturedRegion

public String FeaturedRegion

Name of today's featured region.

Happenings

public List<Happening> Happenings

List of the most recent or selected happenings.

Nations

public List<String> Nations

List of all nations in the world.

NewestNations

public List<String> NewestNations

List of newest nations.

NumberOfNations

public int NumberOfNations

The number of nations in the world.

NumberOfRegions

public int NumberOfRegions

The number of regions in the world.

SelectedPoll

public Poll SelectedPoll

The selected poll.

Constructor Detail

World

public World()

Method Detail

Regions

public List<String> Regions()

If the Regions shard was used alone or together with RegionsByTag, then this returns the retrieved Regions. If ONLY the RegionsByTag shard was used, this returns the retrieved RegionsByTag. Else, returns null.

Returns:

region names

RegionsByTag

public List<String> RegionsByTag()

If the RegionsByTag shard was used alone or together with Regions, then this returns the retrieved RegionsByTag. If ONLY the Regions shard was used, this returns the retrieved Regions. Else, returns null.

Returns:

region names