Jump to Content

Interface TileSource

TileSource (API Reference)

All Known Subinterfaces:

LineTileSource, PointTileSource, PolygonTileSource, RasterTileSource
```
public interface TileSource
```
A source of tiles. The implementations must be thread-safe.
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`TileSource.DataVersion`	Tile data version.
`static interface`	`TileSource.Listener`	Listener of `TileSource` events.
`static interface`	`TileSource.LoadTileRequestHandle`	Handle of a load request.
`static class`	`TileSource.TileMetadata`	Tile metadata.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addListener(TileSource.Listener listener)`	Adds a listener for receiving state notifications.
`TileSource.DataVersion`	`getDataVersion(TileKey tileKey)`	Gets the current data version of a tile.
`java.util.List<java.lang.Integer>`	`getStorageLevels()`	Gets the storage levels available for this data source.
`TilingScheme`	`getTilingScheme()`	Gets the tiling scheme used by this source.
`void`	`removeListener(TileSource.Listener listener)`	Removes a listener from receiving state notifications.

- Method Detail
  - getDataVersion
```
@NonNull
TileSource.DataVersion getDataVersion(@NonNull
                                      TileKey tileKey)
```
    Gets the current data version of a tile.
    
    Parameters:
    
    tileKey -
    Key of the tile for which to retrieve the version.
    
    Returns:
    
    Data version for a tile.
  - addListener
```
void addListener(@NonNull
                 TileSource.Listener listener)
```
    Adds a listener for receiving state notifications.
    
    Parameters:
    
    listener -
    The listener
  - removeListener
```
void removeListener(@NonNull
                    TileSource.Listener listener)
```
    Removes a listener from receiving state notifications.
    
    Parameters:
    
    listener -
    Listener to be removed from receiving state notifications.
  - getTilingScheme
```
@NonNull
TilingScheme getTilingScheme()
```
    Gets the tiling scheme used by this source.
    
    Returns:
    
    The tiling scheme used by this source.
  - getStorageLevels
```
@NonNull
java.util.List<java.lang.Integer> getStorageLevels()
```
    Gets the storage levels available for this data source. Supported range [0, 31].
    At least one level must be available for this to be used as a source of data.
    
    Returns:
    
    The storage levels available for this data source. Supported range [0, 31].