Package com.github.dannil.scbjavaclient.client.population.statistics.foreignbornpersons

Class PopulationStatisticsForeignBornPersonsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.foreignbornpersons.PopulationStatisticsForeignBornPersonsClient

public class PopulationStatisticsForeignBornPersonsClient
extends AbstractClient

Client which handles population statistics foreign-born persons data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getPopulationByCountryOfBirth()	Fetch all population by country of birth data.
List<ResponseModel>	getPopulationByCountryOfBirth(Collection<String> countriesOfBirths, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years)	Fetch all population by country of birth data which match the input constraints.
List<ResponseModel>	getSwedishAndForeignBornPopulation()	Fetch all Swedish and foreign-born population data.
List<ResponseModel>	getSwedishAndForeignBornPopulation(Collection<String> regions, Collection<String> ages, Collection<Integer> sexes, Collection<String> regionsOfBirths, Collection<Integer> years)	Fetch all Swedish and foreign-born population 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

PopulationStatisticsForeignBornPersonsClient

public PopulationStatisticsForeignBornPersonsClient()

Default constructor.

PopulationStatisticsForeignBornPersonsClient

public PopulationStatisticsForeignBornPersonsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getSwedishAndForeignBornPopulation

public List<ResponseModel> getSwedishAndForeignBornPopulation()

Fetch all Swedish and foreign-born population data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getSwedishAndForeignBornPopulation(Collection, Collection, Collection, Collection, Collection)

getSwedishAndForeignBornPopulation

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

Fetch all Swedish and foreign-born population data which match the input constraints.

Parameters:

regions - the regions

ages - the ages

sexes - the sexes

regionsOfBirths - the regions of births

years - the years

Returns:

the data wrapped in a list of ResponseModel objects

getPopulationByCountryOfBirth

public List<ResponseModel> getPopulationByCountryOfBirth()

Fetch all population by country of birth data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getPopulationByCountryOfBirth(Collection, Collection, Collection, Collection)

getPopulationByCountryOfBirth

public List<ResponseModel> getPopulationByCountryOfBirth(Collection<String> countriesOfBirths,
                                                         Collection<String> ages,
                                                         Collection<Integer> sexes,
                                                         Collection<Integer> years)

Fetch all population by country of birth data which match the input constraints.

Parameters:

countriesOfBirths - the countries of births

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