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

Class LandAndWaterAreaClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

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

public class LandAndWaterAreaClient
extends AbstractClient

Client which handles environment land and water area data fetching.

Author:

Daniel Nilsson

Field Summary

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

locale, localization, queryBuilder

Constructor Summary

Constructors

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

Method Summary

Methods

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.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LandAndWaterAreaClient

public LandAndWaterAreaClient()

Default constructor.

LandAndWaterAreaClient

public LandAndWaterAreaClient(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