com.github.dannil.scbjavaclient.client.population.amount

Class PopulationAmountClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.amount.PopulationAmountClient

public class PopulationAmountClient
extends AbstractClient

Client which handles population amount data fetching.

Since:

0.1.0

Field Summary

Fields inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

locale, localization

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<Population>	getPopulation() Fetch all population amount data.
List<Population>	getPopulation(Collection<String> regions, Collection<String> relationshipStatuses, Collection<String> ages, Collection<Integer> genders, Collection<Integer> years) Fetch all population amount data which match the input constraints.
String	getUrl() Returns the URL endpoint which this client represents.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient

get, getBaseUrl, getLocale, getRegions, getYears, post, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PopulationAmountClient

public PopulationAmountClient()

Default constructor.

PopulationAmountClient

public PopulationAmountClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getPopulation

public List<Population> getPopulation()

Fetch all population amount data.

Returns:

the population amount data wrapped in a list of Population objects

See Also:

getPopulation(Collection, Collection, Collection, Collection, Collection)

getPopulation

public List<Population> getPopulation(Collection<String> regions,
                                      Collection<String> relationshipStatuses,
                                      Collection<String> ages,
                                      Collection<Integer> genders,
                                      Collection<Integer> years)

Fetch all population amount data which match the input constraints.

Parameters:

regions - the regions to fetch data for

relationshipStatuses - the relationship statuses to fetch data for

ages - the ages to fetch data for

genders - the genders to fetch data for

years - the years to fetch data for

Returns:

the population amount data wrapped in a list of Population objects

getUrl

public String getUrl()

Description copied from class: AbstractClient

Returns the URL endpoint which this client represents.

Overrides:

getUrl in class AbstractClient

Returns:

the URL endpoint for this client