org.eclipse.collections.impl.bag.mutable.primitive

Class UnmodifiableIntBag

java.lang.Object

org.eclipse.collections.impl.collection.mutable.primitive.AbstractUnmodifiableIntCollection

org.eclipse.collections.impl.bag.mutable.primitive.UnmodifiableIntBag

All Implemented Interfaces:

Serializable, IntBag, MutableIntBag, MutableIntCollection, IntIterable, PrimitiveIterable

@NotThreadSafe
public final class UnmodifiableIntBag
extends AbstractUnmodifiableIntCollection
implements MutableIntBag

This file was automatically generated from template file unmodifiablePrimitiveBag.stg.

Since:

3.1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnmodifiableIntBag(MutableIntBag bag)

Method Summary

Modifier and Type	Method and Description
void	addOccurrences(int item, int occurrences)
MutableIntBag	asSynchronized()
MutableIntBag	asUnmodifiable()
MutableList<IntIntPair>	bottomOccurrences(int count) Returns the count least frequently occurring items.
<V> MutableBag<V>	collect(IntToObjectFunction<? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	equals(Object otherBag) Follows the same general contract as Bag.equals(Object).
void	forEachWithOccurrences(IntIntProcedure procedure) For each distinct item, with the number of occurrences, execute the specified procedure.
int	hashCode() Follows the same general contract as Bag.hashCode().
int	occurrencesOf(int item) The occurrences of a distinct item in the bag.
MutableIntBag	reject(IntPredicate predicate) Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
boolean	removeOccurrences(int item, int occurrences)
MutableIntBag	select(IntPredicate predicate) Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
MutableIntBag	selectByOccurrences(IntPredicate predicate) Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
int	sizeDistinct() The size of the Bag when counting only distinct elements.
ImmutableIntBag	toImmutable() Returns an immutable copy of this bag.
MutableList<IntIntPair>	topOccurrences(int count) Returns the count most frequently occurring items.
UnmodifiableIntBag	with(int element)
UnmodifiableIntBag	withAll(IntIterable elements)
UnmodifiableIntBag	without(int element)
UnmodifiableIntBag	withoutAll(IntIterable elements)

Methods inherited from class org.eclipse.collections.impl.collection.mutable.primitive.AbstractUnmodifiableIntCollection

add, addAll, addAll, allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, average, clear, contains, containsAll, containsAll, count, detectIfNone, each, forEach, injectInto, intIterator, isEmpty, makeString, makeString, makeString, max, maxIfEmpty, median, min, minIfEmpty, noneSatisfy, notEmpty, remove, removeAll, removeAll, retainAll, retainAll, size, sum, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.collection.primitive.MutableIntCollection

add, addAll, addAll, clear, intIterator, remove, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface org.eclipse.collections.api.IntIterable

allSatisfy, anySatisfy, asLazy, average, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, max, maxIfEmpty, median, min, minIfEmpty, noneSatisfy, reject, select, sum, summaryStatistics, toArray, toBag, toList, toSet, toSortedArray, toSortedList

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString

Constructor Detail

UnmodifiableIntBag

public UnmodifiableIntBag(MutableIntBag bag)

Method Detail

with

public UnmodifiableIntBag with(int element)

Specified by:

with in interface MutableIntBag

Specified by:

with in interface MutableIntCollection

Overrides:

with in class AbstractUnmodifiableIntCollection

without

public UnmodifiableIntBag without(int element)

Specified by:

without in interface MutableIntBag

Specified by:

without in interface MutableIntCollection

Overrides:

without in class AbstractUnmodifiableIntCollection

withAll

public UnmodifiableIntBag withAll(IntIterable elements)

Specified by:

withAll in interface MutableIntBag

Specified by:

withAll in interface MutableIntCollection

Overrides:

withAll in class AbstractUnmodifiableIntCollection

withoutAll

public UnmodifiableIntBag withoutAll(IntIterable elements)

Specified by:

withoutAll in interface MutableIntBag

Specified by:

withoutAll in interface MutableIntCollection

Overrides:

withoutAll in class AbstractUnmodifiableIntCollection

addOccurrences

public void addOccurrences(int item,
                           int occurrences)

Specified by:

addOccurrences in interface MutableIntBag

removeOccurrences

public boolean removeOccurrences(int item,
                                 int occurrences)

Specified by:

removeOccurrences in interface MutableIntBag

sizeDistinct

public int sizeDistinct()

Description copied from interface: IntBag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface IntBag

occurrencesOf

public int occurrencesOf(int item)

Description copied from interface: IntBag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface IntBag

forEachWithOccurrences

public void forEachWithOccurrences(IntIntProcedure procedure)

Description copied from interface: IntBag

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

Specified by:

forEachWithOccurrences in interface IntBag

selectByOccurrences

public MutableIntBag selectByOccurrences(IntPredicate predicate)

Description copied from interface: MutableIntBag

Returns all elements of the bag that have a number of occurrences that satisfy the predicate.

Specified by:

selectByOccurrences in interface IntBag

Specified by:

selectByOccurrences in interface MutableIntBag

topOccurrences

public MutableList<IntIntPair> topOccurrences(int count)

Description copied from interface: MutableIntBag

Returns the count most 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:

topOccurrences in interface IntBag

Specified by:

topOccurrences in interface MutableIntBag

bottomOccurrences

public MutableList<IntIntPair> bottomOccurrences(int count)

Description copied from interface: MutableIntBag

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 IntBag

Specified by:

bottomOccurrences in interface MutableIntBag

select

public MutableIntBag select(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.

Specified by:

select in interface IntBag

Specified by:

select in interface MutableIntBag

Specified by:

select in interface MutableIntCollection

Specified by:

select in interface IntIterable

Overrides:

select in class AbstractUnmodifiableIntCollection

reject

public MutableIntBag reject(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.

Specified by:

reject in interface IntBag

Specified by:

reject in interface MutableIntBag

Specified by:

reject in interface MutableIntCollection

Specified by:

reject in interface IntIterable

Overrides:

reject in class AbstractUnmodifiableIntCollection

collect

public <V> MutableBag<V> collect(IntToObjectFunction<? extends V> function)

Description copied from interface: IntIterable

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.

Specified by:

collect in interface IntBag

Specified by:

collect in interface MutableIntBag

Specified by:

collect in interface MutableIntCollection

Specified by:

collect in interface IntIterable

Overrides:

collect in class AbstractUnmodifiableIntCollection

equals

public boolean equals(Object otherBag)

Description copied from interface: IntBag

Follows the same general contract as Bag.equals(Object).

Specified by:

equals in interface IntBag

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: IntBag

Follows the same general contract as Bag.hashCode().

Specified by:

hashCode in interface IntBag

Overrides:

hashCode in class Object

asUnmodifiable

public MutableIntBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableIntBag

Specified by:

asUnmodifiable in interface MutableIntCollection

Overrides:

asUnmodifiable in class AbstractUnmodifiableIntCollection

asSynchronized

public MutableIntBag asSynchronized()

Specified by:

asSynchronized in interface MutableIntBag

Specified by:

asSynchronized in interface MutableIntCollection

Overrides:

asSynchronized in class AbstractUnmodifiableIntCollection

toImmutable

public ImmutableIntBag toImmutable()

Description copied from interface: MutableIntBag

Returns an immutable copy of this bag.

Specified by:

toImmutable in interface IntBag

Specified by:

toImmutable in interface MutableIntBag

Specified by:

toImmutable in interface MutableIntCollection

Overrides:

toImmutable in class AbstractUnmodifiableIntCollection