MapTileRequestState.java

package com.mapbox.mapboxsdk.tileprovider;

import com.mapbox.mapboxsdk.tileprovider.modules.MapTileModuleLayerBase;
import java.util.Collections;
import java.util.LinkedList;
import java.util.Queue;

/**
 * Track the status of a single map tile given a list of providers that could
 * change its state by loading, caching, or disposing it.
 */
public class MapTileRequestState {

    private final Queue<MapTileModuleLayerBase> mProviderQueue;
    private final MapTile mMapTile;
    private final IMapTileProviderCallback mCallback;
    private MapTileModuleLayerBase mCurrentProvider;

    /**
     * Initialize a new state to keep track of a map tile
     */
    public MapTileRequestState(final MapTile mapTile, final MapTileModuleLayerBase[] providers,
            final IMapTileProviderCallback callback) {
        mProviderQueue = new LinkedList<MapTileModuleLayerBase>();
        if (providers != null) {
            Collections.addAll(mProviderQueue, providers);
        }
        mMapTile = mapTile;
        mCallback = callback;
    }

    /**
     * Get the map tile this class owns
     *
     * @return this map tile
     */
    public MapTile getMapTile() {
        return mMapTile;
    }

    /**
     * Get the assigned callback
     *
     * @return the assigned callback
     */
    public IMapTileProviderCallback getCallback() {
        return mCallback;
    }

    public MapTileModuleLayerBase getNextProvider() {
        mCurrentProvider = mProviderQueue.poll();
        return mCurrentProvider;
    }
}