Class UnmodifiableMutableList<T>

    • Constructor Detail

      • UnmodifiableMutableList

        UnmodifiableMutableList​(MutableList<? extends T> mutableList)
    • Method Detail

      • of

        public static <E,​L extends java.util.List<E>> UnmodifiableMutableList<E> of​(L list)
        This method will take a MutableList and wrap it directly in a UnmodifiableMutableList. It will take any other non-Eclipse-Collections list and first adapt it will a ListAdapter, and then return a UnmodifiableMutableList that wraps the adapter.
      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from interface: ListIterable
        Follows the same general contract as List.equals(Object).
        Specified by:
        equals in interface java.util.Collection<T>
        Specified by:
        equals in interface java.util.List<T>
        Specified by:
        equals in interface ListIterable<T>
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Description copied from interface: ListIterable
        Follows the same general contract as List.hashCode().
        Specified by:
        hashCode in interface java.util.Collection<T>
        Specified by:
        hashCode in interface java.util.List<T>
        Specified by:
        hashCode in interface ListIterable<T>
        Overrides:
        hashCode in class java.lang.Object
      • asUnmodifiable

        public MutableList<T> asUnmodifiable()
        Description copied from interface: MutableCollection
        Returns an unmodifiable view of this collection. This is the equivalent of using Collections.unmodifiableCollection(this) with a return type that supports the full iteration protocols available on MutableCollection. Methods which would mutate the underlying collection will throw UnsupportedOperationExceptions.
        Specified by:
        asUnmodifiable in interface MutableCollection<T>
        Specified by:
        asUnmodifiable in interface MutableList<T>
        Overrides:
        asUnmodifiable in class AbstractUnmodifiableMutableCollection<T>
        Returns:
        an unmodifiable view of this collection.
        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>
        Overrides:
        asSynchronized in class AbstractUnmodifiableMutableCollection<T>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)
      • 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>
      • 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>
      • 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​(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>
      • sortThis

        public UnmodifiableMutableList<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>
      • reverseThis

        public MutableList<T> reverseThis()
        Description copied from interface: MutableList
        Mutates this list by reversing its order and returns the current list as a result.
        Specified by:
        reverseThis in interface MutableList<T>
      • shuffleThis

        public MutableList<T> shuffleThis​(java.util.Random rnd)
        Description copied from interface: MutableList
        Mutates this list by shuffling its elements using the specified random.
        Specified by:
        shuffleThis in interface MutableList<T>
      • sortThisBy

        public <V extends java.lang.Comparable<? super V>> MutableList<T> sortThisBy​(Function<? super T,​? extends V> function)
        Description copied from interface: MutableList
        Sorts the internal data structure of this list based on the natural order of the attribute returned by function.
        Specified by:
        sortThisBy in interface MutableList<T>
      • replaceAll

        public void replaceAll​(java.util.function.UnaryOperator<T> operator)
        Specified by:
        replaceAll in interface java.util.List<T>
        Since:
        10.0 - Overridden for correctness
      • sort

        public void sort​(java.util.Comparator<? super T> comparator)
        Specified by:
        sort in interface java.util.List<T>
        Since:
        10.0 - Overridden for correctness
      • addAll

        public boolean addAll​(int index,
                              java.util.Collection<? extends T> collection)
        Specified by:
        addAll in interface java.util.List<T>
      • get

        public T get​(int index)
        Description copied from interface: ListIterable
        Returns the item at the specified position in this list iterable.
        Specified by:
        get in interface java.util.List<T>
        Specified by:
        get in interface ListIterable<T>
      • set

        public T set​(int index,
                     T element)
        Specified by:
        set in interface java.util.List<T>
      • add

        public void add​(int index,
                        T element)
        Specified by:
        add in interface java.util.List<T>
      • remove

        public T remove​(int index)
        Specified by:
        remove in interface java.util.List<T>
      • indexOf

        public int indexOf​(java.lang.Object o)
        Description copied from interface: OrderedIterable
        Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
        Specified by:
        indexOf in interface java.util.List<T>
        Specified by:
        indexOf in interface OrderedIterable<T>
        See Also:
        List.indexOf(Object)
      • lastIndexOf

        public int lastIndexOf​(java.lang.Object o)
        Description copied from interface: ListIterable
        Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
        Specified by:
        lastIndexOf in interface java.util.List<T>
        Specified by:
        lastIndexOf in interface ListIterable<T>
      • listIterator

        public java.util.ListIterator<T> listIterator()
        Specified by:
        listIterator in interface java.util.List<T>
        Specified by:
        listIterator in interface ListIterable<T>
        See Also:
        List.listIterator()
      • listIterator

        public java.util.ListIterator<T> listIterator​(int index)
        Specified by:
        listIterator in interface java.util.List<T>
        Specified by:
        listIterator in interface ListIterable<T>
        See Also:
        List.listIterator(int)
      • collectWith

        public <P,​A> MutableList<A> collectWith​(Function2<? super T,​? super P,​? extends A> function,
                                                      P parameter)
        Description copied from interface: MutableCollection
        Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

        Example using a Java 8 lambda expression:

         RichIterable<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
         

        Example using an anonymous inner class:

         Function2<Integer, Integer, Integer> addParameterFunction =
             new Function2<Integer, Integer, Integer>()
             {
                 public Integer value(Integer each, Integer parameter)
                 {
                     return each + parameter;
                 }
             };
         RichIterable<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
         
        Co-variant example for MutableCollection:
         MutableCollection<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
         
        Specified by:
        collectWith in interface ListIterable<T>
        Specified by:
        collectWith in interface MutableCollection<T>
        Specified by:
        collectWith in interface MutableList<T>
        Specified by:
        collectWith in interface OrderedIterable<T>
        Specified by:
        collectWith in interface ReversibleIterable<T>
        Specified by:
        collectWith in interface RichIterable<T>
        Overrides:
        collectWith in class AbstractUnmodifiableMutableCollection<T>
        Parameters:
        function - A Function2 to use as the collect transformation function
        parameter - A parameter to pass in for evaluation of the second argument P in function
        Returns:
        A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
        See Also:
        RichIterable.collect(Function)
      • 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 AbstractUnmodifiableMutableCollection<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • 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>
      • groupBy

        public <V> MutableListMultimap<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);
         

        Example using an anonymous inner class:

         Multimap<String, Person> peopleByLastName =
             people.groupBy(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return 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 AbstractUnmodifiableMutableCollection<T>
      • partition

        public PartitionMutableList<T> partition​(Predicate<? super T> predicate)
        Description copied from interface: MutableCollection
        Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

        Example using a Java 8 lambda expression:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partition(person -> person.getAddress().getState().getName().equals("New York"));
         

        Example using an anonymous inner class:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partition(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getState().getName().equals("New York");
                 }
             });
         
        Co-variant example for MutableCollection:
         PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
             people.partition(person -> person.getAddress().getState().getName().equals("New York"));
         
        Specified by:
        partition in interface ListIterable<T>
        Specified by:
        partition in interface MutableCollection<T>
        Specified by:
        partition in interface MutableList<T>
        Specified by:
        partition in interface OrderedIterable<T>
        Specified by:
        partition in interface ReversibleIterable<T>
        Specified by:
        partition in interface RichIterable<T>
        Overrides:
        partition in class AbstractUnmodifiableMutableCollection<T>
      • partitionWith

        public <P> PartitionMutableList<T> partitionWith​(Predicate2<? super T,​? super P> predicate,
                                                         P parameter)
        Description copied from interface: MutableCollection
        Filters a collection into a PartitionIterable based on the evaluation of the predicate.

        Example using a Java 8 lambda expression:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
         

        Example using an anonymous inner class:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partitionWith(new Predicate2<Person, String>()
             {
                 public boolean accept(Person person, String state)
                 {
                     return person.getAddress().getState().getName().equals(state);
                 }
             }, "New York");
         
        Co-variant example for MutableCollection:
         PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
             people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
         
        Specified by:
        partitionWith in interface ListIterable<T>
        Specified by:
        partitionWith in interface MutableCollection<T>
        Specified by:
        partitionWith in interface MutableList<T>
        Specified by:
        partitionWith in interface OrderedIterable<T>
        Specified by:
        partitionWith in interface ReversibleIterable<T>
        Specified by:
        partitionWith in interface RichIterable<T>
        Overrides:
        partitionWith in class AbstractUnmodifiableMutableCollection<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 AbstractUnmodifiableMutableCollection<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.
      • asParallel

        public ParallelListIterable<T> asParallel​(java.util.concurrent.ExecutorService executorService,
                                                  int batchSize)
        Description copied from interface: ListIterable
        Returns a parallel iterable of this ListIterable.
        Specified by:
        asParallel in interface ListIterable<T>
      • with

        public MutableList<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>
        Overrides:
        with in class AbstractUnmodifiableMutableCollection<T>
        See Also:
        Collection.add(Object)
      • without

        public MutableList<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>
        Overrides:
        without in class AbstractUnmodifiableMutableCollection<T>
        See Also:
        Collection.remove(Object)
      • withAll

        public MutableList<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>
        Overrides:
        withAll in class AbstractUnmodifiableMutableCollection<T>
        See Also:
        Collection.addAll(Collection)
      • withoutAll

        public MutableList<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>
        Overrides:
        withoutAll in class AbstractUnmodifiableMutableCollection<T>
        See Also:
        Collection.removeAll(Collection)
      • writeReplace

        protected java.lang.Object writeReplace()