com.bmd.android.collection.CompatCollections Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of robo-fashion Show documentation
Easily iterate through Android sparse collections
There is a newer version: 3.0.0
/**
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.bmd.android.collection;

import android.support.v4.util.LongSparseArray;
import android.support.v4.util.SimpleArrayMap;
import android.support.v4.util.SparseArrayCompat;
import android.util.SparseArray;
import android.util.SparseBooleanArray;
import android.util.SparseIntArray;

import com.bmd.android.collection.internal.CompatIterableFactory;
import com.bmd.android.collection.iterator.SimpleArrayMapIterable;
import com.bmd.android.collection.iterator.SparseArrayCompatIterable;
import com.bmd.android.collection.iterator.SparseArrayIterable;
import com.bmd.android.collection.iterator.SparseBooleanArrayIterable;
import com.bmd.android.collection.iterator.SparseIntArrayIterable;
import com.bmd.android.collection.iterator.SupportLongSparseArrayIterable;

/**
 * This utility class creates objects wrapping an Android sparse collection, such as
 * {@link android.util.SparseArray} and {@link android.support.v4.util.SparseArrayCompat}, to give
 * it the base functionalities of an {@link java.lang.Iterable} object.
 * 
 * Created by davide on 3/9/14.
 */
public class CompatCollections {

    /**
     * Avoid direct instantiation.
     */
    CompatCollections() {

    }

    /**
     * Wraps the specified {@link android.support.v4.util.SimpleArrayMap} into an iterable.
     *
     * @param arrayMap The array map to wrap.
     * @param       The element key type.
     * @param       The element value type.
     * @return The iterable instance.
     */
    public static  SimpleArrayMapIterable iterate(final SimpleArrayMap arrayMap) {

        return CompatIterableFactory.create(arrayMap);
    }

    /**
     * Wraps the specified {@link android.support.v4.util.LongSparseArray} into an iterable.
     *
     * @param sparseArray The sparse array to wrap.
     * @param          The element value type.
     * @return The iterable instance.
     */
    public static  SupportLongSparseArrayIterable iterate(
            final LongSparseArray sparseArray) {

        return CompatIterableFactory.create(sparseArray);
    }

    /**
     * Wraps the specified {@link android.util.SparseArray} into an iterable.
     *
     * @param sparseArray The sparse array to wrap.
     * @param          The element value type.
     * @return The iterable instance.
     */
    public static  SparseArrayIterable iterate(final SparseArray sparseArray) {

        return CompatIterableFactory.create(sparseArray);
    }

    /**
     * Wraps the specified {@link android.support.v4.util.SparseArrayCompat} into an iterable.
     *
     * @param sparseArray The sparse array to wrap.
     * @param          The element value type.
     * @return The iterable instance.
     */
    public static  SparseArrayCompatIterable iterate(final SparseArrayCompat sparseArray) {

        return CompatIterableFactory.create(sparseArray);
    }

    /**
     * Wraps the specified {@link android.util.SparseIntArray} into an iterable.
     *
     * @param sparseArray The sparse array to wrap.
     * @return The iterable instance.
     */
    public static SparseIntArrayIterable iterate(final SparseIntArray sparseArray) {

        return CompatIterableFactory.create(sparseArray);
    }

    /**
     * Wraps the specified {@link android.util.SparseBooleanArray} into an iterable.
     *
     * @param sparseArray The sparse array to wrap.
     * @return The iterable instance.
     */
    public static SparseBooleanArrayIterable iterate(final SparseBooleanArray sparseArray) {

        return CompatIterableFactory.create(sparseArray);
    }
}