de.codengine.tankerkoenig.models.requests

Class StationListRequest

java.lang.Object

de.codengine.tankerkoenig.models.requests.StationListRequest

All Implemented Interfaces:

Request<StationListResult>

public final class StationListRequest
extends Object

Request to obtain a list of stations. The search is based around the coordinates, which are mandatory and must be in the specified boundaries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StationListRequest.SortingRequestType

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

Request.Method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
R	execute() Executes the request using the underlying Requester, which will return the requested result object
StationListRequest	setCoordinates(double lat, double lng) Sets the center of the search
StationListRequest	setGasRequestType(GasRequestType gasRequestType) Sets which gas prices should be requested, which can either be a specific one or ALL Default is: ALL
StationListRequest	setSearchRadius(double radius) Sets the search radius in Kilometers.
StationListRequest	setSorting(StationListRequest.SortingRequestType sorting) Sets the sorting for the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

StationListRequest

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

Method Detail

setCoordinates

public StationListRequest setCoordinates(double lat,
                                         double lng)

Sets the center of the search

Parameters:

lat - Must be between -90 and 90

lng - Must be between -180 and 180

setGasRequestType

public StationListRequest setGasRequestType(GasRequestType gasRequestType)

Sets which gas prices should be requested, which can either be a specific one or ALL

Default is: ALL

setSearchRadius

public StationListRequest setSearchRadius(double radius)

Sets the search radius in Kilometers. Default is: 5

Parameters:

radius - Must be between 1.0 and 25.0 km

Returns:

setSorting

public StationListRequest setSorting(StationListRequest.SortingRequestType sorting)

Sets the sorting for the results. Default is: DISTANCE

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