Implements java.util.Collection.add.

Doc from java.util.Collection.add.

Ensures that this collection contains the specified element (optional operation). Returns true if this collection changed as a result of the call. (Returns false if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Annotations

@Override

Implements org.eclipse.collections.api.bag.MutableBagIterable.addOccurrences.

Doc from org.eclipse.collections.api.bag.MutableBagIterable.addOccurrences.

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

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.allSatisfyWithOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.allSatisfyWithOccurrences.

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.

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.anySatisfyWithOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.anySatisfyWithOccurrences.

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.

Annotations

@Override

Implements java.util.Collection.clear.

Doc from java.util.Collection.clear.

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

Annotations

@Override

Overrides org.eclipse.collections.impl.AbstractRichIterable.contains.

Implements org.eclipse.collections.api.RichIterable.contains, java.util.Collection.contains.

Doc from org.eclipse.collections.api.RichIterable.contains.

Returns true if the iterable has an element which responds true to element.equals(object).

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.detectWithOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.detectWithOccurrences.

Returns an element of the Bag that satisfies the predicate or null if such an element does not exist

Annotations

@Override

Overrides default org.eclipse.collections.api.bag.Bag.distinctView.

Doc from org.eclipse.collections.api.bag.Bag.distinctView.

Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.

Annotations

@Override

Implements org.eclipse.collections.api.RichIterable.each.

Doc from org.eclipse.collections.api.RichIterable.each.

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

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

Annotations

@Override

Overrides java.lang.Object.equals.

Implements org.eclipse.collections.api.bag.Bag.equals, java.util.Collection.equals.

Doc from org.eclipse.collections.api.bag.Bag.equals.

Two bags b1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).

Annotations

@Override

Overrides org.eclipse.collections.impl.AbstractRichIterable.forEachWith.

Implements org.eclipse.collections.api.InternalIterable.forEachWith.

Doc from org.eclipse.collections.api.InternalIterable.forEachWith.

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

Example using a Java 8 lambda:

people.forEachWith((Person person, Person other) ->
    {
        if (person.isRelatedTo(other))
        {
             LOGGER.info(person.getName());
        }
    }, fred);

Example using an anonymous inner class:

people.forEachWith(new Procedure2<Person, Person>()
{
    public void value(Person person, Person other)
    {
        if (person.isRelatedTo(other))
        {
             LOGGER.info(person.getName());
        }
    }
}, fred);

Annotations

@Override

Overrides org.eclipse.collections.impl.AbstractRichIterable.forEachWithIndex.

Implements org.eclipse.collections.api.InternalIterable.forEachWithIndex.

Doc from org.eclipse.collections.api.InternalIterable.forEachWithIndex.

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

Example using a Java 8 lambda:

people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));

Example using an anonymous inner class:

people.forEachWithIndex(new ObjectIntProcedure<Person>()
{
    public void value(Person person, int index)
    {
        LOGGER.info("Index: " + index + " person: " + person.getName());
    }
});

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.forEachWithOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.forEachWithOccurrences.

For each distinct item, with the number of occurrences, execute the specified procedure.

Annotations

@Override

Implements org.eclipse.collections.api.bag.MutableBag.groupBy, org.eclipse.collections.api.bag.MutableBagIterable.groupBy, org.eclipse.collections.api.bag.Bag.groupBy, org.eclipse.collections.api.RichIterable.groupBy.

Doc from org.eclipse.collections.api.RichIterable.groupBy.

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

Annotations

@Override

Implements org.eclipse.collections.api.bag.MutableBag.groupByEach, org.eclipse.collections.api.bag.MutableBagIterable.groupByEach, org.eclipse.collections.api.bag.Bag.groupByEach, org.eclipse.collections.api.RichIterable.groupByEach.

Doc from org.eclipse.collections.api.RichIterable.groupByEach.

Similar to groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Implements org.eclipse.collections.api.bag.Bag.hashCode, java.util.Collection.hashCode.

Doc from org.eclipse.collections.api.bag.Bag.hashCode.

Returns the hash code for this Bag, defined as this.toMapOfItemToCount().hashCode().

Annotations

@Override

Overrides org.eclipse.collections.impl.AbstractRichIterable.isEmpty.

Implements org.eclipse.collections.api.RichIterable.isEmpty, java.util.Collection.isEmpty.

Doc from org.eclipse.collections.api.RichIterable.isEmpty.

Returns true if this iterable has zero items.

Annotations

@Override

Implements java.lang.Iterable.iterator, java.util.Collection.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.noneSatisfyWithOccurrences.

Doc from org.eclipse.collections.api.bag.Bag.noneSatisfyWithOccurrences.

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.

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.occurrencesOf.

Doc from org.eclipse.collections.api.bag.Bag.occurrencesOf.

The occurrences of a distinct item in the bag.

Annotations

@Override

Implements java.util.Collection.remove.

Doc from java.util.Collection.remove.

Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call).

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.removeAllIterable.

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.removeIf.

Doc from org.eclipse.collections.api.collection.MutableCollection.removeIf.

Removes all elements in the collection that evaluate to true for the specified predicate.

e.g.
return lastNames.removeIf(Predicates.isNull());

Annotations

@Override

Implements org.eclipse.collections.api.collection.MutableCollection.removeIfWith.

Doc from org.eclipse.collections.api.collection.MutableCollection.removeIfWith.

Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.

return lastNames.removeIfWith(Predicates2.isNull(), null);

Annotations

@Override

Implements org.eclipse.collections.api.bag.MutableBagIterable.removeOccurrences.

Annotations

@Override

Implements org.eclipse.collections.api.bag.MutableBagIterable.setOccurrences.

Annotations

@Override

Implements org.eclipse.collections.api.RichIterable.size, java.util.Collection.size.

Doc from org.eclipse.collections.api.RichIterable.size.

Returns the number of items in this iterable.

Annotations

@Override

Implements org.eclipse.collections.api.bag.Bag.sizeDistinct.

Doc from org.eclipse.collections.api.bag.Bag.sizeDistinct.

The size of the Bag when counting only distinct elements.

Annotations

@Override

Implements org.eclipse.collections.api.bag.MutableBag.toMapOfItemToCount, org.eclipse.collections.api.bag.MutableBagIterable.toMapOfItemToCount, org.eclipse.collections.api.bag.Bag.toMapOfItemToCount.

Doc from org.eclipse.collections.api.bag.Bag.toMapOfItemToCount.

Converts the Bag to a Map of the Item type to its count as an Integer.

Annotations

@Override