Index (Tankerkoenig API 1.0 API)

A B C D E F G H I J L O P R S T V W

A

addId(String) - Method in class de.codengine.tankerkoenig.models.requests.PricesRequest: Adds a station id.
addIds(String...) - Method in class de.codengine.tankerkoenig.models.requests.PricesRequest: Adds multiple station ids.
addIds(Collection<String>) - Method in class de.codengine.tankerkoenig.models.requests.PricesRequest: Adds multiple station ids.
ApiBuilder() - Constructor for class de.codengine.tankerkoenig.Tankerkoenig.ApiBuilder: Creates a new API builder instances

B

build() - Method in class de.codengine.tankerkoenig.Tankerkoenig.ApiBuilder: Builds the final API instance.
buildDefaultClientExecutor() - Method in interface de.codengine.tankerkoenig.client.ClientExecutorFactory: Builds the default ClientExecutor
buildDefaultClientExecutor() - Method in class de.codengine.tankerkoenig.client.ClientExecutorFactoryImpl: Builds the default ClientExecutor, which currently wraps OkHttpClient

C

ClientExecutor - Interface in de.codengine.tankerkoenig.client: Executes requests that are built from the Requester and originate in the Request
ClientExecutorException - Exception in de.codengine.tankerkoenig.exception: Exceptions thrown if an error at a ClientExecutor occurs
ClientExecutorException(String, String, Throwable) - Constructor for exception de.codengine.tankerkoenig.exception.ClientExecutorException
ClientExecutorException(String, String) - Constructor for exception de.codengine.tankerkoenig.exception.ClientExecutorException
ClientExecutorFactory - Interface in de.codengine.tankerkoenig.client: Factory for ClientExecutors
ClientExecutorFactoryImpl - Class in de.codengine.tankerkoenig.client: Default ClientExecutor factory for client executors
correction(String, CorrectionRequest.Type) - Method in class de.codengine.tankerkoenig.Tankerkoenig.Api: Builds a station correction request
CorrectionRequest - Class in de.codengine.tankerkoenig.models.requests: Request for station data corrections.
CorrectionRequest(String, String, Requester, CorrectionRequest.Type) - Constructor for class de.codengine.tankerkoenig.models.requests.CorrectionRequest
CorrectionRequest.Type - Enum in de.codengine.tankerkoenig.models.requests: The type of the correction request
CorrectionResult - Class in de.codengine.tankerkoenig.models.requests: Result of CorrectionRequest.
CorrectionResult() - Constructor for class de.codengine.tankerkoenig.models.requests.CorrectionResult

D

de.codengine.tankerkoenig - package de.codengine.tankerkoenig
de.codengine.tankerkoenig.client - package de.codengine.tankerkoenig.client
de.codengine.tankerkoenig.exception - package de.codengine.tankerkoenig.exception
de.codengine.tankerkoenig.models.mapper - package de.codengine.tankerkoenig.models.mapper
de.codengine.tankerkoenig.models.requests - package de.codengine.tankerkoenig.models.requests
detail(String) - Method in class de.codengine.tankerkoenig.Tankerkoenig.Api: Builds a station detail request.

E

equals(Object) - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime
equals(Object) - Method in class de.codengine.tankerkoenig.models.mapper.Station
execute() - Method in interface de.codengine.tankerkoenig.models.requests.Request

F

fromJson(String, Class<T>) - Method in class de.codengine.tankerkoenig.models.mapper.GsonMapper: Converts the supplied JSON string to the result class
fromJson(String, Class<T>) - Method in interface de.codengine.tankerkoenig.models.mapper.JsonMapper

G

GasPrices - Class in de.codengine.tankerkoenig.models.mapper: A list of Gas Prices which depends on the requested gas price types.
GasPrices.GasType - Enum in de.codengine.tankerkoenig.models.mapper: A set of requestable gas types
GasPrices.Status - Enum in de.codengine.tankerkoenig.models.mapper: A set of possible status flags of the station
GasRequestType - Enum in de.codengine.tankerkoenig.models.requests: Defines which price data should be requested, which is either specific (DIESEL, E5, E10) or ALL (*)
get(String, Map<String, Object>) - Method in interface de.codengine.tankerkoenig.client.ClientExecutor: Executes a GET request
get(String, Map<String, Object>) - Method in class de.codengine.tankerkoenig.client.OkHttp3ClientExecutor: Builds the final URL using the supplied url, appends query parameters and executes the request
getBrand() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns the stations brand.
getCity() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the city of the Station
getData() - Method in interface de.codengine.tankerkoenig.models.requests.Result
getDays() - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime: Returns the unmodifyable set of days of the week for that the times are valid
getDistance() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the distance to the position which is passed to the StationListRequest.
getEnd() - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime: Returns the end time, which (unreliably) is in the format HH:MM:ss
getGasPrice(String) - Method in class de.codengine.tankerkoenig.models.requests.PricesResult: Will return the gas prices for a station, defined by the Station ID.
getGasPrices() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns the stations gas prices.
getGasPrices() - Method in class de.codengine.tankerkoenig.models.requests.PricesResult: Will return an unmodifyable map of gas prices, which uses the Station ID as key
getHouseNumber() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the house number of the Station.
getId() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns the stations unique ID
getInstance() - Static method in class de.codengine.tankerkoenig.client.ClientExecutorFactoryImpl: Returns the factory instance
getInstance() - Static method in class de.codengine.tankerkoenig.models.mapper.GsonMapper
getLat() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the latitude of the Station
getLicense() - Method in interface de.codengine.tankerkoenig.models.requests.Result
getLng() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the longitude of the Station
getLocation() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns the stations location data
getMessage() - Method in interface de.codengine.tankerkoenig.models.requests.Result
getName() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns the stations name
getOpeningTimes() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns an unmodifyable list of opening times for the station.
getOverridingOpeningTimes() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns an unmodifyable list of overriding opening times for the station.
getPrice(GasPrices.GasType) - Method in class de.codengine.tankerkoenig.models.mapper.GasPrices: Returns the gas price, if available
getPrice() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Returns the gas price for the requested GasRequestType.
getStart() - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime: Returns the start time, which (unreliably) is in the format HH:MM:ss
getState() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the state of the Station.
getStation() - Method in class de.codengine.tankerkoenig.models.requests.StationDetailResult: Returns the station, which is null in case of an error
getStations() - Method in class de.codengine.tankerkoenig.models.requests.StationListResult: Returns an unmodifyable list of stations, which might be empty
getStatus() - Method in class de.codengine.tankerkoenig.models.mapper.GasPrices: Returns the stations status / availability.
getStatus() - Method in interface de.codengine.tankerkoenig.models.requests.Result
getStreetName() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the street name of the Station
getText() - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime: Returns the original string of the opening time, which is useful in case there was an error parsing the opening time the regular way
getUrl() - Method in exception de.codengine.tankerkoenig.exception.ClientExecutorException: Returns the URL of the call where the exception occured
getZipCode() - Method in class de.codengine.tankerkoenig.models.mapper.Location: Returns the zip code of the Station
GsonMapper - Class in de.codengine.tankerkoenig.models.mapper: Default JSON Mapper which utilizes Gson

H

hashCode() - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime
hashCode() - Method in class de.codengine.tankerkoenig.models.mapper.Station
hasPrice(GasPrices.GasType) - Method in class de.codengine.tankerkoenig.models.mapper.GasPrices: Determines if a gas price of a certain type is available
hasPrices() - Method in class de.codengine.tankerkoenig.models.mapper.GasPrices: Determines if any price is available

I

includesHolidays() - Method in class de.codengine.tankerkoenig.models.mapper.OpeningTime: Defines if the opening time includes holidays
isOk() - Method in interface de.codengine.tankerkoenig.models.requests.Result
isOpen() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Determines whether the station is open
isWholeDay() - Method in class de.codengine.tankerkoenig.models.mapper.Station: Defines if the station is opened the whole day.

J

JsonMapper - Interface in de.codengine.tankerkoenig.models.mapper: A JSON Mapper which simply converts a string to an object

L

list(double, double) - Method in class de.codengine.tankerkoenig.Tankerkoenig.Api: Builds a station list request.
Location - Class in de.codengine.tankerkoenig.models.mapper: Represents the location of a Station.

O

OkHttp3ClientExecutor - Class in de.codengine.tankerkoenig.client: Client Executor which wraps around OkHttpClient
OkHttp3ClientExecutor(OkHttpClient) - Constructor for class de.codengine.tankerkoenig.client.OkHttp3ClientExecutor
OpeningTime - Class in de.codengine.tankerkoenig.models.mapper: Represents the opening times of a Station Each OpeningTime represents a day range for that a specific time is valid.

P

post(String, Map<String, Object>) - Method in interface de.codengine.tankerkoenig.client.ClientExecutor: Executes a POST request.
post(String, Map<String, Object>) - Method in class de.codengine.tankerkoenig.client.OkHttp3ClientExecutor: Builds the form body and executes the request
prices() - Method in class de.codengine.tankerkoenig.Tankerkoenig.Api: Builds a prices search request
PricesRequest - Class in de.codengine.tankerkoenig.models.requests: Request for gas prices.
PricesRequest(String, String, Requester) - Constructor for class de.codengine.tankerkoenig.models.requests.PricesRequest
PricesResult - Class in de.codengine.tankerkoenig.models.requests: Result of PricesRequest.
PricesResult() - Constructor for class de.codengine.tankerkoenig.models.requests.PricesResult

R

Request<R extends Result> - Interface in de.codengine.tankerkoenig.models.requests
Request.Method - Enum in de.codengine.tankerkoenig.models.requests
Requester - Class in de.codengine.tankerkoenig.models.requests: The requester is responsible for the execution of the request and mapping the result to the specified result class Recoverable failures will be wrapped by an RequesterException
Requester(ClientExecutor, JsonMapper) - Constructor for class de.codengine.tankerkoenig.models.requests.Requester
RequesterException - Exception in de.codengine.tankerkoenig.exception: Exceptions thrown by a Requester when the request execution of the underlying ClientExecutor failed
RequesterException(String, Throwable) - Constructor for exception de.codengine.tankerkoenig.exception.RequesterException
RequestParamException - Exception in de.codengine.tankerkoenig.exception: Exceptions thrown if any request parameter fails validation
RequestParamException(String, Object...) - Constructor for exception de.codengine.tankerkoenig.exception.RequestParamException
requiresCorrectionValue() - Method in enum de.codengine.tankerkoenig.models.requests.CorrectionRequest.Type: Determines if the correction type requires a correction value
ResponseParsingException - Exception in de.codengine.tankerkoenig.exception: Exception thrown by a JSON Mapper if the supplied response body could not be parsed
ResponseParsingException(String, String) - Constructor for exception de.codengine.tankerkoenig.exception.ResponseParsingException
Result - Interface in de.codengine.tankerkoenig.models.requests
Result.ResponseStatus - Enum in de.codengine.tankerkoenig.models.requests

S

setCoordinates(double, double) - Method in class de.codengine.tankerkoenig.models.requests.StationListRequest: Sets the center of the search
setCorrectionValue(String) - Method in class de.codengine.tankerkoenig.models.requests.CorrectionRequest: Sets the corrected value for the correction request.
setGasRequestType(GasRequestType) - Method in class de.codengine.tankerkoenig.models.requests.StationListRequest: Sets which gas prices should be requested, which can either be a specific one or ALL Default is: ALL
setSearchRadius(double) - Method in class de.codengine.tankerkoenig.models.requests.StationListRequest: Sets the search radius in Kilometers.
setSorting(StationListRequest.SortingRequestType) - Method in class de.codengine.tankerkoenig.models.requests.StationListRequest: Sets the sorting for the results.
setStationId(String) - Method in class de.codengine.tankerkoenig.models.requests.CorrectionRequest: Sets the station ID for the correction request.
State - Enum in de.codengine.tankerkoenig.models.mapper
Station - Class in de.codengine.tankerkoenig.models.mapper: Represents the station.
StationDetailRequest - Class in de.codengine.tankerkoenig.models.requests: Request to obtain detail information for a station, specified by the stations unique ID which is obtainable using the StationListRequest
StationDetailRequest(String, String, Requester, String) - Constructor for class de.codengine.tankerkoenig.models.requests.StationDetailRequest
StationDetailResult - Class in de.codengine.tankerkoenig.models.requests: Result of StationDetailRequest.
StationDetailResult() - Constructor for class de.codengine.tankerkoenig.models.requests.StationDetailResult
StationListRequest - Class in de.codengine.tankerkoenig.models.requests: Request to obtain a list of stations.
StationListRequest(String, String, Requester) - Constructor for class de.codengine.tankerkoenig.models.requests.StationListRequest
StationListRequest.SortingRequestType - Enum in de.codengine.tankerkoenig.models.requests
StationListResult - Class in de.codengine.tankerkoenig.models.requests: Result of StationListRequest.
StationListResult() - Constructor for class de.codengine.tankerkoenig.models.requests.StationListResult

T

Tankerkoenig - Class in de.codengine.tankerkoenig: Entry point for creation of the Tankerkoenig API instance.
Tankerkoenig.Api - Class in de.codengine.tankerkoenig: The Tankerkoenig API, which will build the requests
Tankerkoenig.ApiBuilder - Class in de.codengine.tankerkoenig: Builder for an API instance
toQueryParam() - Method in enum de.codengine.tankerkoenig.models.requests.CorrectionRequest.Type
toQueryParam() - Method in enum de.codengine.tankerkoenig.models.requests.GasRequestType
toQueryParam() - Method in enum de.codengine.tankerkoenig.models.requests.StationListRequest.SortingRequestType

V

valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.mapper.GasPrices.GasType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.mapper.GasPrices.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.mapper.State: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.requests.CorrectionRequest.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.requests.GasRequestType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.requests.Request.Method: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.requests.Result.ResponseStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.codengine.tankerkoenig.models.requests.StationListRequest.SortingRequestType: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.codengine.tankerkoenig.models.mapper.GasPrices.GasType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.mapper.GasPrices.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.mapper.State: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.requests.CorrectionRequest.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.requests.GasRequestType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.requests.Request.Method: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.requests.Result.ResponseStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.codengine.tankerkoenig.models.requests.StationListRequest.SortingRequestType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withApiKey(String) - Method in class de.codengine.tankerkoenig.Tankerkoenig.ApiBuilder: Sets the personal API key
withClientExecutor(ClientExecutor) - Method in class de.codengine.tankerkoenig.Tankerkoenig.ApiBuilder: Uses the specified client executor
withDefaultClientExecutor() - Method in class de.codengine.tankerkoenig.Tankerkoenig.ApiBuilder: Uses the default client executor
withDemoApiKey() - Method in class de.codengine.tankerkoenig.Tankerkoenig.ApiBuilder: Sets the API Key to the default key as defined on the official website

A B C D E F G H I J L O P R S T V W