com.github.dannil.scbjavaclient.client.financialmarkets.statistics.keyfigures

Class FinancialMarketsStatisticsKeyFiguresClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.financialmarkets.statistics.keyfigures.FinancialMarketsStatisticsKeyFiguresClient

public class FinancialMarketsStatisticsKeyFiguresClient
extends AbstractClient

Client which handles financial markets statistics key figures data fetching.

Since:

0.5.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getKeyFigures() Fetch all key figures data.
List<ResponseModel>	getKeyFigures(Collection<String> keyFigures, Collection<String> months) Fetch all key figures 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

FinancialMarketsStatisticsKeyFiguresClient

public FinancialMarketsStatisticsKeyFiguresClient()

Default constructor.

FinancialMarketsStatisticsKeyFiguresClient

public FinancialMarketsStatisticsKeyFiguresClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getKeyFigures

public List<ResponseModel> getKeyFigures()

Fetch all key figures data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getKeyFigures(Collection, Collection)

getKeyFigures

public List<ResponseModel> getKeyFigures(Collection<String> keyFigures,
                                         Collection<String> months)

Fetch all key figures data which match the input constraints.

Parameters:

keyFigures - the key figures

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