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

Class ListAdapter<T>

java.lang.Object
org.eclipse.collections.impl.collection.mutable.AbstractCollectionAdapter<T>
org.eclipse.collections.impl.list.mutable.AbstractListAdapter<T>
org.eclipse.collections.impl.list.mutable.ListAdapter<T>
All Implemented Interfaces:
Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, MutableCollection<T>, InternalIterable<T>, ListIterable<T>, MutableList<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>
public final class ListAdapter<T>
extends AbstractListAdapter<T>
implements Serializable
This class provides a MutableList wrapper around a JDK Collections List interface instance. All of 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

  • Method Details

    • adapt

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

    • toImmutable

      public ImmutableList<T> toImmutable()
      Description copied from interface: MutableList
      Returns an immutable copy of this list. If the list is immutable, it returns itself.
      Specified by:
      toImmutable in interface ListIterable<T>
      Specified by:
      toImmutable in interface MutableCollection<T>
      Specified by:
      toImmutable in interface MutableList<T>

    • asUnmodifiable

      public MutableList<T> asUnmodifiable()
      Description copied from interface: MutableList
      Returns an unmodifiable view of the list.
      Specified by:
      asUnmodifiable in interface MutableCollection<T>
      Specified by:
      asUnmodifiable in interface MutableList<T>
      Returns:
      an unmodifiable view of this list
      See Also:
      Collections.unmodifiableCollection(Collection)

    • 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)

    • clone

      public MutableList<T> clone()
      Specified by:
      clone in interface MutableList<T>
      Overrides:
      clone in class AbstractListAdapter<T>

    • 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>

    • each

      public void each​(Procedure<? super T> procedure)
      Description copied from interface: RichIterable
      The procedure is executed for each element in the iterable.

      Example using a Java 8 lambda expression: 

       people.each(person -> LOGGER.info(person.getName()));

      Example using an anonymous inner class: 

       people.each(new Procedure<Person>()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
      This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).
      Specified by:
      each in interface RichIterable<T>
      Overrides:
      each in class AbstractCollectionAdapter<T>
      See Also:
      InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)

    • 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, new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int 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"));

      Example using an anonymous inner class: 

       Person person =
     people.detect(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
         }
     });
      Specified by:
      detect in interface RichIterable<T>
      Overrides:
      detect in class AbstractCollectionAdapter<T>

    • detectIfNone

      public T detectIfNone​(Predicate<? super T> predicate, Function0<? extends T> function)
      Description copied from interface: RichIterable
      Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.
      Specified by:
      detectIfNone in interface RichIterable<T>
      Overrides:
      detectIfNone 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"));

      Example using an anonymous inner class: 

       int count =
     people.count(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return 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>

    • allSatisfy

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

    • noneSatisfy

      public boolean noneSatisfy​(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.
      Specified by:
      noneSatisfy in interface RichIterable<T>
      Overrides:
      noneSatisfy 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<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure<Person>()
 {
     public void value(Person 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​(Comparator<? super T> comparator)
      Specified by:
      sort in interface List<T>
      Since:
      10.0

    • sortThis

      public ListAdapter<T> sortThis​(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>
      Since:
      10.0

    • sortThis

      public ListAdapter<T> sortThis()
      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>
      Since:
      10.0

    • with

      public ListAdapter<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)

    • with

      public ListAdapter<T> with​(T element1, T element2)

    • with

      public ListAdapter<T> with​(T element1, T element2, T element3)

    • with

      public ListAdapter<T> with​(T... elements)

    • without

      public ListAdapter<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 ListAdapter<T> withAll​(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 ListAdapter<T> withoutAll​(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)

    • selectInstancesOf

      public <S> MutableList<S> selectInstancesOf​(Class<S> clazz)
      Description copied from interface: MutableCollection
      Returns all elements of the source collection that are instances of the Class clazz. 
       RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
      Co-variant example for MutableCollection: 
       MutableCollection<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
      Specified by:
      selectInstancesOf in interface ListIterable<T>
      Specified by:
      selectInstancesOf in interface MutableCollection<T>
      Specified by:
      selectInstancesOf in interface MutableList<T>
      Specified by:
      selectInstancesOf in interface OrderedIterable<T>
      Specified by:
      selectInstancesOf in interface ReversibleIterable<T>
      Specified by:
      selectInstancesOf in interface RichIterable<T>
      Overrides:
      selectInstancesOf in class AbstractListAdapter<T>

    • distinct

      public MutableList<T> distinct()
      Description copied from interface: MutableList
      Returns a new ListIterable containing the distinct elements in this list.
      Specified by:
      distinct in interface ListIterable<T>
      Specified by:
      distinct in interface MutableList<T>
      Specified by:
      distinct in interface OrderedIterable<T>
      Specified by:
      distinct in interface ReversibleIterable<T>
      Returns:
      ListIterable of distinct elements

    • distinct

      public MutableList<T> distinct​(HashingStrategy<? super T> hashingStrategy)
      Description copied from interface: MutableList
      Returns a new ListIterable containing the distinct elements in this list. Takes HashingStrategy.
      Specified by:
      distinct in interface ListIterable<T>
      Specified by:
      distinct in interface MutableList<T>
      Returns:
      ListIterable of distinct elements

    • 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.

    • takeWhile

      public MutableList<T> takeWhile​(Predicate<? super T> predicate)
      Description copied from interface: ListIterable
      Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.
      Specified by:
      takeWhile in interface ListIterable<T>
      Specified by:
      takeWhile in interface MutableList<T>
      Specified by:
      takeWhile in interface OrderedIterable<T>
      Specified by:
      takeWhile in interface ReversibleIterable<T>

    • 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.

    • dropWhile

      public MutableList<T> dropWhile​(Predicate<? super T> predicate)
      Description copied from interface: ListIterable
      Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.
      Specified by:
      dropWhile in interface ListIterable<T>
      Specified by:
      dropWhile in interface MutableList<T>
      Specified by:
      dropWhile in interface OrderedIterable<T>
      Specified by:
      dropWhile in interface ReversibleIterable<T>

    • partitionWhile

      public PartitionMutableList<T> partitionWhile​(Predicate<? super T> predicate)
      Description copied from interface: ListIterable
      Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.
      Specified by:
      partitionWhile in interface ListIterable<T>
      Specified by:
      partitionWhile in interface MutableList<T>
      Specified by:
      partitionWhile in interface OrderedIterable<T>
      Specified by:
      partitionWhile in interface ReversibleIterable<T>

    • toStack

      public MutableStack<T> toStack()
      Description copied from interface: OrderedIterable
      Converts the OrderedIterable to a mutable MutableStack implementation.
      Specified by:
      toStack in interface OrderedIterable<T>
      Overrides:
      toStack in class AbstractListAdapter<T>

    • asParallel

      public ParallelListIterable<T> asParallel​(ExecutorService executorService, int batchSize)
      Description copied from interface: ListIterable
      Returns a parallel iterable of this ListIterable.
      Specified by:
      asParallel in interface ListIterable<T>
      Overrides:
      asParallel in class AbstractListAdapter<T>