com.github.agadar.nationstates

Interface INationStates

All Known Implementing Classes:

NationStates

public interface INationStates

The starting point for consumers of this Java wrapper for the NationStates API.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	doVersionCheck() Performs a simple version check, logging the results in the console.
NationQuery	getNation(String nationName) Starts building a nation query, using the given nation name.
NationDumpQuery	getNationDump(DailyDumpMode mode) Starts building a query that retrieves the daily nation dump.
RegionQuery	getRegion(String regionName) Starts building a region query, using the given region name.
RegionDumpQuery	getRegionDump(DailyDumpMode mode) Starts building a query that retrieves the daily region dump.
VersionQuery	getVersion() Starts building a query that retrieves the version number of the latest live NationStates API.
WorldQuery	getWorld(WorldShard... shards) Starts building a world query, using the selected shards.
WorldAssemblyQuery	getWorldAssembly(Council council) Starts building a World Assembly query, using the selected council type.
void	registerTypes(Class... types) Adds the given classes to the JAXB context so that they can be parsed to from retrieved XML responses and files.
TelegramQuery	sendTelegrams(String clientKey, String telegramId, String secretKey, String... nations) Starts building a query that sends (a) telegram(s).
void	setUserAgent(String userAgent) Sets the User Agent.
VerifyQuery	verifyNation(String nation, String checksum) Starts building a query that verifies a nation.

Method Detail

setUserAgent

void setUserAgent(String userAgent)

Sets the User Agent. NationStates moderators should be able to identify you and your script via your User Agent. As such, try providing at least your nation name, and preferably include your e-mail address, a link to a website you own, or something else that can help them contact you if needed.

Parameters:

userAgent - the User Agent to use for API calls

Throws:

IllegalArgumentException - if userAgent is null or empty.

doVersionCheck

void doVersionCheck()

Performs a simple version check, logging the results in the console.

registerTypes

void registerTypes(Class... types)

Adds the given classes to the JAXB context so that they can be parsed to from retrieved XML responses and files. Classes that inherit any of the classes in the domain-package don't need any xml-annotations. Classes that do no inherit those classes, do need xml-annotations.

Parameters:

types - the classes to add to the JAXB context

getNation

NationQuery getNation(String nationName)

Starts building a nation query, using the given nation name.

Parameters:

nationName - name of the nation to query

Returns:

a new nation query

getRegion

RegionQuery getRegion(String regionName)

Starts building a region query, using the given region name.

Parameters:

regionName - name of the region to query

Returns:

a new region query

getWorld

WorldQuery getWorld(WorldShard... shards)

Starts building a world query, using the selected shards.

Parameters:

shards - the selected shards

Returns:

a new world query

getWorldAssembly

WorldAssemblyQuery getWorldAssembly(Council council)

Starts building a World Assembly query, using the selected council type.

Parameters:

council - the council type to query

Returns:

a new World Assembly query

getVersion

VersionQuery getVersion()

Starts building a query that retrieves the version number of the latest live NationStates API.

Returns:

a new version query

verifyNation

VerifyQuery verifyNation(String nation,
                         String checksum)

Starts building a query that verifies a nation.

Parameters:

nation - the nation to verify

checksum - the verification checksum

Returns:

a new verify query

sendTelegrams

TelegramQuery sendTelegrams(String clientKey,
                            String telegramId,
                            String secretKey,
                            String... nations)

Starts building a query that sends (a) telegram(s).

Parameters:

clientKey - the client key

telegramId - the telegram id

secretKey - the telegram's secret key

nations - the nation(s) to send the telegram to

Returns:

a new telegram query

getRegionDump

RegionDumpQuery getRegionDump(DailyDumpMode mode)

Starts building a query that retrieves the daily region dump.

Parameters:

mode - the daily dump mode to use

Returns:

a new daily region dump query

getNationDump

NationDumpQuery getNationDump(DailyDumpMode mode)

Starts building a query that retrieves the daily nation dump. Warning: reading the XML file and parsing it to objects may cause a java.lang.OutOfMemoryError on older machines due to the sheer number of Nation objects being created from parsing the retrieved XML file.

Parameters:

mode - the daily dump mode to use

Returns:

a new daily nation dump query