com.github.dannil.scbjavaclient.client.population.averageage

Class PopulationAverageAgeClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.averageage.PopulationAverageAgeClient

public class PopulationAverageAgeClient
extends AbstractClient

Client which handles population average age 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
PopulationAverageAgeClient() Default constructor.
PopulationAverageAgeClient(Locale locale) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
List<AverageAge>	getAverageAge() Fetch all average age data.
List<AverageAge>	getAverageAge(Collection<String> regions, Collection<String> genders, Collection<Integer> years) Fetch all average age 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

PopulationAverageAgeClient

public PopulationAverageAgeClient()

Default constructor.

PopulationAverageAgeClient

public PopulationAverageAgeClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAverageAge

public List<AverageAge> getAverageAge()

Fetch all average age data.

Returns:

the average age data wrapped in a list of AverageAge objects

See Also:

getAverageAge(Collection, Collection, Collection)

getAverageAge

public List<AverageAge> getAverageAge(Collection<String> regions,
                                      Collection<String> genders,
                                      Collection<Integer> years)

Fetch all average age data which match the input constraints.

Parameters:

regions - the regions to fetch data for

genders - the genders to fetch data for

years - the years to fetch data for

Returns:

the average age data wrapped in a list of AverageAge 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