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

Class PopulationStatisticsCitizenshipClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.citizenship.PopulationStatisticsCitizenshipClient

public class PopulationStatisticsCitizenshipClient
extends AbstractClient

Client which handles population statistics citizenship data fetching.

Since:

1.2.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getAcquiredSwedishCitizenship() Fetch all acquired Swedish citizenship data.
List<ResponseModel>	getAcquiredSwedishCitizenship(Collection<String> regions, Collection<String> ages, Collection<Integer> sexes, Collection<Integer> years) Fetch all acquired Swedish citizenship data which match the input constraints.
List<ResponseModel>	getAcquiredSwedishCitizenshipInSweden() Fetch all acquired Swedish citizenship in Sweden data.
List<ResponseModel>	getAcquiredSwedishCitizenshipInSweden(Collection<String> countriesOfCitizenship, Collection<Integer> sexes, Collection<Integer> years) Fetch all acquired Swedish citizenship in Sweden 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

PopulationStatisticsCitizenshipClient

public PopulationStatisticsCitizenshipClient()

Default constructor.

PopulationStatisticsCitizenshipClient

public PopulationStatisticsCitizenshipClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAcquiredSwedishCitizenship

public List<ResponseModel> getAcquiredSwedishCitizenship()

Fetch all acquired Swedish citizenship data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAcquiredSwedishCitizenship(Collection, Collection, Collection, Collection)

getAcquiredSwedishCitizenship

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

Fetch all acquired Swedish citizenship 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

getAcquiredSwedishCitizenshipInSweden

public List<ResponseModel> getAcquiredSwedishCitizenshipInSweden()

Fetch all acquired Swedish citizenship in Sweden data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAcquiredSwedishCitizenshipInSweden(Collection, Collection, Collection)

getAcquiredSwedishCitizenshipInSweden

public List<ResponseModel> getAcquiredSwedishCitizenshipInSweden(Collection<String> countriesOfCitizenship,
                                                                 Collection<Integer> sexes,
                                                                 Collection<Integer> years)

Fetch all acquired Swedish citizenship in Sweden data which match the input constraints.

Parameters:

countriesOfCitizenship - the countries of citizenship

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