Package com.github.dannil.scbjavaclient.client.environment.protectednature.naturetypes

Class EnvironmentProtectedNatureNatureTypesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.environment.protectednature.naturetypes.EnvironmentProtectedNatureNatureTypesClient

public class EnvironmentProtectedNatureNatureTypesClient
extends AbstractClient

Client which handles environment protected nature nature types data fetching.

Since:

0.5.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getNewProtectedAreas()	Fetch all new protected areas data.
List<ResponseModel>	getNewProtectedAreas(Collection<String> natureTypes, Collection<Integer> years)	Fetch all new protected areas data which match the input constraints.
List<ResponseModel>	getProductiveForestLand()	Fetch all productive forest land data.
List<ResponseModel>	getProductiveForestLand(Collection<String> regions, Collection<Integer> years)	Fetch all productive forest land data which match the input constraints.
List<ResponseModel>	getProtectedAreas()	Fetch all protected areas data.
List<ResponseModel>	getProtectedAreas(Collection<String> natureTypes, Collection<Integer> years)	Fetch all protected areas data which match the input constraints.
List<ResponseModel>	getProtectedNatureAboveTheBoundariesForMountainForests()	Fetch all protected nature above the boundaries for mountain forests data.
List<ResponseModel>	getProtectedNatureAboveTheBoundariesForMountainForests(Collection<String> natureTypes, Collection<Integer> years)	Fetch all protected nature above the boundaries for mountain forests 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

EnvironmentProtectedNatureNatureTypesClient

public EnvironmentProtectedNatureNatureTypesClient()

Default constructor.

EnvironmentProtectedNatureNatureTypesClient

public EnvironmentProtectedNatureNatureTypesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getProtectedAreas

public List<ResponseModel> getProtectedAreas()

Fetch all protected areas data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getProtectedAreas(Collection, Collection)

getProtectedAreas

public List<ResponseModel> getProtectedAreas(Collection<String> natureTypes,
                                             Collection<Integer> years)

Fetch all protected areas data which match the input constraints.

Parameters:

natureTypes - the nature types

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getProductiveForestLand

public List<ResponseModel> getProductiveForestLand()

Fetch all productive forest land data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getProductiveForestLand(Collection, Collection)

getProductiveForestLand

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

Fetch all productive forest land data which match the input constraints.

Parameters:

regions - the regions

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getProtectedNatureAboveTheBoundariesForMountainForests

public List<ResponseModel> getProtectedNatureAboveTheBoundariesForMountainForests()

Fetch all protected nature above the boundaries for mountain forests data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getProtectedNatureAboveTheBoundariesForMountainForests(Collection, Collection)

getProtectedNatureAboveTheBoundariesForMountainForests

public List<ResponseModel> getProtectedNatureAboveTheBoundariesForMountainForests(Collection<String> natureTypes,
                                                                                  Collection<Integer> years)

Fetch all protected nature above the boundaries for mountain forests data which match the input constraints.

Parameters:

natureTypes - the nature types

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getNewProtectedAreas

public List<ResponseModel> getNewProtectedAreas()

Fetch all new protected areas data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getNewProtectedAreas(Collection, Collection)

getNewProtectedAreas

public List<ResponseModel> getNewProtectedAreas(Collection<String> natureTypes,
                                                Collection<Integer> years)

Fetch all new protected areas data which match the input constraints.

Parameters:

natureTypes - the nature types

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