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
long	getNativePtr() Internal use
java.lang.Integer	getPrefetchZoomDelta() Retrieve current pre-fetching zoom delta.
protected java.lang.String	nativeGetAttribution()
protected java.lang.String	nativeGetId()
protected java.lang.Integer	nativeGetPrefetchZoomDelta()
protected void	nativeSetPrefetchZoomDelta(java.lang.Integer delta)
void	setDetached()
void	setPrefetchZoomDelta(java.lang.Integer delta) Set the tile pre-fetching zoom delta for current source.

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

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)

setDetached

public void setDetached()