com.github.dannil.scbjavaclient.client.pricesandconsumption

Class PricesAndConsumptionClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.AbstractContainerClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.PricesAndConsumptionClient

public class PricesAndConsumptionClient
extends AbstractContainerClient

Client which handles prices and consumption data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PricesAndConsumptionBPIClient	bpi() Retrieve the client for interacting with prices and consumption building price index (BPI) data.
PricesAndConsumptionCCIClient	cci() Retrieve the client for interacting with prices and consumption construction cost index (CCI) data.
PricesAndConsumptionCPIClient	cpi() Retrieve the client for interacting with prices and consumption Consumer Price Index (CPI) data.
URLEndpoint	getUrl() Returns the URL endpoint which this client represents.
PricesAndConsumptionPPIClient	ppi() Retrieve the client for interacting with prices and consumption producer and import price index (PPI) data.
PricesAndConsumptionPurchasingPowerParitiesClient	purchasingPowerParities() Retrieve the client for interacting with prices and consumption purchasing power parities 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

PricesAndConsumptionClient

public PricesAndConsumptionClient()

Default constructor. Initializes values and creates sub-clients.

PricesAndConsumptionClient

public PricesAndConsumptionClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

bpi

public PricesAndConsumptionBPIClient bpi()

Retrieve the client for interacting with prices and consumption building price index (BPI) data.

Returns:

a client for prices and consumption building price index (BPI) data

cci

public PricesAndConsumptionCCIClient cci()

Retrieve the client for interacting with prices and consumption construction cost index (CCI) data.

Returns:

a client for prices and consumption construction cost index (CCI) data

cpi

public PricesAndConsumptionCPIClient cpi()

Retrieve the client for interacting with prices and consumption Consumer Price Index (CPI) data.

Returns:

a client for prices and consumption Consumer Price Index (CPI) data

ppi

public PricesAndConsumptionPPIClient ppi()

Retrieve the client for interacting with prices and consumption producer and import price index (PPI) data.

Returns:

a client for prices and consumption producer and import price index (PPI) data

purchasingPowerParities

public PricesAndConsumptionPurchasingPowerParitiesClient purchasingPowerParities()

Retrieve the client for interacting with prices and consumption purchasing power parities data.

Returns:

a client for prices and consumption purchasing power parities 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