com.bmd.android.collection.entry.SimpleArrayMapEntry 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.entry;

/**
 * This interface defines a {@link com.bmd.android.collection.entry.SparseEntry} associated with a
 * {@link android.support.v4.util.SimpleArrayMap} collection.
 * 
 * Created by davide on 3/10/14.
 *
 * @param  The key type.
 * @param  The value type.
 */
public interface SimpleArrayMapEntry extends ObjectSparseObjectEntry {

    /**
     * Returns the index inside the backing array map.
     *
     * @return The entry index.
     */
    public int getIndex();

    /**
     * Removes this entry from the backing array map.
     * 

     * It has the same effect as calling iterator.remove().
     */
    public void remove();

    /**
     * Modifies the value inside the array map associated with this entry key.
     *
     * @param value The new value.
     */
    public void setValue(V value);

    /**
     * Returns an immutable copy of this entry. The object will just store this entry key and value
     * without allowing any modification of the backing array map.
     *
     * @return The immutable entry.
     */
    public ObjectSparseObjectEntry toImmutable();

    /**
     * Returns a parcelable copy of this entry. The object will just store this entry key and value
     * without allowing any modification of the backing array map.
     * 
     * Note that the {@link android.os.Parcel#writeValue(Object)} function will be called to
     * serialize the entry key and value. So, if any of the two does not comply with the specific
     * requirements, the serialization might have unexpected results.
     *
     * @return The parcelable entry.
     */
    public ParcelableObjectSparseObjectEntry toParcelable();
}