com.github.dannil.scbjavaclient.client

Class AbstractContainerClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.AbstractContainerClient

Direct Known Subclasses:

AgricultureClient, BusinessActivitiesAccomodationStatisticsClient, BusinessActivitiesClient, BusinessActivitiesIndustrialCapacityUtilizationClient, BusinessActivitiesIndustrialInventoriesClient, BusinessActivitiesInvestmentSurveyClient, BusinessActivitiesNonProfitOrganizationsClient, BusinessActivitiesOrdersAndTurnoverClient, EducationAndResearchClient, EducationAndResearchCommunityInnovationSurveyClient, EnergyClient, EnvironmentClient, EnvironmentLandUseClient, EnvironmentLocalitiesAreasAndPopulationClient, EnvironmentProtectedNatureClient, EnvironmentSEEAClient, EnvironmentShorelineLandUseClient, FinancialMarketsBalanceOfPaymentsClient, FinancialMarketsClient, FinancialMarketsStatisticsClient, GoodsAndServicesClient, GoodsAndServicesForeignTradeGoodsClient, GoodsAndServicesTurnoverServiceSectorClient, LabourMarketClient, LabourMarketGrossPayClient, LabourMarketShortTermEmploymentClient, LivingConditionsClient, LivingConditionsFamiliesClient, LivingConditionsSurveysClient, PopulationClient, PopulationNameClient, PopulationProjectionsClient, PopulationStatisticsClient, PricesAndConsumptionCCIClient, PricesAndConsumptionClient, PricesAndConsumptionCPIClient, PricesAndConsumptionPPIClient, PublicFinancesAnnualAccountsClient, PublicFinancesClient, SCBClient, TransportClient, TransportRegisteredVehiclesClient

public abstract class AbstractContainerClient
extends AbstractClient

Abstract class which specifies how methods by container clients (a client that has sub-clients) should operate.

Since:

0.0.2

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractContainerClient() Default constructor.
protected	AbstractContainerClient(Locale locale) Overloaded constructor.

Method Summary

Modifier and Type	Method and Description
void	addClient(String key, AbstractClient client) Add a sub-client to this client.
AbstractClient	getClient(String key) Get a sub-client from this client.
void	setLocale(Locale locale) Set the Locale for all sub-clients.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractContainerClient

protected AbstractContainerClient()

Default constructor.

AbstractContainerClient

protected AbstractContainerClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

setLocale

public final void setLocale(Locale locale)

Set the Locale for all sub-clients.

Overrides:

setLocale in class AbstractClient

Parameters:

locale - the Locale for this client

addClient

public void addClient(String key,
                      AbstractClient client)

Add a sub-client to this client.

Parameters:

key - the key

client - the client

Throws:

IllegalArgumentException - if this client adds itself as a sub-client, such that the expression this == client is true

getClient

public AbstractClient getClient(String key)

Get a sub-client from this client.

Parameters:

key - the key

Returns:

a client which is mapped to this key