com.github.dannil.scbjavaclient.client.population

Class PopulationClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.AbstractContainerClient

com.github.dannil.scbjavaclient.client.population.PopulationClient

public class PopulationClient
extends AbstractContainerClient

Client which handles population data fetching.

Since:

0.0.2

Field Summary

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

clients

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

locale, localization

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PopulationAmountClient	amount() Retrieve the client for interacting with population amount data.
PopulationAverageAgeClient	averageAge() Retrieve the client for interacting with population average age data.
PopulationDemographyClient	demography() Retrieve the client for interacting with population demography data.
PopulationDensityClient	density() Retrieve the client for interacting with population density data.
String	getUrl() Returns the URL endpoint which this client represents.
PopulationLiveBirthsClient	liveBirths() Retrieve the client for interacting with population live births data.
PopulationNameStatisticsClient	nameStatistics() Retrieve the client for interacting with population name statistic data.
PopulationPartnershipClient	partnership() Retrieve the client for interacting with population partnership data.

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

setLocale

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PopulationClient

public PopulationClient()

Default constructor. Initializes values and creates sub-clients.

PopulationClient

public PopulationClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

amount

public PopulationAmountClient amount()

Retrieve the client for interacting with population amount data.

Returns:

a client for population amount data

averageAge

public PopulationAverageAgeClient averageAge()

Retrieve the client for interacting with population average age data.

Returns:

a client for population average age data

demography

public PopulationDemographyClient demography()

Retrieve the client for interacting with population demography data.

Returns:

a client for population demography data

density

public PopulationDensityClient density()

Retrieve the client for interacting with population density data.

Returns:

a client for population density data

liveBirths

public PopulationLiveBirthsClient liveBirths()

Retrieve the client for interacting with population live births data.

Returns:

a client for population live births data

nameStatistics

public PopulationNameStatisticsClient nameStatistics()

Retrieve the client for interacting with population name statistic data.

Returns:

a client for population name statistic data

partnership

public PopulationPartnershipClient partnership()

Retrieve the client for interacting with population partnership data.

Returns:

a client for population partnership data

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