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

Class PricesAndConsumptionCPIKPIFClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.kpif.PricesAndConsumptionCPIKPIFClient

public class PricesAndConsumptionCPIKPIFClient
extends AbstractClient

Client which handles prices and consumption Consumer Price Index (CPI) Underlying Inflation Rate (KPIF) data fetching.

Since:

0.4.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getUnderlyingInflationAnnualChanges()	Fetch all underlying inflation annual changes data.
List<ResponseModel>	getUnderlyingInflationAnnualChanges(Collection<String> months)	Fetch all underlying inflation annual changes data which match the input constraints.
List<ResponseModel>	getUnderlyingInflationMonthlyChanges()	Fetch all underlying inflation monthly changes data.
List<ResponseModel>	getUnderlyingInflationMonthlyChanges(Collection<String> months)	Fetch all underlying inflation monthly changes 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

PricesAndConsumptionCPIKPIFClient

public PricesAndConsumptionCPIKPIFClient()

Default constructor.

PricesAndConsumptionCPIKPIFClient

public PricesAndConsumptionCPIKPIFClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getUnderlyingInflationMonthlyChanges

public List<ResponseModel> getUnderlyingInflationMonthlyChanges()

Fetch all underlying inflation monthly changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getUnderlyingInflationMonthlyChanges(Collection)

getUnderlyingInflationMonthlyChanges

public List<ResponseModel> getUnderlyingInflationMonthlyChanges(Collection<String> months)

Fetch all underlying inflation monthly changes data which match the input constraints.

Parameters:

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getUnderlyingInflationAnnualChanges

public List<ResponseModel> getUnderlyingInflationAnnualChanges()

Fetch all underlying inflation annual changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getUnderlyingInflationAnnualChanges(Collection)

getUnderlyingInflationAnnualChanges

public List<ResponseModel> getUnderlyingInflationAnnualChanges(Collection<String> months)

Fetch all underlying inflation annual changes data which match the input constraints.

Parameters:

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