com.mapbox.mapboxsdk.offline

Class CacheAreaDefinition

java.lang.Object

com.mapbox.mapboxsdk.offline.CacheAreaDefinition

All Implemented Interfaces:

android.os.Parcelable

public class CacheAreaDefinition
extends java.lang.Object
implements android.os.Parcelable

A cache area defined by a style URL, an array of LatLngBoundsZoom, and device pixel ratio.

pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.

if includeIdeographs is false, offline region will not include CJK glyphs

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CacheAreaDefinition(android.os.Parcel parcel) Constructor to create an CacheAreaDefinition from a Parcel.
CacheAreaDefinition(java.lang.String styleURL, LatLngBoundsZoom[] boundsZoomList, float pixelRatio) Constructor to create an CacheAreaDefinition from parameters.
CacheAreaDefinition(java.lang.String styleURL, LatLngBoundsZoom[] boundsZoomList, float pixelRatio, boolean includeIdeographs) Constructor to create an CacheAreaDefinition from parameters.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	getIncludeIdeographs()
float	getPixelRatio()
java.lang.String	getStyleURL()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

CacheAreaDefinition

public CacheAreaDefinition(java.lang.String styleURL,
                           LatLngBoundsZoom[] boundsZoomList,
                           float pixelRatio)

Constructor to create an CacheAreaDefinition from parameters.

Parameters:

styleURL - the style

boundsZoomList - the boundsZoomList

pixelRatio - pixel ratio of the device

CacheAreaDefinition

public CacheAreaDefinition(java.lang.String styleURL,
                           LatLngBoundsZoom[] boundsZoomList,
                           float pixelRatio,
                           boolean includeIdeographs)

Constructor to create an CacheAreaDefinition from parameters.

Parameters:

styleURL - the style

boundsZoomList - the boundsZoomList

pixelRatio - pixel ratio of the device

includeIdeographs - include glyphs for CJK languages

CacheAreaDefinition

public CacheAreaDefinition(android.os.Parcel parcel)

Constructor to create an CacheAreaDefinition from a Parcel.

Parameters:

parcel - the parcel to create the CacheAreaDefinition from

Method Detail

getStyleURL

public java.lang.String getStyleURL()

getPixelRatio

public float getPixelRatio()

getIncludeIdeographs

public boolean getIncludeIdeographs()

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable