com.github.dannil.scbjavaclient.client.population.statistics.foreigncitizens

Class PopulationStatisticsForeignCitizensClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.foreigncitizens.PopulationStatisticsForeignCitizensClient

public class PopulationStatisticsForeignCitizensClient
extends AbstractClient

Client which handles population statistics foreign citizens data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getForeignCitizens() Fetch all foreign citizens data.
List<ResponseModel>	getForeignCitizens(Collection<String> regions, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all foreign citizens 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

PopulationStatisticsForeignCitizensClient

public PopulationStatisticsForeignCitizensClient()

Default constructor.

PopulationStatisticsForeignCitizensClient

public PopulationStatisticsForeignCitizensClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getForeignCitizens

public List<ResponseModel> getForeignCitizens()

Fetch all foreign citizens data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getForeignCitizens(Collection, Collection, Collection, Collection)

getForeignCitizens

public List<ResponseModel> getForeignCitizens(Collection<String> regions,
                                              Collection<String> ages,
                                              Collection<Integer> sexes,
                                              Collection<Integer> years)

Fetch all foreign citizens data which match the input constraints.

Parameters:

regions - the regions

ages - the ages

sexes - the sexes

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