de.codengine.tankerkoenig.models.requests

Class PricesRequest

java.lang.Object

de.codengine.tankerkoenig.models.requests.PricesRequest

All Implemented Interfaces:

Request<PricesResult>

public final class PricesRequest
extends Object

Request for gas prices. Between 1 and 10 station IDs can and must be supplied, or the request will fail.

Nested Class Summary

Nested classes/interfaces inherited from interface de.codengine.tankerkoenig.models.requests.Request

Request.Method

Constructor Summary

Constructors

Constructor and Description
PricesRequest(String apiKey, String baseUrl, Requester requester)

Method Summary

Modifier and Type	Method and Description
PricesRequest	addId(String stationId) Adds a station id.
PricesRequest	addIds(Collection<String> stationIds) Adds multiple station ids.
PricesRequest	addIds(String... stationIds) Adds multiple station ids.
R	execute() Executes the request using the underlying Requester, which will return the requested result object

Methods inherited from class java.lang.Object

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

Constructor Detail

PricesRequest

public PricesRequest(String apiKey,
                     String baseUrl,
                     Requester requester)

Method Detail

addId

public PricesRequest addId(String stationId)

Adds a station id. Will only be added if not null nor empty.

A maximum of 10 IDs is allowed and IDs are getting added uniquely

addIds

public PricesRequest addIds(String... stationIds)

Adds multiple station ids. Will only be added if not null nor empty.

A maximum of 10 IDs is allowed and IDs are getting added uniquely

addIds

public PricesRequest addIds(Collection<String> stationIds)

Adds multiple station ids. Will only be added if not null nor empty.

A maximum of 10 IDs is allowed and IDs are getting added uniquely

execute

public final R execute()
                throws RequesterException

Executes the request using the underlying Requester, which will return the requested result object

Specified by:

execute in interface Request<R extends Result>

Throws:

RequesterException - Checked Exceptions that might be thrown during request execution