PopulationClient (scb-java-client 3.0.0 API)

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

Constructor Summary

Constructors
Constructor Description

PopulationClient()
Default constructor.

PopulationClient(Locale locale)
Overloaded constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`URLEndpoint`	`getUrl()`	Returns the URL endpoint which this client represents.
`PopulationNameClient`	`name()`	Retrieve the client for interacting with population statistics name data.
`PopulationProjectionsClient`	`projections()`	Retrieve the client for interacting with population projections data.
`PopulationStatisticsClient`	`statistics()`	Retrieve the client for interacting with population statistics data.

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractContainerClient
addClient, getClient, setLocale

Methods inherited from class com.github.dannil.scbjavaclient.client.AbstractClient
doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, 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
  - name
```
public PopulationNameClient name()
```
    Retrieve the client for interacting with population statistics name data.
    
    Returns:
    
    a client for population statistics name data
  - projections
```
public PopulationProjectionsClient projections()
```
    Retrieve the client for interacting with population projections data.
    
    Returns:
    
    a client for population projections data
  - statistics
```
public PopulationStatisticsClient statistics()
```
    Retrieve the client for interacting with population statistics data.
    
    Returns:
    
    a client for population statistics data
  - 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