com.github.agadar.nsapi.query.blueprint

Class CensusQuery<Q extends CensusQuery,R,S extends Shard>

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<Q,R,S>

Type Parameters:

Q - the child class that extends this abstract class

R - the type the child class' execute()-function returns

S - the shard type the child class accepts

Direct Known Subclasses:

CensusRankQuery, NationQuery

public abstract class CensusQuery<Q extends CensusQuery,R,S extends Shard>
extends ShardQuery<Q,R,S>

Intermediate parent class that adds options for censusses.

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
CensusQuery(String resourceValue) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
Q	censusHistoryFrom(long timestamp) Sets the lower bound in UNIX timestamp for the History census mode.
Q	censusHistoryTo(long timestamp) Sets the upper bound in UNIX timestamp for the History census mode.
Q	censusIds(CensusId... censusIds) Sets the census id's.
Q	censusIds(int... censusIds) Deprecated.
Q	censusModes(CensusMode... censusModes) Sets the census modes.

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, resourceString, slowMode, validateQueryParameters

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

CensusQuery

public CensusQuery(String resourceValue)

Constructor. Sets the resource value, e.g. the nation's or region's name.

Parameters:

resourceValue - the resource value

Method Detail

censusIds

@Deprecated
public final Q censusIds(int... censusIds)

Deprecated.

Sets the census id's. Does nothing if none of the following shards are set: Census, CensusRanks, CensusName, CensusDescriptions, CensusScale, or CensusTitle. Note: setting multiple id's is only supported for the Census shard. Deprecated. Will be removed in v.2.0. Use the method that takes CensusId enumerator instead.

Parameters:

censusIds - the census id's to set

Returns:

this

censusIds

public final Q censusIds(CensusId... censusIds)

Sets the census id's. Does nothing if none of the following shards are set: Census, CensusRanks, CensusName, CensusDescriptions, CensusScale, or CensusTitle. Note: setting multiple id's is only supported for the Census shard.

Parameters:

censusIds - the census id's to set

Returns:

this

censusModes

public final Q censusModes(CensusMode... censusModes)

Sets the census modes. Does nothing if the Census shard is not selected. Note that the History census mode cannot be combined with any other modes.

Parameters:

censusModes - the census modes to select

Returns:

this

censusHistoryFrom

public final Q censusHistoryFrom(long timestamp)

Sets the lower bound in UNIX timestamp for the History census mode. Implicitly sets the History census mode.

Parameters:

timestamp - the lower bound in UNIX timestamp for the History census mode

Returns:

this

censusHistoryTo

public final Q censusHistoryTo(long timestamp)

Sets the upper bound in UNIX timestamp for the History census mode. Implicitly sets the History census mode.

Parameters:

timestamp - the upper bound in UNIX timestamp for the History census mode

Returns:

this

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 ShardQuery<Q extends CensusQuery,R,S extends Shard>

Returns:

the generated String URL