com.github.dannil.scbjavaclient.client.environment.protectednature.populationandaccessibility

Class EnvironmentProtectedNaturePopulationAndAccessibilityClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.protectednature.populationandaccessibility.EnvironmentProtectedNaturePopulationAndAccessibilityClient

public class EnvironmentProtectedNaturePopulationAndAccessibilityClient
extends AbstractClient

Client which handles environment protected nature population and accessibility data fetching.

Since:

0.5.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getPopulationWithinZoneAroundProtectedNature() Fetch all population within zone around protected nature data.
List<ResponseModel>	getPopulationWithinZoneAroundProtectedNature(Collection<String> regions, Collection<Integer> years) Fetch all population within zone around protected nature data which match the input constraints.
List<ResponseModel>	getProtectedNatureWithinAndAroundLocalities() Fetch all protected nature within and around localities data.
List<ResponseModel>	getProtectedNatureWithinAndAroundLocalities(Collection<String> regions, Collection<Integer> years) Fetch all protected nature within and around localities 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

EnvironmentProtectedNaturePopulationAndAccessibilityClient

public EnvironmentProtectedNaturePopulationAndAccessibilityClient()

Default constructor.

EnvironmentProtectedNaturePopulationAndAccessibilityClient

public EnvironmentProtectedNaturePopulationAndAccessibilityClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getProtectedNatureWithinAndAroundLocalities

public List<ResponseModel> getProtectedNatureWithinAndAroundLocalities()

Fetch all protected nature within and around localities data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getProtectedNatureWithinAndAroundLocalities(Collection, Collection)

getProtectedNatureWithinAndAroundLocalities

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

Fetch all protected nature within and around localities data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPopulationWithinZoneAroundProtectedNature

public List<ResponseModel> getPopulationWithinZoneAroundProtectedNature()

Fetch all population within zone around protected nature data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationWithinZoneAroundProtectedNature(Collection, Collection)

getPopulationWithinZoneAroundProtectedNature

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

Fetch all population within zone around protected nature 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