com.github.agadar.nationstates.query

Class WorldAssemblyQuery

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<WorldAssemblyQuery,WorldAssembly,WorldAssemblyShard>

com.github.agadar.nationstates.query.WorldAssemblyQuery

public final class WorldAssemblyQuery
extends ShardQuery<WorldAssemblyQuery,WorldAssembly,WorldAssemblyShard>

A query to the NationStates API's World Assembly 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
WorldAssemblyQuery(IXmlConverter xmlConverter, IRateLimiter generalRateLimiter, IRateLimiter scrapingRateLimiter, String baseUrl, String userAgent, int apiVersion, Council council) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	buildURL() Generates a String URL based on the supplied values.
WorldAssemblyQuery	resolutionId(int resolutionId) Sets the id of the resolution to retrieve.
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.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

WorldAssemblyQuery

public WorldAssemblyQuery(IXmlConverter xmlConverter,
                          IRateLimiter generalRateLimiter,
                          IRateLimiter scrapingRateLimiter,
                          String baseUrl,
                          String userAgent,
                          int apiVersion,
                          Council council)

Constructor. Sets the council type to query.

Parameters:

xmlConverter -

generalRateLimiter -

scrapingRateLimiter -

baseUrl -

userAgent -

apiVersion -

council - the council type to query

Method Detail

resolutionId

public final WorldAssemblyQuery resolutionId(int resolutionId)

Sets the id of the resolution to retrieve. Does nothing if the Resolution shard is not selected.

Parameters:

resolutionId - the id of the resolution to retrieve

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<WorldAssemblyQuery,WorldAssembly>

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<WorldAssemblyQuery,WorldAssembly>

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<WorldAssemblyQuery,WorldAssembly,WorldAssemblyShard>

Returns:

the generated String URL