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

Class PricesAndConsumptionCPIHICPClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.pricesandconsumption.cpi.hicp.PricesAndConsumptionCPIHICPClient

public class PricesAndConsumptionCPIHICPClient
extends AbstractClient

Client which handles prices and consumption Consumer Price Index (CPI) Harmonized Index of Consumer Prices (HICP) data fetching.

Since:

0.5.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<ResponseModel>	getHarmonizedIndexAnnualChanges()	Fetch all harmonized index annual changes data.
List<ResponseModel>	getHarmonizedIndexAnnualChanges(Collection<String> months)	Fetch all harmonized index annual changes data which match the input constraints.
List<ResponseModel>	getHarmonizedIndexMonthlyChanges()	Fetch all harmonized index monthly changes data.
List<ResponseModel>	getHarmonizedIndexMonthlyChanges(Collection<String> months)	Fetch all harmonized index monthly changes data which match the input constraints.
List<ResponseModel>	getHarmonizedIndexMonths()	Fetch all harmonized index months data.
List<ResponseModel>	getHarmonizedIndexMonths(Collection<String> months)	Fetch all harmonized index months data which match the input constraints.
List<ResponseModel>	getHarmonizedIndexYears()	Fetch all harmonized index years data.
List<ResponseModel>	getHarmonizedIndexYears(Collection<Integer> years)	Fetch all harmonized index years 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

PricesAndConsumptionCPIHICPClient

public PricesAndConsumptionCPIHICPClient()

Default constructor.

PricesAndConsumptionCPIHICPClient

public PricesAndConsumptionCPIHICPClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getHarmonizedIndexAnnualChanges

public List<ResponseModel> getHarmonizedIndexAnnualChanges()

Fetch all harmonized index annual changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getHarmonizedIndexAnnualChanges(Collection)

getHarmonizedIndexAnnualChanges

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

Fetch all harmonized index annual changes data which match the input constraints.

Parameters:

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getHarmonizedIndexMonthlyChanges

public List<ResponseModel> getHarmonizedIndexMonthlyChanges()

Fetch all harmonized index monthly changes data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getHarmonizedIndexMonthlyChanges(Collection)

getHarmonizedIndexMonthlyChanges

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

Fetch all harmonized index monthly changes data which match the input constraints.

Parameters:

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getHarmonizedIndexMonths

public List<ResponseModel> getHarmonizedIndexMonths()

Fetch all harmonized index months data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getHarmonizedIndexMonths(Collection)

getHarmonizedIndexMonths

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

Fetch all harmonized index months data which match the input constraints.

Parameters:

months - the months

Returns:

the data wrapped in a list of ResponseModel objects

getHarmonizedIndexYears

public List<ResponseModel> getHarmonizedIndexYears()

Fetch all harmonized index years data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getHarmonizedIndexYears(Collection)

getHarmonizedIndexYears

public List<ResponseModel> getHarmonizedIndexYears(Collection<Integer> years)

Fetch all harmonized index years data which match the input constraints.

Parameters:

years - the years

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