com.github.dannil.scbjavaclient.client.population.statistics.adoptees

Class PopulationStatisticsAdopteesClient

java.lang.Object

com.github.dannil.scbjavaclient.client.AbstractClient

com.github.dannil.scbjavaclient.client.population.statistics.adoptees.PopulationStatisticsAdopteesClient

public class PopulationStatisticsAdopteesClient
extends AbstractClient

Client which handles population statistics adoptees data fetching.

Since:

0.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<ResponseModel>	getAdoptions() Fetch all adoptions data.
List<ResponseModel>	getAdoptions(Collection<String> sexes, Collection<Integer> yearsOfBirths, Collection<Integer> years) Fetch all adoptions 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

PopulationStatisticsAdopteesClient

public PopulationStatisticsAdopteesClient()

Default constructor.

PopulationStatisticsAdopteesClient

public PopulationStatisticsAdopteesClient(Locale locale)

Overloaded constructor.

Parameters:

locale - the Locale for this client

Method Detail

getAdoptions

public List<ResponseModel> getAdoptions()

Fetch all adoptions data.

Returns:

the data wrapped in a list of ResponseModel objects

See Also:

getAdoptions(Collection, Collection, Collection)

getAdoptions

public List<ResponseModel> getAdoptions(Collection<String> sexes,
                                        Collection<Integer> yearsOfBirths,
                                        Collection<Integer> years)

Fetch all adoptions data which match the input constraints.

Parameters:

sexes - the sexes

yearsOfBirths - the years of births

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