com.github.dannil.scbjavaclient.client.environment.landandwaterarea

Class EnvironmentLandAndWaterAreaClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.landandwaterarea.EnvironmentLandAndWaterAreaClient

public class EnvironmentLandAndWaterAreaClient
extends AbstractClient

Client which handles environment land and water area data fetching.

Since:

0.0.2

Field Summary

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

locale, localization

Constructor Summary

Constructors

Constructor and Description
EnvironmentLandAndWaterAreaClient() Default constructor.
EnvironmentLandAndWaterAreaClient(Locale locale) Overloaded constructor.

Method Summary

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

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

get, getBaseUrl, getLocale, getRegions, getYears, post, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentLandAndWaterAreaClient

public EnvironmentLandAndWaterAreaClient()

Default constructor.

EnvironmentLandAndWaterAreaClient

public EnvironmentLandAndWaterAreaClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getArea

public List<Area> getArea()

Fetch all area data.

Returns:

the area data wrapped in a list of Area objects

See Also:

getArea(Collection, Collection, Collection)

getArea

public List<Area> getArea(Collection<String> regions,
                          Collection<String> types,
                          Collection<Integer> years)

Fetch all area data which match the input constraints.

Parameters:

regions - the regions to fetch data for

types - the types to fetch data for

years - the years to fetch data for

Returns:

the area data wrapped in a list of Area objects

getUrl

public String getUrl()

Description copied from class: AbstractClient

Returns the URL endpoint which this client represents.

Overrides:

getUrl in class AbstractClient

Returns:

the URL endpoint for this client