Class SynchronizedBag<T>

    • Constructor Detail

      • SynchronizedBag

        SynchronizedBag​(MutableBag<T> bag)
      • SynchronizedBag

        public SynchronizedBag​(MutableBag<T> bag,
                               java.lang.Object newLock)
    • Method Detail

      • of

        public static <E,​B extends MutableBag<E>> SynchronizedBag<E> of​(B bag)
        This method will take a MutableBag and wrap it directly in a SynchronizedBag.
      • of

        public static <E,​B extends MutableBag<E>> SynchronizedBag<E> of​(B bag,
                                                                              java.lang.Object lock)
        This method will take a MutableBag and wrap it directly in a SynchronizedBag. Additionally, a developer specifies which lock to use with the collection.
      • newEmpty

        public MutableBag<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 MutableBag<T>
        Specified by:
        newEmpty in interface MutableCollection<T>
      • writeReplace

        protected java.lang.Object writeReplace()
      • addOccurrences

        public int addOccurrences​(T item,
                                  int occurrences)
        Description copied from interface: MutableBagIterable
        Add number of occurrences for an item. If the item does not exist, then the item is added to the bag.

        For Example:

         MutableBagIterable<String> names = Bags.mutable.of("A", "B", "B");
         Assert.assertEquals(4, names.addOccurrences("A", 3));
         
        Specified by:
        addOccurrences in interface MutableBagIterable<T>
        Returns:
        updated number of occurrences.
      • topOccurrences

        public MutableList<ObjectIntPair<T>> topOccurrences​(int count)
        Description copied from interface: Bag
        Returns the count most frequently occurring items. In the event of a tie, all the items with the number of occurrences that match the occurrences of the last item will be returned.
        Specified by:
        topOccurrences in interface Bag<T>
        Specified by:
        topOccurrences in interface MutableBagIterable<T>
      • bottomOccurrences

        public MutableList<ObjectIntPair<T>> bottomOccurrences​(int count)
        Description copied from interface: Bag
        Returns the count least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.
        Specified by:
        bottomOccurrences in interface Bag<T>
        Specified by:
        bottomOccurrences in interface MutableBagIterable<T>
      • anySatisfyWithOccurrences

        public boolean anySatisfyWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns true if the predicate evaluates to true for any element of the Bag. Returns false if the Bag is empty or if no element returns true for the predicate.
        Specified by:
        anySatisfyWithOccurrences in interface Bag<T>
      • allSatisfyWithOccurrences

        public boolean allSatisfyWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns true if the predicate evaluates to true for all elements of the Bag. Returns false if the Bag is empty or if not all elements return true for the predicate.
        Specified by:
        allSatisfyWithOccurrences in interface Bag<T>
      • noneSatisfyWithOccurrences

        public boolean noneSatisfyWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns true if the Bag is empty or if the predicate evaluates to false for all elements of the Bag. Returns false if the predicate evaluates to true for at least one element of the Bag.
        Specified by:
        noneSatisfyWithOccurrences in interface Bag<T>
      • detectWithOccurrences

        public T detectWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns an element of the Bag that satisfies the predicate or null if such an element does not exist
        Specified by:
        detectWithOccurrences in interface Bag<T>
      • forEachWithOccurrences

        public void forEachWithOccurrences​(ObjectIntProcedure<? super T> objectIntProcedure)
        Description copied from interface: Bag
        For each distinct item, with the number of occurrences, execute the specified procedure.
        Specified by:
        forEachWithOccurrences in interface Bag<T>
      • collectWithOccurrences

        public <V,​R extends java.util.Collection<V>> R collectWithOccurrences​(ObjectIntToObjectFunction<? super T,​? extends V> function,
                                                                                    R target)
        Description copied from interface: Bag
        Iterates over the unique elements and their occurrences and collects the results of applying the specified function into the target collection.
        Specified by:
        collectWithOccurrences in interface Bag<T>
        Since:
        9.1.
      • occurrencesOf

        public int occurrencesOf​(java.lang.Object item)
        Description copied from interface: Bag
        The occurrences of a distinct item in the bag.
        Specified by:
        occurrencesOf in interface Bag<T>
      • sizeDistinct

        public int sizeDistinct()
        Description copied from interface: Bag
        The size of the Bag when counting only distinct elements.
        Specified by:
        sizeDistinct in interface Bag<T>
      • toStringOfItemToCount

        public java.lang.String toStringOfItemToCount()
        Description copied from interface: Bag
        Returns a string representation of this bag. The string representation consists of a list of element-count mappings.
         Assert.assertEquals("{1=1, 2=2, 3=3}", Bags.mutable.with(1, 2, 2, 3, 3, 3).toStringOfItemToCount());
         
        This string representation is similar to AbstractMap.toString(), not RichIterable.toString(), whereas the toString() implementation for a Bag is consistent with RichIterable.toString().
        Specified by:
        toStringOfItemToCount in interface Bag<T>
        Returns:
        a string representation of this bag
      • select

        public MutableBag<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 MutableBag<T>
        Specified by:
        select in interface MutableBagIterable<T>
        Specified by:
        select in interface MutableCollection<T>
        Specified by:
        select in interface RichIterable<T>
        Specified by:
        select in interface UnsortedBag<T>
        Overrides:
        select in class AbstractSynchronizedMutableCollection<T>
      • reject

        public MutableBag<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 MutableBag<T>
        Specified by:
        reject in interface MutableBagIterable<T>
        Specified by:
        reject in interface MutableCollection<T>
        Specified by:
        reject in interface RichIterable<T>
        Specified by:
        reject in interface UnsortedBag<T>
        Overrides:
        reject in class AbstractSynchronizedMutableCollection<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
      • partitionWith

        public <P> PartitionMutableBag<T> partitionWith​(Predicate2<? super T,​? super P> predicate,
                                                        P parameter)
        Description copied from interface: RichIterable
        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");
         
        Specified by:
        partitionWith in interface Bag<T>
        Specified by:
        partitionWith in interface MutableBag<T>
        Specified by:
        partitionWith in interface MutableBagIterable<T>
        Specified by:
        partitionWith in interface MutableCollection<T>
        Specified by:
        partitionWith in interface RichIterable<T>
        Overrides:
        partitionWith in class AbstractSynchronizedMutableCollection<T>
      • collectChar

        public MutableCharBag 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 MutableBag<T>
        Specified by:
        collectChar in interface MutableCollection<T>
        Specified by:
        collectChar in interface RichIterable<T>
        Specified by:
        collectChar in interface UnsortedBag<T>
        Overrides:
        collectChar in class AbstractSynchronizedMutableCollection<T>
      • collectInt

        public MutableIntBag 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 MutableBag<T>
        Specified by:
        collectInt in interface MutableCollection<T>
        Specified by:
        collectInt in interface RichIterable<T>
        Specified by:
        collectInt in interface UnsortedBag<T>
        Overrides:
        collectInt in class AbstractSynchronizedMutableCollection<T>
      • collectShort

        public MutableShortBag 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 MutableBag<T>
        Specified by:
        collectShort in interface MutableCollection<T>
        Specified by:
        collectShort in interface RichIterable<T>
        Specified by:
        collectShort in interface UnsortedBag<T>
        Overrides:
        collectShort in class AbstractSynchronizedMutableCollection<T>
      • collect

        public <V> MutableBag<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 MutableBag<T>
        Specified by:
        collect in interface MutableCollection<T>
        Specified by:
        collect in interface RichIterable<T>
        Specified by:
        collect in interface UnsortedBag<T>
        Overrides:
        collect in class AbstractSynchronizedMutableCollection<T>
      • collectWith

        public <P,​V> MutableBag<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 MutableBag<T>
        Specified by:
        collectWith in interface MutableCollection<T>
        Specified by:
        collectWith in interface RichIterable<T>
        Specified by:
        collectWith in interface UnsortedBag<T>
        Overrides:
        collectWith in class AbstractSynchronizedMutableCollection<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

        public <V> MutableBag<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 MutableBag<T>
        Specified by:
        collectIf in interface MutableCollection<T>
        Specified by:
        collectIf in interface RichIterable<T>
        Specified by:
        collectIf in interface UnsortedBag<T>
        Overrides:
        collectIf in class AbstractSynchronizedMutableCollection<T>
      • flatCollect

        public <V> MutableBag<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 MutableBag<T>
        Specified by:
        flatCollect in interface MutableCollection<T>
        Specified by:
        flatCollect in interface RichIterable<T>
        Specified by:
        flatCollect in interface UnsortedBag<T>
        Overrides:
        flatCollect in class AbstractSynchronizedMutableCollection<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • groupBy

        public <V> MutableBagMultimap<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 MutableBag<T>
        Specified by:
        groupBy in interface MutableBagIterable<T>
        Specified by:
        groupBy in interface MutableCollection<T>
        Specified by:
        groupBy in interface RichIterable<T>
        Specified by:
        groupBy in interface UnsortedBag<T>
        Overrides:
        groupBy in class AbstractSynchronizedMutableCollection<T>
      • zip

        @Deprecated
        public <S> MutableBag<Pair<T,​S>> zip​(java.lang.Iterable<S> that)
        Deprecated.
        in 6.0. Use OrderedIterable.zip(Iterable) instead.
        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 MutableBag<T>
        Specified by:
        zip in interface MutableCollection<T>
        Specified by:
        zip in interface RichIterable<T>
        Specified by:
        zip in interface UnsortedBag<T>
        Overrides:
        zip in class AbstractSynchronizedMutableCollection<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.
      • asUnmodifiable

        public MutableBag<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 MutableBag<T>
        Specified by:
        asUnmodifiable in interface MutableCollection<T>
        Returns:
        an unmodifiable view of this collection.
        See Also:
        Collections.unmodifiableCollection(Collection)
      • asSynchronized

        public MutableBag<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 MutableBag<T>
        Specified by:
        asSynchronized in interface MutableCollection<T>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)
      • distinctView

        public RichIterable<T> distinctView()
        Description copied from interface: Bag
        Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.
        Specified by:
        distinctView in interface Bag<T>
        Returns:
        an unmodifiable view on the distinct elements of the Bag.