com.mapbox.mapboxsdk.offline

Class OfflineRegionStatus

java.lang.Object

com.mapbox.mapboxsdk.offline.OfflineRegionStatus

public class OfflineRegionStatus
extends java.lang.Object

A region's status includes its active/inactive state as well as counts of the number of resources that have completed downloading, their total size in bytes, and the total number of resources that are required.

Note that the total required size in bytes is not currently available. A future API release may provide an estimate of this number.

Method Summary

Modifier and Type	Method and Description
long	getCompletedResourceCount() Get the number of resources (inclusive of tiles) that have been fully downloaded and are ready for offline access.
long	getCompletedResourceSize() The cumulative size, in bytes, of all resources (inclusive of tiles) that have been fully downloaded.
long	getCompletedTileCount() Get the number of tiles that have been fully downloaded and are ready for offline access.
long	getCompletedTileSize() Get the cumulative size, in bytes, of all tiles that have been fully downloaded.
int	getDownloadState() Returns the download state.
long	getRequiredResourceCount() Get the number of resources that are known to be required for this region.
boolean	isComplete() Validates if the region download has completed
boolean	isRequiredResourceCountPrecise() Returns when the value of requiredResourceCount is a precise count of the number of required resources, and false when it is merely a lower bound.

Methods inherited from class java.lang.Object

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

Method Detail

isComplete

public boolean isComplete()

Validates if the region download has completed

Returns:

true if download is complete, false if not

getDownloadState

public int getDownloadState()

Returns the download state.

State is defined as

• OfflineRegion.STATE_ACTIVE
• OfflineRegion.STATE_INACTIVE

Returns:

the download state.

getCompletedResourceCount

public long getCompletedResourceCount()

Get the number of resources (inclusive of tiles) that have been fully downloaded and are ready for offline access.

Returns:

the amount of resources that have finished downloading.

getCompletedResourceSize

public long getCompletedResourceSize()

The cumulative size, in bytes, of all resources (inclusive of tiles) that have been fully downloaded.

Returns:

the size of the resources that have finished downloading

getCompletedTileCount

public long getCompletedTileCount()

Get the number of tiles that have been fully downloaded and are ready for offline access.

Returns:

the completed tile count

getCompletedTileSize

public long getCompletedTileSize()

Get the cumulative size, in bytes, of all tiles that have been fully downloaded.

Returns:

the completed tile size

getRequiredResourceCount

public long getRequiredResourceCount()

Get the number of resources that are known to be required for this region. See the documentation for `requiredResourceCountIsPrecise` for an important caveat about this number.

Returns:

the amount of resources that are required

isRequiredResourceCountPrecise

public boolean isRequiredResourceCountPrecise()

Returns when the value of requiredResourceCount is a precise count of the number of required resources, and false when it is merely a lower bound.

Specifically, it is false during early phases of an offline download. Once style and tile sources have been downloaded, it is possible to calculate the precise number of required resources, at which point it is set to true.

Returns:

True if the required resource count is precise, false if not