com.github.agadar.nationstates.query

Class VersionQuery

java.lang.Object

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

com.github.agadar.nationstates.query.APIQuery<VersionQuery,Integer>

com.github.agadar.nationstates.query.VersionQuery

public final class VersionQuery
extends APIQuery<VersionQuery,Integer>

A query to the NationStates API's utility resource, retrieving the version number of the latest live API.

Author:

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

Field Summary

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
VersionQuery(IXmlConverter xmlConverter, IRateLimiter generalRateLimiter, IRateLimiter scrapingRateLimiter, String baseUrl, String userAgent, int apiVersion) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	resourceString() Gives the resource string of this Query, e.g.
protected <T> T	translateResponse(InputStream response, Class<T> type) Translates the stream response to the object this Query wishes to return via its execute() function.

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

buildURL, execute, getRateLimiter, slowMode, validateQueryParameters

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

closeInputStreamQuietly, execute, makeRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionQuery

public VersionQuery(IXmlConverter xmlConverter,
                    IRateLimiter generalRateLimiter,
                    IRateLimiter scrapingRateLimiter,
                    String baseUrl,
                    String userAgent,
                    int apiVersion)

Constructor.

Parameters:

xmlConverter -

generalRateLimiter -

scrapingRateLimiter -

baseUrl -

userAgent -

apiVersion -

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<VersionQuery,Integer>

Returns:

the resource string of this Query

translateResponse

protected <T> T translateResponse(InputStream response,
                                  Class<T> type)

Description copied from class: AbstractQuery

Translates the stream response to the object this Query wishes to return via its execute() function. The standard way to translate is via JAXB, which assumes the stream is in a valid XML-format. Child classes might want to override this function if they wish to return primitives or something else.

Overrides:

translateResponse in class AbstractQuery<VersionQuery,Integer>

Type Parameters:

T - type to parse to

Parameters:

response - the response to translate

type - type to parse to

Returns:

the translated response