# This is a combination of 8 commits.

# The first commit's message is:
# This is a combination of 2 commits.
# The first commit's message is:

# This is a combination of 3 commits.
# The first commit's message is:
# This is a combination of 2 commits.
# The first commit's message is:

# This is a combination of 21 commits.
# The first commit's message is:
[android] - Implements Android bindings for offline API
Fixes #3891

# The 2nd commit message will be skipped:

#	[android] #3891 - rename OFFLINE_MAX_CACHE_SIZE to DEFAULT_MAX_CACHE_SIZE and adjust value

# The 3rd commit message will be skipped:

#	[android] #3891 - makes de documentation more relevant to the current android implementation

# The 4th commit message will be skipped:

#	[android] #3891 - rename isRequiredResourceCountIsIndeterminate() to isRequiredResourceCountPrecise()

# The 5th commit message will be skipped:

#	[android] #3891 - rename complete() to isComplete()

# The 6th commit message will be skipped:

#	[android] #3891 - rename OfflineRegionDefinition to OfflineTilePyramidRegionDefinition and make OfflineRegionDefinition an interface. Docs for corresponding classes updated.

# The 7th commit message will be skipped:

#	[android] #3891 - make reason a more idiomatic ErrorReason Android IntDef and remove unnecessary constructor

# The 8th commit message will be skipped:

#	[android] #3891 - reuse the calling object instead of creating a new manager

# The 9th commit message will be skipped:

#	[android] #3891 - location, location, location

# The 10th commit message will be skipped:

#	[android] #3891 - simpler list regions iteration

# The 11th commit message will be skipped:

#	[android] #3891 - proper indeterminate -> precise transition

# The 12th commit message will be skipped:

#	[android] #3891 - improve description for DEFAULT_MAX_CACHE_SIZE

# The 13th commit message will be skipped:

#	[android] #3891 - delete global refs for obj and listCallback

# The 14th commit message will be skipped:

#	[android] #3891 - simplify metadata conversion and fix metadata object

# The 15th commit message will be skipped:

#	[android] - Implements Android bindings for offline API
#	Fixes #3891

# The 16th commit message will be skipped:

#	[android] #3891 - avoid exposing the int reason value in the public API

# The 17th commit message will be skipped:

#	[android] #3891 - delete global refs for remaining callbacks and observer

# The 18th commit message will be skipped:

#	[android] #3891 - remove unused offlineManagerClassConstructorId together with unnecessary private java constructor

# The 19th commit message will be skipped:

#	[android] #3891 - remove non-relevant line

# The 20th commit message will be skipped:

#	[android] #3891 - handle requiredResourceCountIsIndeterminate -> requiredResourceCountIsPrecise rename

# The 21st commit message will be skipped:

#	[android] #3891 - revert map changes to allow rebase

# The 2nd commit message will be skipped:

#	[android] #3891 - avoid exposing the int reason value in the public API

# The 2nd commit message will be skipped:

#	[android] #3891 - rename complete() to isComplete()

# The 3rd commit message will be skipped:

#	[android] #3891 - rename OfflineRegionDefinition to OfflineTilePyramidRegionDefinition and make OfflineRegionDefinition an interface. Docs for corresponding classes updated.

# The 2nd commit message will be skipped:

#	[android] #3891 - location, location, location

# The 2nd commit message will be skipped:

#	[android] #3891 - improve description for DEFAULT_MAX_CACHE_SIZE

# The 3rd commit message will be skipped:

#	[android] #3891 - delete global refs for obj and listCallback

# The 4th commit message will be skipped:

#	[android] #3891 - simplify metadata conversion and fix metadata object

# The 5th commit message will be skipped:

#	[android] #3891 - delete global refs for remaining callbacks and observer

# The 6th commit message will be skipped:

#	[android] #3891 - remove unused offlineManagerClassConstructorId together with unnecessary private java constructor

# The 7th commit message will be skipped:

#	[android] #3891 - remove non-relevant line

# The 8th commit message will be skipped:

#	[android] #3891 - handle requiredResourceCountIsIndeterminate -> requiredResourceCountIsPrecise rename

1 files changed, 278 insertions, 0 deletions

diff --git a/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java
new file mode 100644
index 0000000000..9e518f1e6a
--- /dev/null
+++ b/platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/offline/OfflineRegion.java
@@ -0,0 +1,278 @@
+package com.mapbox.mapboxsdk.offline;
+
+import android.os.Handler;
+import android.os.Looper;
+import android.support.annotation.IntDef;
+import android.support.annotation.NonNull;
+import android.util.Log;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * To use offline maps on mobile, you will first have to create an offline region.
+ * Use OfflineManager.createOfflineRegion() to create a new offline region.
+ */
+public class OfflineRegion {
+
+    private final static String LOG_TAG = "OfflineRegion";
+
+    // Parent OfflineManager
+    private OfflineManager offlineManager;
+
+    // Members
+    private long mId = 0;
+    private OfflineRegionDefinition mDefinition = null;
+    private OfflineRegionMetadata mMetadata = null;
+
+    // Holds the pointer to JNI OfflineRegion
+    private long mOfflineRegionPtr = 0;
+
+    // Makes sure callbacks come back to the main thread
+    private Handler handler;
+
+    /**
+     * A region can have a single observer, which gets notified whenever a change
+     * to the region's status occurs.
+     */
+    public interface OfflineRegionObserver {
+        /**
+         * Implement this method to be notified of a change in the status of an
+         * offline region. Status changes include any change in state of the members
+         * of OfflineRegionStatus.
+         *
+         * This method will be executed on the main thread.
+         */
+        void onStatusChanged(OfflineRegionStatus status);
+
+        /**
+         * Implement this method to be notified of errors encountered while downloading
+         * regional resources. Such errors may be recoverable; for example the implementation
+         * will attempt to re-request failed resources based on an exponential backoff
+         * algorithm, or when it detects that network access has been restored.
+         *
+         * This method will be executed on the main thread.
+         */
+        void onError(OfflineRegionError error);
+
+        /*
+         * Implement this method to be notified when the limit on the number of Mapbox
+         * tiles stored for offline regions has been reached.
+         *
+         * Once the limit has been reached, the SDK will not download further offline
+         * tiles from Mapbox APIs until existing tiles have been removed. Contact your
+         * Mapbox sales representative to raise the limit.
+         *
+         * This limit does not apply to non-Mapbox tile sources.
+         *
+         * This method will be executed on the main thread.
+         */
+        void mapboxTileCountLimitExceeded(long limit);
+    }
+
+    /*
+     * Callbacks
+     */
+
+    public interface OfflineRegionStatusCallback {
+        void onStatus(OfflineRegionStatus status);
+        void onError(String error);
+    }
+
+    public interface OfflineRegionDeleteCallback {
+        void onDelete();
+        void onError(String error);
+    }
+
+    /**
+     * A region is either inactive (not downloading, but previously-downloaded
+     * resources are available for use), or active (resources are being downloaded
+     * or will be downloaded, if necessary, when network access is available).
+     *
+     * This state is independent of whether or not the complete set of resources
+     * is currently available for offline use. To check if that is the case, use
+     * `OfflineRegionStatus.isComplete()`.
+     */
+
+    @IntDef({STATE_INACTIVE, STATE_ACTIVE})
+    @Retention(RetentionPolicy.SOURCE)
+    public @interface DownloadState {}
+
+    public static final int STATE_INACTIVE = 0;
+    public static final int STATE_ACTIVE = 1;
+
+    /*
+     * Constructor
+     */
+
+    private OfflineRegion() {
+        // For JNI use only, to create a new offline region, use
+        // OfflineManager.createOfflineRegion() instead.
+    }
+
+    /*
+     * Getters
+     */
+
+    public long getID() {
+        return mId;
+    }
+
+    public OfflineRegionDefinition getDefinition() {
+        return mDefinition;
+    }
+
+    public OfflineRegionMetadata getMetadata() {
+        return mMetadata;
+    }
+
+    private Handler getHandler() {
+        if (handler == null) {
+            handler = new Handler(Looper.getMainLooper());
+        }
+
+        return handler;
+    }
+
+    /**
+     * Register an observer to be notified when the state of the region changes.
+     */
+    public void setObserver(@NonNull final OfflineRegionObserver observer) {
+        setOfflineRegionObserver(this, new OfflineRegionObserver() {
+            @Override
+            public void onStatusChanged(final OfflineRegionStatus status) {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        observer.onStatusChanged(status);
+                    }
+                });
+            }
+
+            @Override
+            public void onError(final OfflineRegionError error) {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        observer.onError(error);
+                    }
+                });
+            }
+
+            @Override
+            public void mapboxTileCountLimitExceeded(final long limit) {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        observer.mapboxTileCountLimitExceeded(limit);
+                    }
+                });
+            }
+        });
+    }
+
+    /**
+     * Pause or resume downloading of regional resources.
+     */
+    public void setDownloadState(@DownloadState int state) {
+        setOfflineRegionDownloadState(this, state);
+    }
+
+    /**
+     * Retrieve the current status of the region. The query will be executed
+     * asynchronously and the results passed to the given callback which will be
+     * executed on the main thread.
+     */
+    public void getStatus(@NonNull final OfflineRegionStatusCallback callback) {
+        getOfflineRegionStatus(this, new OfflineRegionStatusCallback() {
+            @Override
+            public void onStatus(final OfflineRegionStatus status) {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        callback.onStatus(status);
+                    }
+                });
+            }
+
+            @Override
+            public void onError(final String error) {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        callback.onError(error);
+                    }
+                });
+            }
+        });
+    }
+
+    /**
+     * Remove an offline region from the database and perform any resources evictions
+     * necessary as a result.
+     *
+     * Eviction works by removing the least-recently requested resources not also required
+     * by other regions, until the database shrinks below a certain size.
+     *
+     * When the operation is complete or encounters an error, the given callback will be
+     * executed on the main thread.
+     */
+    public void delete(@NonNull final OfflineRegionDeleteCallback callback) {
+        deleteOfflineRegion(this, new OfflineRegionDeleteCallback() {
+            @Override
+            public void onDelete() {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        callback.onDelete();
+                        OfflineRegion.this.finalize();
+                    }
+                });
+            }
+
+            @Override
+            public void onError(final String error) {
+                getHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        callback.onError(error);
+                    }
+                });
+            }
+        });
+    }
+
+    @Override
+    protected void finalize() {
+        try {
+            super.finalize();
+            destroyOfflineRegion(mOfflineRegionPtr);
+            mOfflineRegionPtr = 0;
+        } catch (Throwable throwable) {
+            Log.e(LOG_TAG, "Failed to finalize OfflineRegion: " + throwable.getMessage());
+        }
+    }
+
+    /*
+     * Native methods
+     */
+
+    private native void destroyOfflineRegion(long offlineRegionPtr);
+
+    private native void setOfflineRegionObserver(
+            OfflineRegion offlineRegion,
+            OfflineRegionObserver observerCallback);
+
+    private native void setOfflineRegionDownloadState(
+            OfflineRegion offlineRegion,
+            @DownloadState int offlineRegionDownloadState);
+
+    private native void getOfflineRegionStatus(
+            OfflineRegion offlineRegion,
+            OfflineRegionStatusCallback statusCallback);
+
+    private native void deleteOfflineRegion(
+            OfflineRegion offlineRegion,
+            OfflineRegionDeleteCallback deleteCallback);
+
+}