Interface MutableSortedBag<T>

    • Method Detail

      • with

        default MutableSortedBag<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 MutableBagIterable<T>
        Specified by:
        with in interface MutableCollection<T>
        See Also:
        Collection.add(Object)
      • without

        default MutableSortedBag<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 MutableBagIterable<T>
        Specified by:
        without in interface MutableCollection<T>
        See Also:
        Collection.remove(Object)
      • withAll

        default MutableSortedBag<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 MutableBagIterable<T>
        Specified by:
        withAll in interface MutableCollection<T>
        See Also:
        Collection.addAll(Collection)
      • withoutAll

        default MutableSortedBag<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 MutableBagIterable<T>
        Specified by:
        withoutAll in interface MutableCollection<T>
        See Also:
        Collection.removeAll(Collection)
      • newEmpty

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

        MutableSortedBag<T> asUnmodifiable()
        Returns an unmodifiable view of the set.
        Specified by:
        asUnmodifiable in interface MutableCollection<T>
        Returns:
        an unmodifiable view of this set
        See Also:
        Collections.unmodifiableCollection(Collection)
      • asSynchronized

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

        MutableSortedBag<T> select​(Predicate<? super T> predicate)
        Description copied from interface: RichIterable
        Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

        Example using a Java 8 lambda expression:

         RichIterable<Person> selected =
             people.select(person -> person.getAddress().getCity().equals("London"));
         

        Example using an anonymous inner class:

         RichIterable<Person> selected =
             people.select(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getCity().equals("London");
                 }
             });
         
        Specified by:
        select in interface Bag<T>
        Specified by:
        select in interface MutableBagIterable<T>
        Specified by:
        select in interface MutableCollection<T>
        Specified by:
        select in interface OrderedIterable<T>
        Specified by:
        select in interface ReversibleIterable<T>
        Specified by:
        select in interface RichIterable<T>
        Specified by:
        select in interface SortedBag<T>
        Specified by:
        select in interface SortedIterable<T>
      • reject

        MutableSortedBag<T> reject​(Predicate<? super T> predicate)
        Description copied from interface: RichIterable
        Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

        Example using a Java 8 lambda expression:

         RichIterable<Person> rejected =
             people.reject(person -> person.person.getLastName().equals("Smith"));
         

        Example using an anonymous inner class:

         RichIterable<Person> rejected =
             people.reject(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             });
         
        Specified by:
        reject in interface Bag<T>
        Specified by:
        reject in interface MutableBagIterable<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>
        Specified by:
        reject in interface SortedBag<T>
        Specified by:
        reject in interface SortedIterable<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
      • collect

        <V> MutableList<V> collect​(Function<? super T,​? extends V> function)
        Description copied from interface: RichIterable
        Returns a new collection 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:

         RichIterable<String> names =
             people.collect(person -> person.getFirstName() + " " + person.getLastName());
         

        Example using an anonymous inner class:

         RichIterable<String> names =
             people.collect(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getFirstName() + " " + person.getLastName();
                 }
             });
         
        Specified by:
        collect in interface MutableCollection<T>
        Specified by:
        collect in interface OrderedIterable<T>
        Specified by:
        collect in interface ReversibleIterable<T>
        Specified by:
        collect in interface RichIterable<T>
        Specified by:
        collect in interface SortedBag<T>
      • collectBoolean

        MutableBooleanList collectBoolean​(BooleanFunction<? super T> booleanFunction)
        Description copied from interface: RichIterable
        Returns a new primitive boolean 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:

         BooleanIterable licenses =
             people.collectBoolean(person -> person.hasDrivingLicense());
         

        Example using an anonymous inner class:

         BooleanIterable licenses =
             people.collectBoolean(new BooleanFunction<Person>()
             {
                 public boolean booleanValueOf(Person person)
                 {
                     return person.hasDrivingLicense();
                 }
             });
         
        Specified by:
        collectBoolean in interface MutableCollection<T>
        Specified by:
        collectBoolean in interface OrderedIterable<T>
        Specified by:
        collectBoolean in interface ReversibleIterable<T>
        Specified by:
        collectBoolean in interface RichIterable<T>
        Specified by:
        collectBoolean in interface SortedBag<T>
      • collectByte

        MutableByteList collectByte​(ByteFunction<? super T> byteFunction)
        Description copied from interface: RichIterable
        Returns a new primitive byte 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:

         ByteIterable bytes =
             people.collectByte(person -> person.getCode());
         

        Example using an anonymous inner class:

         ByteIterable bytes =
             people.collectByte(new ByteFunction<Person>()
             {
                 public byte byteValueOf(Person person)
                 {
                     return person.getCode();
                 }
             });
         
        Specified by:
        collectByte in interface MutableCollection<T>
        Specified by:
        collectByte in interface OrderedIterable<T>
        Specified by:
        collectByte in interface ReversibleIterable<T>
        Specified by:
        collectByte in interface RichIterable<T>
        Specified by:
        collectByte in interface SortedBag<T>
      • collectChar

        MutableCharList collectChar​(CharFunction<? super T> charFunction)
        Description copied from interface: RichIterable
        Returns a new primitive char 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:

         CharIterable chars =
             people.collectChar(person -> person.getMiddleInitial());
         

        Example using an anonymous inner class:

         CharIterable chars =
             people.collectChar(new CharFunction<Person>()
             {
                 public char charValueOf(Person person)
                 {
                     return person.getMiddleInitial();
                 }
             });
         
        Specified by:
        collectChar in interface MutableCollection<T>
        Specified by:
        collectChar in interface OrderedIterable<T>
        Specified by:
        collectChar in interface ReversibleIterable<T>
        Specified by:
        collectChar in interface RichIterable<T>
        Specified by:
        collectChar in interface SortedBag<T>
      • collectDouble

        MutableDoubleList collectDouble​(DoubleFunction<? super T> doubleFunction)
        Description copied from interface: RichIterable
        Returns a new primitive double 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:

         DoubleIterable doubles =
             people.collectDouble(person -> person.getMilesFromNorthPole());
         

        Example using an anonymous inner class:

         DoubleIterable doubles =
             people.collectDouble(new DoubleFunction<Person>()
             {
                 public double doubleValueOf(Person person)
                 {
                     return person.getMilesFromNorthPole();
                 }
             });
         
        Specified by:
        collectDouble in interface MutableCollection<T>
        Specified by:
        collectDouble in interface OrderedIterable<T>
        Specified by:
        collectDouble in interface ReversibleIterable<T>
        Specified by:
        collectDouble in interface RichIterable<T>
        Specified by:
        collectDouble in interface SortedBag<T>
      • collectFloat

        MutableFloatList collectFloat​(FloatFunction<? super T> floatFunction)
        Description copied from interface: RichIterable
        Returns a new primitive float 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:

         FloatIterable floats =
             people.collectFloat(person -> person.getHeightInInches());
         

        Example using an anonymous inner class:

         FloatIterable floats =
             people.collectFloat(new FloatFunction<Person>()
             {
                 public float floatValueOf(Person person)
                 {
                     return person.getHeightInInches();
                 }
             });
         
        Specified by:
        collectFloat in interface MutableCollection<T>
        Specified by:
        collectFloat in interface OrderedIterable<T>
        Specified by:
        collectFloat in interface ReversibleIterable<T>
        Specified by:
        collectFloat in interface RichIterable<T>
        Specified by:
        collectFloat in interface SortedBag<T>
      • collectInt

        MutableIntList collectInt​(IntFunction<? super T> intFunction)
        Description copied from interface: RichIterable
        Returns a new primitive int 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:

         IntIterable ints =
             people.collectInt(person -> person.getAge());
         

        Example using an anonymous inner class:

         IntIterable ints =
             people.collectInt(new IntFunction<Person>()
             {
                 public int intValueOf(Person person)
                 {
                     return person.getAge();
                 }
             });
         
        Specified by:
        collectInt in interface MutableCollection<T>
        Specified by:
        collectInt in interface OrderedIterable<T>
        Specified by:
        collectInt in interface ReversibleIterable<T>
        Specified by:
        collectInt in interface RichIterable<T>
        Specified by:
        collectInt in interface SortedBag<T>
      • collectLong

        MutableLongList collectLong​(LongFunction<? super T> longFunction)
        Description copied from interface: RichIterable
        Returns a new primitive long 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:

         LongIterable longs =
             people.collectLong(person -> person.getGuid());
         

        Example using an anonymous inner class:

         LongIterable longs =
             people.collectLong(new LongFunction<Person>()
             {
                 public long longValueOf(Person person)
                 {
                     return person.getGuid();
                 }
             });
         
        Specified by:
        collectLong in interface MutableCollection<T>
        Specified by:
        collectLong in interface OrderedIterable<T>
        Specified by:
        collectLong in interface ReversibleIterable<T>
        Specified by:
        collectLong in interface RichIterable<T>
        Specified by:
        collectLong in interface SortedBag<T>
      • collectShort

        MutableShortList collectShort​(ShortFunction<? super T> shortFunction)
        Description copied from interface: RichIterable
        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());
         

        Example using an anonymous inner class:

         ShortIterable shorts =
             people.collectShort(new ShortFunction<Person>()
             {
                 public short shortValueOf(Person person)
                 {
                     return person.getNumberOfJunkMailItemsReceivedPerMonth();
                 }
             });
         
        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>
        Specified by:
        collectShort in interface SortedBag<T>
      • collectWith

        <P,​V> MutableList<V> collectWith​(Function2<? super T,​? super P,​? extends V> function,
                                               P parameter)
        Description copied from interface: RichIterable
        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));
         
        Specified by:
        collectWith in interface MutableCollection<T>
        Specified by:
        collectWith in interface OrderedIterable<T>
        Specified by:
        collectWith in interface ReversibleIterable<T>
        Specified by:
        collectWith in interface RichIterable<T>
        Specified by:
        collectWith in interface SortedBag<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)
      • collectIf

        <V> MutableList<V> collectIf​(Predicate<? super T> predicate,
                                     Function<? super T,​? extends V> function)
        Description copied from interface: RichIterable
        Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

        Example using a Java 8 lambda and method reference:

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
         

        Example using Predicates factory:

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
         
        Specified by:
        collectIf in interface MutableCollection<T>
        Specified by:
        collectIf in interface OrderedIterable<T>
        Specified by:
        collectIf in interface ReversibleIterable<T>
        Specified by:
        collectIf in interface RichIterable<T>
        Specified by:
        collectIf in interface SortedBag<T>
      • flatCollect

        <V> MutableList<V> flatCollect​(Function<? super T,​? extends java.lang.Iterable<V>> function)
        Description copied from interface: RichIterable
        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);
         
        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>
        Specified by:
        flatCollect in interface SortedBag<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • groupBy

        <V> MutableSortedBagMultimap<V,​T> groupBy​(Function<? super T,​? extends V> function)
        Description copied from interface: RichIterable
        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();
                 }
             });
         
        Specified by:
        groupBy in interface Bag<T>
        Specified by:
        groupBy in interface MutableBagIterable<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>
        Specified by:
        groupBy in interface SortedBag<T>
        Specified by:
        groupBy in interface SortedIterable<T>
      • countBy

        default <V> MutableBag<V> countBy​(Function<? super T,​? extends V> function)
        Description copied from interface: RichIterable
        This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
        Specified by:
        countBy in interface MutableCollection<T>
        Specified by:
        countBy in interface RichIterable<T>
        Since:
        9.0
      • countByWith

        default <V,​P> MutableBag<V> countByWith​(Function2<? super T,​? super P,​? extends V> function,
                                                      P parameter)
        Description copied from interface: RichIterable
        This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
        Specified by:
        countByWith in interface MutableCollection<T>
        Specified by:
        countByWith in interface RichIterable<T>
        Since:
        9.0
      • countByEach

        default <V> MutableBag<V> countByEach​(Function<? super T,​? extends java.lang.Iterable<V>> function)
        Description copied from interface: RichIterable
        This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
        Specified by:
        countByEach in interface MutableCollection<T>
        Specified by:
        countByEach in interface RichIterable<T>
        Since:
        10.0.0
      • zip

        <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 MutableCollection<T>
        Specified by:
        zip in interface OrderedIterable<T>
        Specified by:
        zip in interface ReversibleIterable<T>
        Specified by:
        zip in interface RichIterable<T>
        Specified by:
        zip in interface SortedIterable<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

        MutableSortedBag<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 ReversibleIterable<T>
        Specified by:
        take in interface SortedBag<T>
        Parameters:
        count - the number of items to take.
      • drop

        MutableSortedBag<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 ReversibleIterable<T>
        Specified by:
        drop in interface SortedBag<T>
        Parameters:
        count - the number of items to drop.