com.mapbox.mapboxsdk.style.sources

Class Source

java.lang.Object

com.mapbox.mapboxsdk.style.sources.Source

Direct Known Subclasses:

CustomGeometrySource, GeoJsonSource, ImageSource, RasterDemSource, RasterSource, UnknownSource, VectorSource

public abstract class Source
extends java.lang.Object

Base Peer class for sources. see source.hpp for the other half of the peer.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	detached

Constructor Summary

Constructors

Modifier	Constructor and Description
	Source()
protected	Source(long nativePtr) Internal use

Method Summary

Modifier and Type	Method and Description
protected void	checkThread() Validates if source interaction is happening on the UI thread
java.lang.String	getAttribution() Retrieve the source attribution.
java.lang.String	getId() Retrieve the source id
java.lang.Integer	getMaxOverscaleFactorForParentTiles() Retrieve current maximum overscale factor for parent tiles.
java.lang.Long	getMinimumTileUpdateInterval() Retrieve the minimum tile update interval, which is used to throttle the tile update network requests.
long	getNativePtr() Internal use
java.lang.Integer	getPrefetchZoomDelta() Retrieve current pre-fetching zoom delta.
java.lang.Boolean	isVolatile() Retrieve whether or not the fetched tiles for the given source should be stored in the local cache
protected java.lang.String	nativeGetAttribution()
protected java.lang.String	nativeGetId()
protected java.lang.Integer	nativeGetMaxOverscaleFactorForParentTiles()
protected java.lang.Long	nativeGetMinimumTileUpdateInterval()
protected java.lang.Integer	nativeGetPrefetchZoomDelta()
protected java.lang.Boolean	nativeIsVolatile()
protected void	nativeSetMaxOverscaleFactorForParentTiles(java.lang.Integer maxOverscaleFactor)
protected void	nativeSetMinimumTileUpdateInterval(java.lang.Long interval)
protected void	nativeSetPrefetchZoomDelta(java.lang.Integer delta)
protected void	nativeSetVolatile(java.lang.Boolean value)
void	setDetached()
void	setMaxOverscaleFactorForParentTiles(java.lang.Integer maxOverscaleFactor) When a set of tiles for a current zoom level is being rendered and some of the ideal tiles that cover the screen are not yet loaded, parent tile could be used instead.
void	setMinimumTileUpdateInterval(java.lang.Long interval) Sets the minimum tile update interval, which is used to throttle the tile update network requests.
void	setPrefetchZoomDelta(java.lang.Integer delta) Set the tile pre-fetching zoom delta for current source.
void	setVolatile(java.lang.Boolean value) Set a flag defining whether or not the fetched tiles for the given source should be stored in the local cache

Methods inherited from class java.lang.Object

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

Field Detail

detached

protected boolean detached

Constructor Detail

Source

protected Source(long nativePtr)

Internal use

Parameters:

nativePtr - - pointer to native peer

Source

public Source()

Method Detail

checkThread

protected void checkThread()

Validates if source interaction is happening on the UI thread

getId

@NonNull
public java.lang.String getId()

Retrieve the source id

Returns:

the source id

getAttribution

@NonNull
public java.lang.String getAttribution()

Retrieve the source attribution.

Will return an empty String if no attribution is available.

Returns:

the string representation of the attribution in html format

getPrefetchZoomDelta

@Nullable
public java.lang.Integer getPrefetchZoomDelta()

Retrieve current pre-fetching zoom delta.

Returns:

current zoom delta or null if not set.

setPrefetchZoomDelta

public void setPrefetchZoomDelta(@Nullable
                                 java.lang.Integer delta)

Set the tile pre-fetching zoom delta for current source. Pre-fetching makes sure that a low-resolution tile at the (current_zoom_level - delta) is rendered as soon as possible at the expense of a little bandwidth. If delta has not been set or set to null, it will use the value in MapboxMap instance.

Parameters:

delta - zoom delta

setMaxOverscaleFactorForParentTiles

public void setMaxOverscaleFactorForParentTiles(@Nullable
                                                java.lang.Integer maxOverscaleFactor)

When a set of tiles for a current zoom level is being rendered and some of the ideal tiles that cover the screen are not yet loaded, parent tile could be used instead. This might introduce unwanted rendering side-effects, especially for raster tiles that are overscaled multiple times. This method sets the maximum limit for how much a parent tile can be overscaled.

Parameters:

maxOverscaleFactor - maximum overscale factor

getMaxOverscaleFactorForParentTiles

@Nullable
public java.lang.Integer getMaxOverscaleFactorForParentTiles()

Retrieve current maximum overscale factor for parent tiles.

Returns:

current maximum overscale factor or null if not set.

isVolatile

@NonNull
public java.lang.Boolean isVolatile()

Retrieve whether or not the fetched tiles for the given source should be stored in the local cache

Returns:

true if tiles are volatile, false if they will be stored in local cache. Default value is false.

setVolatile

public void setVolatile(java.lang.Boolean value)

Set a flag defining whether or not the fetched tiles for the given source should be stored in the local cache

Parameters:

value - current setting for volatile.

setMinimumTileUpdateInterval

public void setMinimumTileUpdateInterval(java.lang.Long interval)

Sets the minimum tile update interval, which is used to throttle the tile update network requests.

Parameters:

interval - the update interval in milliseconds.

getMinimumTileUpdateInterval

@NonNull
public java.lang.Long getMinimumTileUpdateInterval()

Retrieve the minimum tile update interval, which is used to throttle the tile update network requests.

Returns:

the update interval in milliseconds, default valuse is 0.

getNativePtr

public long getNativePtr()

Internal use

Returns:

the native peer pointer

nativeGetId

@NonNull
protected java.lang.String nativeGetId()

nativeGetAttribution

@NonNull
protected java.lang.String nativeGetAttribution()

nativeGetPrefetchZoomDelta

@NonNull
protected java.lang.Integer nativeGetPrefetchZoomDelta()

nativeSetPrefetchZoomDelta

@NonNull
protected void nativeSetPrefetchZoomDelta(java.lang.Integer delta)

nativeSetMaxOverscaleFactorForParentTiles

@NonNull
protected void nativeSetMaxOverscaleFactorForParentTiles(java.lang.Integer maxOverscaleFactor)

nativeGetMaxOverscaleFactorForParentTiles

@NonNull
protected java.lang.Integer nativeGetMaxOverscaleFactorForParentTiles()

nativeIsVolatile

@NonNull
protected java.lang.Boolean nativeIsVolatile()

nativeSetVolatile

@NonNull
protected void nativeSetVolatile(java.lang.Boolean value)

nativeSetMinimumTileUpdateInterval

@NonNull
protected void nativeSetMinimumTileUpdateInterval(java.lang.Long interval)

nativeGetMinimumTileUpdateInterval

@NonNull
protected java.lang.Long nativeGetMinimumTileUpdateInterval()

setDetached

public void setDetached()