com.gs.collections.impl.bag.mutable.primitive

Class IntHashBag

java.lang.Object

com.gs.collections.impl.bag.mutable.primitive.IntHashBag

All Implemented Interfaces:

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

@NotThreadSafe
public final class IntHashBag
extends Object
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 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) Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator) Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end) Prints a string representation of this collection onto the given Appendable.
LazyIntIterable	asLazy()
MutableIntBag	asSynchronized()
MutableIntBag	asUnmodifiable()
double	average()
void	clear()
<V> MutableBag<V>	collect(IntToObjectFunction<? extends V> function)
boolean	contains(int value)
boolean	containsAll(int... source)
boolean	containsAll(IntIterable source)
int	count(IntPredicate predicate)
int	detectIfNone(IntPredicate predicate, int ifNone)
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)
IntIterator	intIterator()
boolean	isEmpty() Returns true if this iterable has zero items.
String	makeString() Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator) Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end) Returns a string representation of this collection.
int	max()
int	maxIfEmpty(int defaultValue)
double	median()
int	min()
int	minIfEmpty(int defaultValue)
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)
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()
MutableIntBag	toBag()
ImmutableIntBag	toImmutable() Returns an immutable copy of this bag.
MutableIntList	toList()
MutableIntSet	toSet()
int[]	toSortedArray()
MutableIntList	toSortedList()
String	toString() Returns a string representation of this PrimitiveIterable.
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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IntHashBag

public IntHashBag()

IntHashBag

public IntHashBag(int size)

IntHashBag

public IntHashBag(IntIterable iterable)

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

containsAll

public boolean containsAll(int... source)

Specified by:

containsAll in interface IntIterable

containsAll

public boolean containsAll(IntIterable source)

Specified by:

containsAll 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

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

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

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this PrimitiveIterable. The string representation consists of a list of the PrimitiveIterable's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf().

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveIterable

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
                         String separator,
                         String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings using the appropriate version of String.valueOf().

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
                         String separator)

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

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

minIfEmpty

public int minIfEmpty(int defaultValue)

Specified by:

minIfEmpty in interface IntIterable

maxIfEmpty

public int maxIfEmpty(int defaultValue)

Specified by:

maxIfEmpty in interface IntIterable

average

public double average()

Specified by:

average in interface IntIterable

median

public double median()

Specified by:

median in interface IntIterable

toArray

public int[] toArray()

Specified by:

toArray in interface IntIterable

toSortedArray

public int[] toSortedArray()

Specified by:

toSortedArray in interface IntIterable

toList

public MutableIntList toList()

Specified by:

toList in interface IntIterable

toSortedList

public MutableIntList toSortedList()

Specified by:

toSortedList in interface IntIterable

toSet

public MutableIntSet toSet()

Specified by:

toSet in interface IntIterable

toBag

public MutableIntBag toBag()

Specified by:

toBag in interface IntIterable

asLazy

public LazyIntIterable asLazy()

Specified by:

asLazy 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 IntIterator intIterator()

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