Package com.github.dannil.scbjavaclient.client.environment.smallerlocalities

Class EnvironmentSmallerLocalitiesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.smallerlocalities.EnvironmentSmallerLocalitiesClient

public class EnvironmentSmallerLocalitiesClient
extends AbstractClient

Client which handles environment smaller localities data fetching.

Since:

0.4.0

Constructor Summary

Constructors

Constructor	Description
EnvironmentSmallerLocalitiesClient()	Default constructor.
EnvironmentSmallerLocalitiesClient(Locale locale)	Overloaded constructor.

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getLandArea()	Fetch all land area data.
List<ResponseModel>	getLandArea(Collection<String> regions, Collection<Integer> years)	Fetch all land area data which match the input constraints.
URLEndpoint	getUrl()	Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentSmallerLocalitiesClient

public EnvironmentSmallerLocalitiesClient()

Default constructor.

EnvironmentSmallerLocalitiesClient

public EnvironmentSmallerLocalitiesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getLandArea

public List<ResponseModel> getLandArea()

Fetch all land area data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getLandArea(Collection, Collection)

getLandArea

public List<ResponseModel> getLandArea(Collection<String> regions,
                                       Collection<Integer> years)

Fetch all land area data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getUrl

public URLEndpoint getUrl()

Description copied from class: AbstractClient

Returns the URL endpoint which this client represents.

Specified by:

getUrl in class AbstractClient

Returns:

the URL endpoint for this client