Interface MutableList<T>

    • Method Detail

      • with

        default 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>
        See Also:
        Collection.add(Object)
      • without

        default 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>
        See Also:
        Collection.remove(Object)
      • withAll

        default MutableList<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>
        See Also:
        Collection.addAll(Collection)
      • withoutAll

        default MutableList<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>
        See Also:
        Collection.removeAll(Collection)
      • newEmpty

        MutableList<T> newEmpty()
        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>
      • reject

        default MutableList<T> reject​(Predicate<? super T> predicate)
        Description copied from interface: MutableCollection
        Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
         MutableCollection<Person> notSmiths =
             people.reject(person -> person.person.getLastName().equals("Smith"));
         
        Using the Predicates factory:
         MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
         
        Specified by:
        reject in interface ListIterable<T>
        Specified by:
        reject in interface MutableCollection<T>
        Specified by:
        reject in interface OrderedIterable<T>
        Specified by:
        reject in interface ReversibleIterable<T>
        Specified by:
        reject in interface RichIterable<T>
        Parameters:
        predicate - a Predicate to use as the reject criteria
        Returns:
        a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false
      • partition

        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"));
         
        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 OrderedIterable<T>
        Specified by:
        partition in interface ReversibleIterable<T>
        Specified by:
        partition in interface RichIterable<T>
      • partitionWith

        <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");
         
        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 OrderedIterable<T>
        Specified by:
        partitionWith in interface ReversibleIterable<T>
        Specified by:
        partitionWith in interface RichIterable<T>
      • selectWithIndex

        default MutableList<T> selectWithIndex​(ObjectIntPredicate<? super T> predicate)
        Returns a new MutableList with all elements of the collection that return true when evaluating the specified predicate which is supplied each element and its relative index.
        Specified by:
        selectWithIndex in interface ListIterable<T>
        Since:
        11.0
      • rejectWithIndex

        default MutableList<T> rejectWithIndex​(ObjectIntPredicate<? super T> predicate)
        Returns a new MutableList with all elements of the collection that return false when evaluating the specified predicate which is supplied each element and its relative index.
        Specified by:
        rejectWithIndex in interface ListIterable<T>
        Since:
        11.0
      • collectShort

        default MutableShortList collectShort​(ShortFunction<? super T> shortFunction)
        Description copied from interface: MutableCollection
        Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

        Example using a Java 8 lambda expression:

         ShortIterable shorts =
             people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
         
        Co-variant example for MutableCollection:
         MutableShortCollection shorts =
             people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
         
        Specified by:
        collectShort in interface ListIterable<T>
        Specified by:
        collectShort in interface MutableCollection<T>
        Specified by:
        collectShort in interface OrderedIterable<T>
        Specified by:
        collectShort in interface ReversibleIterable<T>
        Specified by:
        collectShort in interface RichIterable<T>
      • flatCollect

        default <V> MutableList<V> flatCollect​(Function<? super T,​? extends 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 OrderedIterable<T>
        Specified by:
        flatCollect in interface ReversibleIterable<T>
        Specified by:
        flatCollect in interface RichIterable<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • distinct

        MutableList<T> distinct​(HashingStrategy<? super T> hashingStrategy)
        Returns a new ListIterable containing the distinct elements in this list. Takes HashingStrategy.
        Specified by:
        distinct in interface ListIterable<T>
        Returns:
        ListIterable of distinct elements
        Since:
        7.0
      • sortThis

        default MutableList<T> sortThis​(Comparator<? super T> comparator)
        Sorts the internal data structure of this list and returns the list itself as a convenience.
        Since:
        10.0 - Added default implementation.
      • sortThis

        default MutableList<T> sortThis()
        Sorts the internal data structure of this list and returns the list itself as a convenience.
        Since:
        10.0 - Added default implementation.
      • sortThisBy

        default <V extends Comparable<? super V>> MutableList<T> sortThisBy​(Function<? super T,​? extends V> function)
        Sorts the internal data structure of this list based on the natural order of the attribute returned by function.
      • asSynchronized

        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>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)
      • groupBy

        <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);
         
        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 OrderedIterable<T>
        Specified by:
        groupBy in interface ReversibleIterable<T>
        Specified by:
        groupBy in interface RichIterable<T>
      • zip

        <S> MutableList<Pair<T,​S>> zip​(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 OrderedIterable<T>
        Specified by:
        zip in interface ReversibleIterable<T>
        Specified by:
        zip in interface RichIterable<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

        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 ReversibleIterable<T>
        Parameters:
        count - the number of items to take.
      • drop

        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 ReversibleIterable<T>
        Parameters:
        count - the number of items to drop.
      • reverseThis

        default MutableList<T> reverseThis()
        Mutates this list by reversing its order and returns the current list as a result.
      • shuffleThis

        default MutableList<T> shuffleThis()
        Mutates this list by shuffling its elements.
      • shuffleThis

        default MutableList<T> shuffleThis​(Random random)
        Mutates this list by shuffling its elements using the specified random.