com.github.agadar.nsapi.query.blueprint

Class ShardQuery<Q extends ShardQuery,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>

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:

CensusQuery, WAQuery

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

Intermediate parent class that adds support for shards.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected S[]	shards See 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
ShardQuery(String resourceValue) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
Q	shards(S... shards) Sets the 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

Field Detail

shards

protected S extends Shard[] shards

See shards(...).

Constructor Detail

ShardQuery

public ShardQuery(String resourceValue)

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

Parameters:

resourceValue - the resource value

Method Detail

shards

public final Q shards(S... shards)

Sets the shards.

Parameters:

shards - the shards to set

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 APIQuery<Q extends ShardQuery,R>

Returns:

the generated String URL