com.github.agadar.nsapi.query

Class NationQuery

java.lang.Object

com.github.agadar.nsapi.query.blueprint.AbstractQuery<Q,R>

com.github.agadar.nsapi.query.blueprint.APIQuery<Q,R>

com.github.agadar.nsapi.query.blueprint.ShardQuery<Q,R,S>

com.github.agadar.nsapi.query.blueprint.CensusQuery<NationQuery,Nation,NationShard>

com.github.agadar.nsapi.query.NationQuery

public final class NationQuery
extends CensusQuery<NationQuery,Nation,NationShard>

A query to the NationStates API's nation resource.

Author:

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

Field Summary

Fields inherited from class com.github.agadar.nsapi.query.blueprint.ShardQuery

shards

Fields inherited from class com.github.agadar.nsapi.query.blueprint.APIQuery

rateLimiter, resourceValue

Fields inherited from class com.github.agadar.nsapi.query.blueprint.AbstractQuery

logger

Constructor Summary

Constructors

Constructor and Description
NationQuery(String nationName) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	resourceString() Gives the resource string of this Query, e.g.
protected void	validateQueryParameters() Validates the query parameters before executing the query.

Methods inherited from class com.github.agadar.nsapi.query.blueprint.CensusQuery

buildURL, censusHistoryFrom, censusHistoryTo, censusIds, censusIds, censusModes

Methods inherited from class com.github.agadar.nsapi.query.blueprint.ShardQuery

shards

Methods inherited from class com.github.agadar.nsapi.query.blueprint.APIQuery

execute, getRateLimiter, slowMode

Methods inherited from class com.github.agadar.nsapi.query.blueprint.AbstractQuery

closeInputStreamQuietly, execute, makeRequest, translateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

NationQuery

public NationQuery(String nationName)

Constructor. Sets the name of the nation to query.

Parameters:

nationName - name of the nation to query

Method Detail

resourceString

protected String resourceString()

Description copied from class: APIQuery

Gives the resource string of this Query, e.g. 'nation', 'region', etc.

Specified by:

resourceString in class APIQuery<NationQuery,Nation>

Returns:

the resource string of this Query

validateQueryParameters

protected void validateQueryParameters()

Description copied from class: AbstractQuery

Validates the query parameters before executing the query. If the query parameters are invalid, an exception is thrown. Child classes will want to override this class (making sure to still call super.validateQueryParameters()) if they have additional parameters to validate.

Overrides:

validateQueryParameters in class APIQuery<NationQuery,Nation>