ArrayAdapter.java

/*
 * Copyright 2013 Niek Haarman
 *
 * 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.marshalchen.common.uimodule.listviewanimations;

import android.widget.BaseAdapter;
import com.marshalchen.common.uimodule.listviewanimations.itemmanipulation.AnimateAdditionAdapter;
import com.marshalchen.common.uimodule.listviewanimations.widget.DynamicListView;

import java.util.*;

/**
 * A {@code true} {@link java.util.ArrayList} adapter providing access to all ArrayList methods.
 * Also implements {@link DynamicListView.Swappable} for easy object swapping, and {@link AnimateAdditionAdapter.Insertable} for inserting objects.
 */
@SuppressWarnings("UnusedDeclaration")
public abstract class ArrayAdapter<T> extends BaseAdapter implements List<T>, DynamicListView.Swappable, AnimateAdditionAdapter.Insertable<T> {

    protected List<T> mItems;

    /**
     * Creates a new ArrayAdapter with an empty {@code List} .
     */
    public ArrayAdapter() {
        this(null);
    }

    /**
     * Creates a new {@link com.marshalchen.common.uimodule.listviewanimations.ArrayAdapter} using given {@code List} , or an empty {@code List}  if objects == null.
     */
    public ArrayAdapter(final List<T> objects) {
        this(objects, false);
    }

    /**
     * Creates a new {@link com.marshalchen.common.uimodule.listviewanimations.ArrayAdapter}, using (a copy of) given {@code List} , or an empty {@code List}  if objects = null.
     * @param copyList {@code true} to create a copy of the {@code List} , {@code false} to reuse the reference.
     */
    public ArrayAdapter(final List<T> objects, final boolean copyList) {
        if (objects != null) {
            if (copyList) {
                mItems = new ArrayList<T>(objects);
            } else {
                mItems = objects;
            }
        } else {
            mItems = new ArrayList<T>();
        }
    }


    @Override
    public int getCount() {
        return mItems.size();
    }

    @Override
    public T getItem(final int location) {
        return mItems.get(location);
    }

    @Override
    public long getItemId(final int location) {
        return location;
    }

    /**
     * Appends the specified element to the end of the {@code List} .
     * @param object the object to add.
     * @return always true.
     */
    @Override
    public boolean add(final T object) {
        boolean result = mItems.add(object);
        notifyDataSetChanged();
        return result;
    }

    @Override
    public void add(final int location, final T object) {
        mItems.add(location, object);
        notifyDataSetChanged();
    }

    /**
     * Adds the objects in the specified collection to the end of this List. The objects are added in the order in which they are returned from the collection's iterator.
     * @param collection the collection of objects.
     * @return {@code true} if this {@code List} is modified, {@code false} otherwise.
     */
    @Override
    public boolean addAll(final Collection<? extends T> collection) {
        boolean result = mItems.addAll(collection);
        notifyDataSetChanged();
        return result;
    }

    /**
     * Appends all of the elements in the specified collection to the end of the
     * {@code List} , in the order that they are specified.
     * @param objects the array of objects.
     * @return {@code true} if the collection changed during insertion.
     */
    public boolean addAll(final T... objects) {
        boolean result = Collections.addAll(mItems, objects);
        notifyDataSetChanged();
        return result;
    }

    @Override
    public boolean addAll(final int location, final Collection<? extends T> objects) {
        boolean result = mItems.addAll(location, objects);
        notifyDataSetChanged();
        return result;
    }

    /**
     * Inserts the objects in the specified collection at the specified location in this List. The objects are added in the order that they specified.
     * @param location the index at which to insert.
     * @param objects the array of objects.
     */
    public void addAll(final int location, final T... objects) {
        for (int i = location; i < objects.length + location; i++) {
            mItems.add(i, objects[i]);
        }
        notifyDataSetChanged();
    }

    @Override
    public void clear() {
        mItems.clear();
        notifyDataSetChanged();
    }

    @Override
    public boolean contains(final Object object) {
        return mItems.contains(object);
    }

    @Override
    public boolean containsAll(final Collection<?> collection) {
        return mItems.containsAll(collection);
    }

    @Override
    public T get(final int location) {
        return mItems.get(location);
    }

    @Override
    public T set(final int location, final T object) {
        T result = mItems.set(location, object);
        notifyDataSetChanged();
        return result;
    }

    @Override
    public int size() {
        return mItems.size();
    }

    @Override
    public List<T> subList(final int start, final int end) {
        return mItems.subList(start, end);
    }

    @Override
    public Object[] toArray() {
        return mItems.toArray();
    }

    @Override
    public <T1> T1[] toArray(final T1[] array) {
        //noinspection SuspiciousToArrayCall
        return mItems.toArray(array);
    }

    @Override
    public boolean remove(final Object object) {
        boolean result = mItems.remove(object);
        notifyDataSetChanged();
        return result;
    }

    @Override
    public T remove(final int location) {
        T result = mItems.remove(location);
        notifyDataSetChanged();
        return result;
    }

    /**
     * Removes all elements at the specified locations in the {@code List} .
     * @param locations the collection of indexes to remove.
     * @return a collection containing the removed objects.
     */
    public Collection<T> removePositions(final Collection<Integer> locations) {
        ArrayList<T> removedItems = new ArrayList<T>();

        ArrayList<Integer> locationsList = new ArrayList<Integer>(locations);
        Collections.sort(locationsList);
        Collections.reverse(locationsList);
        for (int location : locationsList) {
            removedItems.add(mItems.remove(location));
        }
        notifyDataSetChanged();
        return removedItems;
    }

    @Override
    public boolean removeAll(final Collection<?> objects) {
        boolean result = mItems.removeAll(objects);
        notifyDataSetChanged();
        return result;
    }

    @Override
    public boolean retainAll(final Collection<?> objects) {
        boolean result = mItems.retainAll(objects);
        notifyDataSetChanged();
        return result;
    }

    @Override
    public int indexOf(final Object object) {
        return mItems.indexOf(object);
    }

    @Override
    public Iterator<T> iterator() {
        return mItems.iterator();
    }

    @Override
    public int lastIndexOf(final Object object) {
        return mItems.lastIndexOf(object);
    }

    @Override
    public ListIterator<T> listIterator() {
        return mItems.listIterator();
    }

    @Override
    public ListIterator<T> listIterator(final int location) {
        return mItems.listIterator(location);
    }

    @Override
    public void swapItems(final int locationOne, final int locationTwo) {
        T temp = getItem(locationOne);
        set(locationOne, getItem(locationTwo));
        set(locationTwo, temp);
    }

    private BaseAdapter mDataSetChangedSlavedAdapter;

    public void propagateNotifyDataSetChanged(final BaseAdapter slavedAdapter) {
        mDataSetChangedSlavedAdapter = slavedAdapter;
    }

    @Override
    public void notifyDataSetChanged() {
        super.notifyDataSetChanged();
        if (mDataSetChangedSlavedAdapter != null) {
            mDataSetChangedSlavedAdapter.notifyDataSetChanged();
        }
    }
}