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

Class IntHashBag

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractIntIterable

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

All Implemented Interfaces:

Externalizable, Serializable, IntBag, MutableIntBag, MutableIntCollection, IntIterable, PrimitiveIterable

public class IntHashBag
extends AbstractIntIterable
implements MutableIntBag, Externalizable

IntHashBag is similar to HashBag, and is memory-optimized for int primitives. This file was automatically generated from template file primitiveHashBag.stg.

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IntHashBag()
IntHashBag(int size)
IntHashBag(int... elements)
IntHashBag(IntIterable iterable)
IntHashBag(IntHashBag bag)

Method Summary

Modifier and Type	Method	Description
boolean	add(int item)
boolean	addAll(int... source)
boolean	addAll(IntIterable source)
void	addOccurrences(int item, int occurrences)
boolean	allSatisfy(IntPredicate predicate)	Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(IntPredicate predicate)	Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
MutableIntBag	asSynchronized()
MutableIntBag	asUnmodifiable()
MutableList<IntIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
RichIterable<IntIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<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	contains(int value)	Returns true if the value is contained in the IntIterable, and false if it is not.
int	count(IntPredicate predicate)	Returns a count of the number of elements in the IntIterable that return true for the specified predicate.
int	detectIfNone(IntPredicate predicate, int ifNone)
void	each(IntProcedure procedure)	A synonym for forEach.
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().
<T> T	injectInto(T injectedValue, ObjectIntToObjectFunction<? super T,? extends T> function)
MutableIntIterator	intIterator()	Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.
boolean	isEmpty()	Returns true if this iterable has zero items.
int	max()
int	min()
static IntHashBag	newBag(int size)
static IntHashBag	newBag(IntBag source)
static IntHashBag	newBag(IntIterable source)
static IntHashBag	newBagWith(int... source)
IntHashBag	newEmpty()	Creates a new empty IntHashBag.
boolean	noneSatisfy(IntPredicate predicate)	Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
int	occurrencesOf(int item)	The occurrences of a distinct item in the bag.
void	readExternal(ObjectInput in)
IntHashBag	reject(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
boolean	remove(int item)
boolean	removeAll(int... source)
boolean	removeAll(IntIterable source)
boolean	removeIf(IntPredicate predicate)
boolean	removeOccurrences(int item, int occurrences)
boolean	retainAll(int... source)
boolean	retainAll(IntIterable source)
IntHashBag	select(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
IntHashBag	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
MutableIntSet	selectUnique()	Returns all elements of the bag that have exactly one occurrence.
int	size()	Returns the number of items in this iterable.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
long	sum()
int[]	toArray()	Converts the IntIterable to a primitive int array.
int[]	toArray(int[] array)	Converts the IntIterable to a primitive int array.
ImmutableIntBag	toImmutable()	Returns an immutable copy of this bag.
MutableList<IntIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.
IntHashBag	with(int element)
IntHashBag	with(int element1, int element2)
IntHashBag	with(int element1, int element2, int element3)
IntHashBag	withAll(IntIterable iterable)
IntHashBag	without(int element)
IntHashBag	withoutAll(IntIterable iterable)
void	writeExternal(ObjectOutput out)

Methods inherited from class org.eclipse.collections.impl.primitive.AbstractIntIterable

asLazy, average, maxIfEmpty, median, minIfEmpty, 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.bag.primitive.IntBag

toStringOfItemToCount

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

asLazy, average, averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, maxIfEmpty, median, medianIfEmpty, minIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface org.eclipse.collections.api.bag.primitive.MutableIntBag

selectDuplicates, tap

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

appendString, appendString, makeString, makeString, makeString, toString

Constructor Details

IntHashBag

public IntHashBag()

IntHashBag

public IntHashBag(int size)

IntHashBag

public IntHashBag(IntIterable iterable)

IntHashBag

public IntHashBag(int... elements)

IntHashBag

public IntHashBag(IntHashBag bag)

Method Details

newBag

public static IntHashBag newBag(int size)

newBagWith

public static IntHashBag newBagWith(int... source)

newBag

public static IntHashBag newBag(IntIterable source)

newBag

public static IntHashBag newBag(IntBag source)

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

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

clear

public void clear()

Specified by:

clear in interface MutableIntCollection

with

public IntHashBag with(int element)

Specified by:

with in interface MutableIntBag

Specified by:

with in interface MutableIntCollection

with

public IntHashBag with(int element1,
 int element2)

with

public IntHashBag with(int element1,
 int element2,
 int element3)

withAll

public IntHashBag withAll(IntIterable iterable)

Specified by:

withAll in interface MutableIntBag

Specified by:

withAll in interface MutableIntCollection

without

public IntHashBag without(int element)

Specified by:

without in interface MutableIntBag

Specified by:

without in interface MutableIntCollection

withoutAll

public IntHashBag withoutAll(IntIterable iterable)

Specified by:

withoutAll in interface MutableIntBag

Specified by:

withoutAll in interface MutableIntCollection

contains

public boolean contains(int value)

Description copied from interface: IntIterable

Returns true if the value is contained in the IntIterable, and false if it is not.

Specified by:

contains in interface IntIterable

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 IntHashBag 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

selectUnique

public MutableIntSet selectUnique()

Description copied from interface: MutableIntBag

Returns all elements of the bag that have exactly one occurrence.

Specified by:

selectUnique in interface IntBag

Specified by:

selectUnique 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

add

public boolean add(int item)

Specified by:

add in interface MutableIntCollection

remove

public boolean remove(int item)

Specified by:

remove in interface MutableIntCollection

removeIf

public boolean removeIf(IntPredicate predicate)

Specified by:

removeIf in interface MutableIntCollection

addAll

public boolean addAll(int... source)

Specified by:

addAll in interface MutableIntCollection

addAll

public boolean addAll(IntIterable source)

Specified by:

addAll in interface MutableIntCollection

removeAll

public boolean removeAll(int... source)

Specified by:

removeAll in interface MutableIntCollection

removeAll

public boolean removeAll(IntIterable source)

Specified by:

removeAll in interface MutableIntCollection

retainAll

public boolean retainAll(IntIterable source)

Specified by:

retainAll in interface MutableIntCollection

See Also:

• Collection.retainAll(Collection)

retainAll

public boolean retainAll(int... source)

Specified by:

retainAll in interface MutableIntCollection

See Also:

• Collection.retainAll(Collection)

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

each

public void each(IntProcedure procedure)

Description copied from interface: IntIterable

A synonym for forEach.

Specified by:

each in interface IntIterable

Since:

7.0.

select

public IntHashBag 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 IntIterable

Specified by:

select in interface MutableIntBag

Specified by:

select in interface MutableIntCollection

reject

public IntHashBag 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 IntIterable

Specified by:

reject in interface MutableIntBag

Specified by:

reject in interface MutableIntCollection

injectInto

public <T> T injectInto(T injectedValue,
 ObjectIntToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface IntIterable

chunk

public RichIterable<IntIterable> chunk(int size)

Description copied from interface: IntIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface IntIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing IntIterables of size size, except the last will be truncated if the elements don't divide evenly.

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

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

count

public int count(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a count of the number of elements in the IntIterable that return true for the specified predicate.

Specified by:

count in interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface IntIterable

noneSatisfy

public boolean noneSatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

noneSatisfy in interface IntIterable

detectIfNone

public int detectIfNone(IntPredicate predicate,
 int ifNone)

Specified by:

detectIfNone in interface IntIterable

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 IntIterable

Specified by:

collect in interface MutableIntBag

Specified by:

collect in interface MutableIntCollection

max

public int max()

Specified by:

max in interface IntIterable

min

public int min()

Specified by:

min in interface IntIterable

sum

public long sum()

Specified by:

sum in interface IntIterable

toArray

public int[] toArray()

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array.

Specified by:

toArray in interface IntIterable

toArray

public int[] toArray(int[] array)

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface IntIterable

asUnmodifiable

public MutableIntBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableIntBag

Specified by:

asUnmodifiable in interface MutableIntCollection

asSynchronized

public MutableIntBag asSynchronized()

Specified by:

asSynchronized in interface MutableIntBag

Specified by:

asSynchronized in interface MutableIntCollection

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

newEmpty

public IntHashBag newEmpty()

Creates a new empty IntHashBag.

Specified by:

newEmpty in interface MutableIntBag

Specified by:

newEmpty in interface MutableIntCollection

Since:

9.2.

intIterator

public MutableIntIterator intIterator()

Description copied from interface: IntIterable

Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.

Specified by:

intIterator in interface IntIterable

Specified by:

intIterator in interface MutableIntCollection

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException