com.bmd.android.collection.iterator.SparseIntArrayIterable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of robo-fashion Show documentation
Show all versions of robo-fashion Show documentation
Easily iterate through Android sparse collections
/**
* 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.iterator;
import android.os.Parcelable;
import android.util.SparseIntArray;
import com.bmd.android.collection.entry.IntSparseIntEntry;
import com.bmd.android.collection.entry.ParcelableIntSparseIntEntry;
import com.bmd.android.collection.entry.SparseIntArrayEntry;
import com.bmd.android.collection.filter.Filter;
import com.bmd.android.collection.filter.SparseIntArrayFilterBuilder;
import com.bmd.android.collection.translator.IntTranslator;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
import java.util.SortedMap;
/**
* This interface extends the {@link SparseIterable} one by adding specific methods handling
* {@link com.bmd.android.collection.entry.SparseIntArrayEntry} elements.
*
* Created by davide on 3/10/14.
*/
public interface SparseIntArrayIterable extends SparseIterable {
/**
* Appends all the elements returned by this iterable to the specified sparse collection.
*
* @param other the sparse collection to append the elements to.
* @return this iterable.
*/
public SparseIntArrayIterable appendTo(SparseIntArray other);
@Override
public SparseIntArrayFilterBuilder but();
@Override
public SparseIntArrayIterable but(Filter filter);
@Override
public SparseIntArrayIterable doWhile(Condition condition);
@Override
public SparseIntArrayIterable forEach(Action action);
@Override
public SparseIntArrayFilterBuilder only();
@Override
public SparseIntArrayIterable only(Filter filter);
@Override
public SparseIntArrayIterable remove();
@Override
public SparseIntArrayIterable retain();
@Override
public SparseIntArrayIterable reverse();
/**
* Checks if all the specified keys are present in the iterated elements.
*
* @param keys the keys to search for.
* @return whether all the keys are present.
*/
public boolean containsAllKeys(int... keys);
/**
* Checks if all the keys returned by the specified iterable are present in the iterated
* elements.
*
* @param keys the keys to search for.
* @return whether all the keys are present.
*/
public boolean containsAllKeys(Iterable keys);
/**
* Checks if all the specified value objects are present in the iterated elements.
*
* @param values the values to search for.
* @return whether all the values are present.
*/
public boolean containsAllValues(int... values);
/**
* Checks if all the values returned by the specified iterable are present in the iterated
* elements.
*
* @param values the values to search for.
* @return whether all the values are present.
*/
public boolean containsAllValues(Iterable values);
/**
* Checks if at least one of the specified keys is present in the iterated elements.
*
* @param keys the keys to search for.
* @return whether at least one key is present.
*/
public boolean containsAnyKey(int... keys);
/**
* Checks if at least one of the keys returned by the specified iterable is present in the
* iterated elements.
*
* @param keys the keys to search for.
* @return whether at least one key is present.
*/
public boolean containsAnyKey(Iterable keys);
/**
* Checks if at least one of the specified values is present in the iterated elements.
*
* @param values the values to search for.
* @return whether at least one value is present.
*/
public boolean containsAnyValue(int... values);
/**
* Checks if at least one of the values returned by the specified iterable is present in the
* iterated elements.
*
* @param values the values to search for.
* @return whether at least one value is present.
*/
public boolean containsAnyValue(Iterable values);
/**
* Checks if the specified key is present in the iterated elements.
*
* @param key the key to search for.
* @return whether the key is present.
*/
public boolean containsKey(int key);
/**
* Checks if the specified value is present in the iterated elements.
*
* @param value the value to search for.
* @return whether the value is present.
*/
public boolean containsValue(int value);
/**
* Fills the specified map with the elements returned by this iterable, in the iteration
* order.
*
* @param map the map to fill.
* @return this iterable.
*/
public SparseIntArrayIterable fill(Map map);
/**
* Fills the specified collection with an immutable copy of the elements returned by this
* iterable, in the iteration order.
*
* @param collection the collection to fill.
* @return this iterable.
*/
public SparseIntArrayIterable fillImmutable(Collection collection);
/**
* Fills the specified array with an immutable copy of the elements returned by this
* iterable, in the iteration order.
*
* Note that, if the immutable copy of the elements returned by the iterable cannot be cast to
* the array elements type, a {@link java.lang.ClassCastException} will be thrown.
*
* Note also that, in case the array is not big enough to contain all the elements, an
* {@link java.lang.IndexOutOfBoundsException} will be thrown.
*
* @param array the array to fill.
* @param the array element type.
* @return this iterable.
*/
public SparseIntArrayIterable fillImmutable(T[] array);
/**
* Fills the specified array with an immutable copy of the elements returned by this
* iterable, in the iteration order, starting from the specified offset inside the array.
*
* Note that, if the immutable copy of the elements returned by the iterable cannot be cast to
* the array elements type, a {@link java.lang.ClassCastException} will be thrown.
*
* Note also that, in case the array is not big enough to contain all the elements, an
* {@link java.lang.IndexOutOfBoundsException} will be thrown.
*
* @param array the array to fill.
* @param offset the offset from which to start filling the array.
* @param the array element type.
* @return this iterable.
*/
public SparseIntArrayIterable fillImmutable(T[] array, int offset);
/**
* Fills the specified collection with a parcelable copy of the elements returned by this
* iterable, in the iteration order.
*
* @param collection the collection to fill.
* @return this iterable.
*/
public SparseIntArrayIterable fillParcelable(
Collection collection);
/**
* Fills the specified array with a parcelable copy of the elements returned by this
* iterable, in the iteration order.
*
* Note that, if the immutable copy of the elements returned by the iterable cannot be cast to
* the array elements type, a {@link java.lang.ClassCastException} will be thrown.
*
* Note also that, in case the array is not big enough to contain all the elements, an
* {@link java.lang.IndexOutOfBoundsException} will be thrown.
*
* @param array the array to fill.
* @param the array element type.
* @return this iterable.
*/
public SparseIntArrayIterable fillParcelable(T[] array);
/**
* Fills the specified array with a parcelable copy of the elements returned by this
* iterable, in the iteration order, starting from the specified offset inside the array.
*
* Note that, if the immutable copy of the elements returned by the iterable cannot be cast to
* the array elements type, a {@link java.lang.ClassCastException} will be thrown.
*
* Note also that, in case the array is not big enough to contain all the elements, an
* {@link java.lang.IndexOutOfBoundsException} will be thrown.
*
* @param array the array to fill.
* @param offset the offset from which to start filling the array.
* @param the array element type.
* @return this iterable.
*/
public SparseIntArrayIterable fillParcelable(T[] array, int offset);
/**
* Finds the index of the first element value, in the iteration order, equals to the specified
* one.
*
* @param value the value to search for.
* @return the index in the iteration, or -1 if the object is not found.
*/
public int firstIndexOfValue(int value);
/**
* Finds the position of the first element value, in the iteration order, equal to the specified
* one.
*
* Note that the returned value is relative to the iterator cycles so, in case filters has been
* applied to this iterable, the returned number might not match with the index in the sparse
* collection.
*
* @param value the value to search for.
* @return the position in the iteration, or -1 if the object is not found.
*/
public int firstPositionOfValue(int value);
/**
* Finds the index of the specified key in the iteration order.
*
* @param key the key to search for.
* @return the index in the iteration, or -1 if the object is not found.
*/
public int indexOfKey(int key);
/**
* Checks if all and only the elements returned by the this iterable are contained in the
* specified sparse collection.
*
* @param array the sparse collection to compare.
* @return whether the specified collection equals this iterable.
*/
boolean isEqualTo(SparseIntArray array);
/**
* Checks if all and only the elements returned by the this iterable are contained in the
* specified map.
*
* @param map the map to compare.
* @return whether the specified map equals this iterable.
*/
boolean isEqualTo(Map map);
/**
* Returns this iterable elements keys as a
* {@link com.bmd.android.collection.iterator.IntSparseIterable} object.
*
* Note that, every filter added since the call to this function, will be also applied to the
* returned iterable.
*
* @return the keys iterable.
*/
public IntSparseIterable keys();
/**
* Finds the position of the specified key in the iteration order.
*
* Note that the returned value is relative to the iterator cycles so, in case filters has been
* applied to this iterable, the returned number might not match with the index in the sparse
* collection.
*
* @param key the key to search for.
* @return the position in the iteration, or -1 if the object is not found.
*/
public int positionOfKey(int key);
/**
* Puts all the elements returned by this iterable into the specified sparse collection.
*
* @param other the sparse collection to put the elements into.
* @return this iterable.
*/
public SparseIntArrayIterable putInto(SparseIntArray other);
/**
* Replaces the element values returned by this iterable with the ones obtained through the
* specified translator.
*
* Note that the replacement will happen in place, and the same key corresponding to each
* element will be retained.
*
* @param translator the value translator.
* @return this iterable.
*/
public SparseIntArrayIterable replaceValues(IntTranslator translator);
/**
* Creates and returns a new array filled with an immutable copy of the elements returned by
* this iterable, in the iteration order.
*
* Note that, if the immutable copy of the elements returned by the iterable cannot be cast to
* the array elements type, a {@link java.lang.ClassCastException} will be thrown.
*
* @param type the array element class.
* @param the array element type.
* @return the new array.
*/
public T[] toImmutableArray(Class type);
/**
* Creates and returns a new list filled with an immutable copy of the elements returned by
* this iterable, in the iteration order.
*
* @return the new list.
*/
public ArrayList toImmutableList();
/**
* Creates and returns a new map filled with the elements key and values returned by this
* iterable, in the iteration order.
*
* @return the new array.
*/
public Map toMap();
/**
* Creates and returns a new array filled with a parcelable copy of the elements returned by
* this iterable, in the iteration order.
*
* Note that, if the parcelable copy of the elements returned by the iterable cannot be cast to
* the array elements type, a {@link java.lang.ClassCastException} will be thrown.
*
* @param type the array element class.
* @param the array element type.
* @return the new array.
*/
public T[] toParcelableArray(Class type);
/**
* Creates and returns a new list filled with an immutable copy of the elements returned by
* this iterable, in the iteration order.
*
* @return the new list.
*/
public ArrayList toParcelableList();
/**
* Creates and returns a new sorted map filled with the elements key and values returned by
* this iterable, in the iteration order.
*
* @return the new array.
* @see java.util.SortedMap
*/
public SortedMap toSortedMap();
/**
* Returns a new {@link android.util.SparseIntArray} collection filled with the keys and
* values returned by this iterable.
*
* @return the new collection instance.
*/
public SparseIntArray toSparseArray();
/**
* Returns a new iterable whose elements are the same as this ones but translated through the
* specified translators.
*
* Note that, in case the passed translator is not bidirectional, every attempt to modify the
* returned iterable elements will cause an exception to be thrown.
* Note also that all the filters and the iteration order are retained in the translation.
*
* @param keyTranslator the translator used to convert the element key.
* @param valueTranslator the translator used to convert the element value.
* @return the new iterable.
*/
public SparseIntArrayIterable translate(IntTranslator keyTranslator,
IntTranslator valueTranslator);
/**
* Returns a new iterable whose elements are the same as this ones but the keys are translated
* through the specified translator.
*
* Note that, in case the passed translator is not bidirectional, every attempt to modify the
* returned iterable elements will cause an exception to be thrown.
* Note also that all the filters and the iteration order are retained in the translation.
*
* @param keyTranslator the translator used to convert the element key.
* @return the new iterable.
*/
public SparseIntArrayIterable translateKeys(IntTranslator keyTranslator);
/**
* Returns a new iterable whose elements are the same as this ones but the values are translated
* through the specified translator.
*
* Note that, in case the passed translator is not bidirectional, every attempt to modify the
* returned iterable elements will cause an exception to be thrown.
* Note also that all the filters and the iteration order are retained in the translation.
*
* @param valueTranslator the translator used to convert the element value.
* @return the new iterable.
*/
public SparseIntArrayIterable translateValues(IntTranslator valueTranslator);
/**
* Returns this iterable elements values as a
* {@link com.bmd.android.collection.iterator.IntSparseIterable} object.
*
* Note that, every filter added since the call to this function, will be also applied to the
* returned iterable.
*
* @return the values iterable.
*/
public IntSparseIterable values();
}