com.github.agadar.nationstates.query

Class NationQuery

java.lang.Object

com.github.agadar.nationstates.query.AbstractQuery<Q,R>

com.github.agadar.nationstates.query.APIQuery<Q,R>

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

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

com.github.agadar.nationstates.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.nationstates.query.ShardQuery

shards

Fields inherited from class com.github.agadar.nationstates.query.APIQuery

generalRateLimiter, resourceValue

Fields inherited from class com.github.agadar.nationstates.query.AbstractQuery

userAgent

Constructor Summary

Constructors

Constructor and Description
NationQuery(IXmlConverter xmlConverter, IRateLimiter generalRateLimiter, IRateLimiter scrapingRateLimiter, String baseUrl, String userAgent, int apiVersion, String nationName) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
NationQuery	canReceiveTelegramFromRegion(String region) For use with the 'CanReceiveRecruitmentTelegrams' and 'CanReceiveCampaignTelegrams' shards.
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.nationstates.query.CensusQuery

censusHistoryFrom, censusHistoryTo, censusIds, censusModes

Methods inherited from class com.github.agadar.nationstates.query.ShardQuery

shards

Methods inherited from class com.github.agadar.nationstates.query.APIQuery

execute, getRateLimiter, slowMode

Methods inherited from class com.github.agadar.nationstates.query.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(IXmlConverter xmlConverter,
                   IRateLimiter generalRateLimiter,
                   IRateLimiter scrapingRateLimiter,
                   String baseUrl,
                   String userAgent,
                   int apiVersion,
                   String nationName)

Constructor. Sets the name of the nation to query.

Parameters:

xmlConverter -

generalRateLimiter -

scrapingRateLimiter -

baseUrl -

userAgent -

apiVersion -

nationName - name of the nation to query

Method Detail

canReceiveTelegramFromRegion

public final NationQuery canReceiveTelegramFromRegion(String region)

For use with the 'CanReceiveRecruitmentTelegrams' and 'CanReceiveCampaignTelegrams' shards. Allows a sender region to be specified.

Parameters:

region - the specified region.

Returns:

this

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>

buildURL

protected String buildURL()

Description copied from class: AbstractQuery

Generates a String URL based on the supplied values. Subclasses might want to override this method to build the String URL further to accommodate for additional shards/modes/options/etc.

Overrides:

buildURL in class CensusQuery<NationQuery,Nation,NationShard>

Returns:

the generated String URL