com.github.dannil.scbjavaclient.client.population.density

Class PopulationDensityClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.density.PopulationDensityClient

public class PopulationDensityClient
extends AbstractClient

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

Method Summary

Modifier and Type	Method and Description
List<Density>	getDensity() Fetch all density data.
List<Density>	getDensity(Collection<String> regions, Collection<String> sexes, Collection<Integer> years) Fetch all density 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

PopulationDensityClient

public PopulationDensityClient()

Default constructor.

PopulationDensityClient

public PopulationDensityClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getDensity

public List<Density> getDensity()

Fetch all density data.

Returns:

the density data wrapped in a list of Density objects

See Also:

getDensity(Collection, Collection, Collection)

getDensity

public List<Density> getDensity(Collection<String> regions,
                                Collection<String> sexes,
                                Collection<Integer> years)

Fetch all density data which match the input constraints.

Parameters:

regions - the regions to fetch data for

sexes - the sexes to fetch data for

years - the years to fetch data for

Returns:

the density data wrapped in a list of Density 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