de.codengine.tankerkoenig.models.mapper

Class Station

java.lang.Object

de.codengine.tankerkoenig.models.mapper.Station

public final class Station
extends Object

Represents the station. The station data is used for multiple results and therefore does not always contain each information / field available.

If the station is closed (isOpen = false), no gas prices will be available.

Price information are pretty reliable, but most of the String fields are not as they are provided uncontrolled by the gas stations.

Therefore, the name and brand data might not be consistent. E.g., "JET" can also be returned as "Jet" or "jet".

Fields that are not available all time will be wrapped in Optional.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<String>	getBrand() Returns the stations brand.
Optional<GasPrices>	getGasPrices() Returns the stations gas prices.
String	getId() Returns the stations unique ID
Location	getLocation() Returns the stations location data
Optional<String>	getName() Returns the stations name
Optional<List<OpeningTime>>	getOpeningTimes() Returns an unmodifyable list of opening times for the station.
Optional<List<String>>	getOverridingOpeningTimes() Returns an unmodifyable list of overriding opening times for the station.
Optional<Float>	getPrice() Returns the gas price for the requested GasRequestType.
int	hashCode()
boolean	isOpen() Determines whether the station is open
Optional<Boolean>	isWholeDay() Defines if the station is opened the whole day.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public Optional<String> getName()

Returns the stations name

getId

public String getId()

Returns the stations unique ID

getLocation

public Location getLocation()

Returns the stations location data

getBrand

public Optional<String> getBrand()

Returns the stations brand.

Sometimes this information is not available, which is mostly the case for gas stations in private ownership.

isOpen

public boolean isOpen()

Determines whether the station is open

getGasPrices

public Optional<GasPrices> getGasPrices()

Returns the stations gas prices.

Will only be available with StationListRequest if GasRequestType is set to ALL, or StationDetailRequest

getOpeningTimes

public Optional<List<OpeningTime>> getOpeningTimes()

Returns an unmodifyable list of opening times for the station. Will contain zero to an unlimited count of entries

Will only be available with StationDetailResult

getOverridingOpeningTimes

public Optional<List<String>> getOverridingOpeningTimes()

Returns an unmodifyable list of overriding opening times for the station. Those are arbitrary strings without any specific structure which define temporary changes of opening times

Will only be available with StationDetailResult

isWholeDay

public Optional<Boolean> isWholeDay()

Defines if the station is opened the whole day. Not Present is equivalent to "false"

getPrice

public Optional<Float> getPrice()

Returns the gas price for the requested GasRequestType.

Will only be available with StationListRequest if GasRequestType is set to E5, E10 or DIESEL

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object