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

@NotThreadSafe
public final 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 and Description
IntHashBag()
IntHashBag(int... elements)
IntHashBag(int size)
IntHashBag(IntHashBag bag)
IntHashBag(IntIterable iterable)

Method Summary

Modifier and Type	Method and Description
boolean	add(int item)
boolean	addAll(int... source)
boolean	addAll(IntIterable source)
void	addOccurrences(int item, int occurrences)
boolean	allSatisfy(IntPredicate predicate)
boolean	anySatisfy(IntPredicate predicate)
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.
void	clear()
<V> MutableBag<V>	collect(IntToObjectFunction<? extends V> function)
boolean	contains(int value)
int	count(IntPredicate predicate)
int	detectIfNone(IntPredicate predicate, int ifNone)
void	each(IntProcedure procedure)
boolean	equals(Object otherBag) Follows the same general contract as Bag.equals(Object).
void	forEach(IntProcedure procedure)
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()
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)
boolean	noneSatisfy(IntPredicate predicate)
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)
boolean	remove(int item)
boolean	removeAll(int... source)
boolean	removeAll(IntIterable source)
boolean	removeOccurrences(int item, int occurrences)
boolean	retainAll(int... source)
boolean	retainAll(IntIterable source)
IntHashBag	select(IntPredicate predicate)
IntHashBag	selectByOccurrences(IntPredicate predicate) Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
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()
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, containsAll, containsAll, 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.IntIterable

asLazy, average, containsAll, containsAll, maxIfEmpty, median, minIfEmpty, summaryStatistics, toBag, toList, toSet, toSortedArray, toSortedList

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

appendString, appendString, makeString, makeString, makeString, toString

Constructor Detail

IntHashBag

public IntHashBag()

IntHashBag

public IntHashBag(int size)

IntHashBag

public IntHashBag(IntIterable iterable)

IntHashBag

public IntHashBag(int... elements)

IntHashBag

public IntHashBag(IntHashBag bag)

Method Detail

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)

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

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

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

forEach

public void forEach(IntProcedure procedure)

Specified by:

forEach in interface IntIterable

each

public void each(IntProcedure procedure)

Specified by:

each in interface IntIterable

Since:

7.0.

select

public IntHashBag select(IntPredicate 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

reject

public IntHashBag reject(IntPredicate 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

injectInto

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

Specified by:

injectInto in interface IntIterable

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)

Specified by:

count in interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

Specified by:

anySatisfy in interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

Specified by:

allSatisfy in interface IntIterable

noneSatisfy

public boolean noneSatisfy(IntPredicate predicate)

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)

Specified by:

collect in interface IntBag

Specified by:

collect in interface MutableIntBag

Specified by:

collect in interface MutableIntCollection

Specified by:

collect in interface IntIterable

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

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

intIterator

public MutableIntIterator intIterator()

Specified by:

intIterator in interface MutableIntCollection

Specified by:

intIterator in interface IntIterable

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