Package org.eclipse.collections.impl.list.mutable

Class RandomAccessListAdapter<T>

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess, MutableCollection<T>, InternalIterable<T>, ListIterable<T>, MutableList<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>
    public final class RandomAccessListAdapter<T>
extends AbstractListAdapter<T>
implements java.util.RandomAccess, java.io.Serializable
    This class provides a MutableList wrapper around a JDK Collections List interface instance. All the MutableList interface methods are supported in addition to the JDK List interface methods.

    To create a new wrapper around an existing List instance, use the adapt(List) factory method.

    See Also:
    Serialized Form

    • Field Detail

      • delegate

        private final java.util.List<T> delegate

    • Constructor Detail

      • RandomAccessListAdapter

        RandomAccessListAdapter​(java.util.List<T> newDelegate)

    • Method Detail

      • adapt

        public static <E> MutableList<E> adapt​(java.util.List<E> list)

      • asSynchronized

        public MutableList<T> asSynchronized()
        Description copied from interface: MutableCollection
        Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally. 
          MutableCollection synchedCollection = collection.asSynchronized();
     ...
  synchedCollection.forEach(each -> ... );
  synchedCollection.select(each -> ... );
  synchedCollection.collect(each -> ... );
        If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

        Specified by:
        asSynchronized in interface MutableCollection<T>
        Specified by:
        asSynchronized in interface MutableList<T>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)

      • newEmpty

        @Deprecated
public MutableList<T> newEmpty()
        Deprecated.
        use FastList.newList() instead (inlineable)
        Description copied from interface: MutableCollection
        Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.
        Specified by:
        newEmpty in interface MutableCollection<T>
        Specified by:
        newEmpty in interface MutableList<T>

      • reverseForEach

        public void reverseForEach​(Procedure<? super T> procedure)
        Description copied from interface: ReversibleIterable
        Evaluates the procedure for each element of the list iterating in reverse order. 
        e.g.
 people.reverseForEach(person -> LOGGER.info(person.getName()));
        Specified by:
        reverseForEach in interface ReversibleIterable<T>

      • reverseForEachWithIndex

        public void reverseForEachWithIndex​(ObjectIntProcedure<? super T> procedure)
        Description copied from interface: ReversibleIterable
        Evaluates the procedure for each element and it's index in reverse order. 
        e.g.
 people.reverseForEachWithIndex((person, index) ->
         LOGGER.info("Index: " + index + " person: " + person.getName()));
        Specified by:
        reverseForEachWithIndex in interface ReversibleIterable<T>

      • forEachWithIndex

        public void forEachWithIndex​(ObjectIntProcedure<? super T> objectIntProcedure)
        Description copied from interface: InternalIterable
        Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

        Example using a Java 8 lambda: 

         people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));

        Example using an anonymous inner class: 

         people.forEachWithIndex(new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
        Specified by:
        forEachWithIndex in interface InternalIterable<T>
        Specified by:
        forEachWithIndex in interface OrderedIterable<T>
        Overrides:
        forEachWithIndex in class AbstractCollectionAdapter<T>

      • forEachWithIndex

        public void forEachWithIndex​(int fromIndex,
                             int toIndex,
                             ObjectIntProcedure<? super T> objectIntProcedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
        e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, (person, index) -> LOGGER.info(person.getName()));

        This code would output ted and mary's names.

        Specified by:
        forEachWithIndex in interface OrderedIterable<T>

      • detect

        public T detect​(Predicate<? super T> predicate)
        Description copied from interface: RichIterable
        Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

        Example using a Java 8 lambda expression: 

         Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
        Specified by:
        detect in interface RichIterable<T>
        Overrides:
        detect in class AbstractCollectionAdapter<T>

      • detectIndex

        public int detectIndex​(Predicate<? super T> predicate)
        Description copied from interface: OrderedIterable
        Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectIndex in interface OrderedIterable<T>

      • detectLastIndex

        public int detectLastIndex​(Predicate<? super T> predicate)
        Description copied from interface: ReversibleIterable
        Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectLastIndex in interface ReversibleIterable<T>

      • count

        public int count​(Predicate<? super T> predicate)
        Description copied from interface: RichIterable
        Return the total number of elements that answer true to the specified predicate.

        Example using a Java 8 lambda expression: 

         int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));
        Specified by:
        count in interface RichIterable<T>
        Overrides:
        count in class AbstractCollectionAdapter<T>

      • corresponds

        public <S> boolean corresponds​(OrderedIterable<S> other,
                               Predicate2<? super T,​? super S> predicate)
        Description copied from interface: OrderedIterable
        Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.
        Specified by:
        corresponds in interface OrderedIterable<T>

      • anySatisfy

        public boolean anySatisfy​(Predicate<? super T> predicate)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.
        Specified by:
        anySatisfy in interface RichIterable<T>
        Overrides:
        anySatisfy in class AbstractCollectionAdapter<T>

      • injectInto

        public <IV> IV injectInto​(IV injectedValue,
                          Function2<? super IV,​? super T,​? extends IV> function)
        Description copied from interface: RichIterable
        Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.
        Specified by:
        injectInto in interface RichIterable<T>
        Overrides:
        injectInto in class AbstractCollectionAdapter<T>

      • forEach

        public void forEach​(int fromIndex,
                    int toIndex,
                    Procedure<? super T> procedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
        e.g.
 OrderedIterable<Person> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, person -> LOGGER.info(person.getName()));

        This code would output ted and mary's names.

        Specified by:
        forEach in interface OrderedIterable<T>

      • sort

        public void sort​(java.util.Comparator<? super T> comparator)
        Specified by:
        sort in interface java.util.List<T>

      • sortThis

        public RandomAccessListAdapter<T> sortThis​(java.util.Comparator<? super T> comparator)
        Description copied from interface: MutableList
        Sorts the internal data structure of this list and returns the list itself as a convenience.
        Specified by:
        sortThis in interface MutableList<T>

      • with

        public RandomAccessListAdapter<T> with​(T element)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.with("1");
 list = list.with("2");
 return list;
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.
        Specified by:
        with in interface MutableCollection<T>
        Specified by:
        with in interface MutableList<T>
        See Also:
        Collection.add(Object)

      • without

        public RandomAccessListAdapter<T> without​(T element)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.without("1");
 list = list.without("2");
 return list;
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.
        Specified by:
        without in interface MutableCollection<T>
        Specified by:
        without in interface MutableList<T>
        See Also:
        Collection.remove(Object)

      • withAll

        public RandomAccessListAdapter<T> withAll​(java.lang.Iterable<? extends T> elements)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.
        Specified by:
        withAll in interface MutableCollection<T>
        Specified by:
        withAll in interface MutableList<T>
        See Also:
        Collection.addAll(Collection)

      • withoutAll

        public RandomAccessListAdapter<T> withoutAll​(java.lang.Iterable<? extends T> elements)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.
        Specified by:
        withoutAll in interface MutableCollection<T>
        Specified by:
        withoutAll in interface MutableList<T>
        See Also:
        Collection.removeAll(Collection)

      • flatCollect

        public <V> MutableList<V> flatCollect​(Function<? super T,​? extends java.lang.Iterable<V>> function)
        Description copied from interface: MutableCollection
        flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

        Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function: 

         Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
        Using collect returns a collection of collections of addresses. 
         RichIterable<List<Address>> addresses = people.collect(addressFunction);
        Using flatCollect returns a single flattened list of addresses. 
         RichIterable<Address> addresses = people.flatCollect(addressFunction);
        Co-variant example for MutableCollection: 
         Function<Person, List<Address>> addressFunction = Person::getAddresses;
 MutableCollection<Person> people = ...;
 MutableCollection<List<Address>> addresses = people.collect(addressFunction);
 MutableCollection<Address> addresses = people.flatCollect(addressFunction);
        Specified by:
        flatCollect in interface ListIterable<T>
        Specified by:
        flatCollect in interface MutableCollection<T>
        Specified by:
        flatCollect in interface MutableList<T>
        Specified by:
        flatCollect in interface OrderedIterable<T>
        Specified by:
        flatCollect in interface ReversibleIterable<T>
        Specified by:
        flatCollect in interface RichIterable<T>
        Overrides:
        flatCollect in class AbstractListAdapter<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function

      • groupBy

        public <V> FastListMultimap<V,​T> groupBy​(Function<? super T,​? extends V> function)
        Description copied from interface: MutableCollection
        For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

        Example using a Java 8 method reference: 

         Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
        Co-variant example for MutableCollection: 
         MutableMultimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
        Specified by:
        groupBy in interface ListIterable<T>
        Specified by:
        groupBy in interface MutableCollection<T>
        Specified by:
        groupBy in interface MutableList<T>
        Specified by:
        groupBy in interface OrderedIterable<T>
        Specified by:
        groupBy in interface ReversibleIterable<T>
        Specified by:
        groupBy in interface RichIterable<T>
        Overrides:
        groupBy in class AbstractListAdapter<T>

      • zip

        public <S> MutableList<Pair<T,​S>> zip​(java.lang.Iterable<S> that)
        Description copied from interface: RichIterable
        Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
        Specified by:
        zip in interface ListIterable<T>
        Specified by:
        zip in interface MutableCollection<T>
        Specified by:
        zip in interface MutableList<T>
        Specified by:
        zip in interface OrderedIterable<T>
        Specified by:
        zip in interface ReversibleIterable<T>
        Specified by:
        zip in interface RichIterable<T>
        Overrides:
        zip in class AbstractListAdapter<T>
        Type Parameters:
        S - the type of the second half of the returned pairs
        Parameters:
        that - The RichIterable providing the second half of each result pair
        Returns:
        A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

      • take

        public MutableList<T> take​(int count)
        Description copied from interface: ReversibleIterable
        Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
        Specified by:
        take in interface ListIterable<T>
        Specified by:
        take in interface MutableList<T>
        Specified by:
        take in interface ReversibleIterable<T>
        Parameters:
        count - the number of items to take.

      • drop

        public MutableList<T> drop​(int count)
        Description copied from interface: ReversibleIterable
        Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
        Specified by:
        drop in interface ListIterable<T>
        Specified by:
        drop in interface MutableList<T>
        Specified by:
        drop in interface ReversibleIterable<T>
        Parameters:
        count - the number of items to drop.