org.codetome.hexameter.core.api.contract

Interface HexagonDataStorage<T extends SatelliteData>

Type Parameters:

T - the type of the stored SatelliteData implementation

All Known Implementing Classes:

DefaultHexagonDataStorage

public interface HexagonDataStorage<T extends SatelliteData>

This interface represents all storage operations which are needed for a working HexagonalGrid.

Method Summary

Modifier and Type	Method and Description
void	addCoordinate(CubeCoordinate cubeCoordinate) Adds a CubeCoordinate for this grid without any SatelliteData.
boolean	addCoordinate(CubeCoordinate cubeCoordinate, T satelliteData) Adds a CubeCoordinate for this grid with SatelliteData.
boolean	clearDataFor(CubeCoordinate cubeCoordinate) Clears the SatelliteData for the given CubeCoordinate.
boolean	containsCoordinate(CubeCoordinate cubeCoordinate) Tells whether there is a Hexagon on the given CubeCoordinate or not.
rx.Observable<CubeCoordinate>	getCoordinates() Returns all coordinates which are stored in this object.
Optional<T>	getSatelliteDataBy(CubeCoordinate cubeCoordinate) Gets the SatelliteData stored on a CubeCoordinate if present.
boolean	hasDataFor(CubeCoordinate cubeCoordinate) Tells whether there is SatelliteData stored for a CubeCoordinate or not.

Method Detail

addCoordinate

void addCoordinate(CubeCoordinate cubeCoordinate)

Adds a CubeCoordinate for this grid without any SatelliteData. Does not overwrite the coordinate if it is already present.

addCoordinate

boolean addCoordinate(CubeCoordinate cubeCoordinate,
                      T satelliteData)

Adds a CubeCoordinate for this grid with SatelliteData. Overwrites previous SatelliteData if it was present.

Returns:

true if overwrote data false otherwise.

getSatelliteDataBy

Optional<T> getSatelliteDataBy(CubeCoordinate cubeCoordinate)

Gets the SatelliteData stored on a CubeCoordinate if present. Also returns empty Optional when cubeCoordinate is not present.

Returns:

optional SatelliteData.

containsCoordinate

boolean containsCoordinate(CubeCoordinate cubeCoordinate)

Tells whether there is a Hexagon on the given CubeCoordinate or not.

Returns:

true if present false if not

hasDataFor

boolean hasDataFor(CubeCoordinate cubeCoordinate)

Tells whether there is SatelliteData stored for a CubeCoordinate or not. Also returns false if cubeCoordinate is not present in the storage.

getCoordinates

rx.Observable<CubeCoordinate> getCoordinates()

Returns all coordinates which are stored in this object.

clearDataFor

boolean clearDataFor(CubeCoordinate cubeCoordinate)

Clears the SatelliteData for the given CubeCoordinate.

Returns:

true if the storage was changed false otherwise.