Package com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.economicindicators

Class PricesAndConsumptionCPIEconomicIndicatorsClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.economicindicators.PricesAndConsumptionCPIEconomicIndicatorsClient

public class PricesAndConsumptionCPIEconomicIndicatorsClient
extends AbstractClient

Client which handles prices and consumption Consumer Price Index (CPI) economic indicators data fetching.

Since:

0.4.0

Constructor Summary

Constructors

Constructor	Description
PricesAndConsumptionCPIEconomicIndicatorsClient()	Default constructor.
PricesAndConsumptionCPIEconomicIndicatorsClient(Locale locale)	Overloaded constructor.

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getConsumerPriceIndex()	Fetch all consumer price index data.
List<ResponseModel>	getConsumerPriceIndex(Collection<String> indicators, Collection<String> months)	Fetch all consumer price index data which match the input constraints.
URLEndpoint	getUrl()	Returns the URL endpoint which this client represents.

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

doGetRequest, doPostRequest, getCommunicationProtocol, getLocale, getLocalizationLocale, getResponseModels, getResponseModels, getRootUrl, setCommunicationProtocol, setLocale, setLocalizationLocale

Methods inherited from class java.lang.Object

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

Constructor Detail

PricesAndConsumptionCPIEconomicIndicatorsClient

public PricesAndConsumptionCPIEconomicIndicatorsClient()

Default constructor.

PricesAndConsumptionCPIEconomicIndicatorsClient

public PricesAndConsumptionCPIEconomicIndicatorsClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getConsumerPriceIndex

public List<ResponseModel> getConsumerPriceIndex()

Fetch all consumer price index data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getConsumerPriceIndex(Collection, Collection)

getConsumerPriceIndex

public List<ResponseModel> getConsumerPriceIndex(Collection<String> indicators,
                                                 Collection<String> months)

Fetch all consumer price index data which match the input constraints.

Parameters:

indicators - the indicators

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

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