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

Class ShortHashBag

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractShortIterable

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

All Implemented Interfaces:

Externalizable, Serializable, MutableShortBag, ShortBag, MutableShortCollection, PrimitiveIterable, ShortIterable

public class ShortHashBag
extends AbstractShortIterable
implements MutableShortBag, Externalizable

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ShortHashBag()
ShortHashBag(int size)
ShortHashBag(short... elements)
ShortHashBag(ShortIterable iterable)
ShortHashBag(ShortHashBag bag)

Method Summary

Modifier and Type	Method	Description
boolean	add(short item)
boolean	addAll(short... source)
boolean	addAll(ShortIterable source)
void	addOccurrences(short item, int occurrences)
boolean	allSatisfy(ShortPredicate predicate)	Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(ShortPredicate predicate)	Returns true if any of the elements in the ShortIterable 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.
MutableShortBag	asSynchronized()
MutableShortBag	asUnmodifiable()
MutableList<ShortIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
RichIterable<ShortIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<V> MutableBag<V>	collect(ShortToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	contains(short value)	Returns true if the value is contained in the ShortIterable, and false if it is not.
int	count(ShortPredicate predicate)	Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
short	detectIfNone(ShortPredicate predicate, short ifNone)
void	each(ShortProcedure procedure)	A synonym for forEach.
boolean	equals(Object otherBag)	Follows the same general contract as Bag.equals(Object).
void	forEachWithOccurrences(ShortIntProcedure 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, ObjectShortToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
short	max()
short	min()
static ShortHashBag	newBag(int size)
static ShortHashBag	newBag(ShortBag source)
static ShortHashBag	newBag(ShortIterable source)
static ShortHashBag	newBagWith(short... source)
ShortHashBag	newEmpty()	Creates a new empty ShortHashBag.
boolean	noneSatisfy(ShortPredicate predicate)	Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
int	occurrencesOf(short item)	The occurrences of a distinct item in the bag.
void	readExternal(ObjectInput in)
ShortHashBag	reject(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
boolean	remove(short item)
boolean	removeAll(short... source)
boolean	removeAll(ShortIterable source)
boolean	removeIf(ShortPredicate predicate)
boolean	removeOccurrences(short item, int occurrences)
boolean	retainAll(short... source)
boolean	retainAll(ShortIterable source)
ShortHashBag	select(ShortPredicate predicate)	Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
ShortHashBag	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
MutableShortSet	selectUnique()	Returns all elements of the bag that have exactly one occurrence.
MutableShortIterator	shortIterator()	Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.
int	size()	Returns the number of items in this iterable.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
long	sum()
short[]	toArray()	Converts the ShortIterable to a primitive short array.
short[]	toArray(short[] array)	Converts the ShortIterable to a primitive short array.
ImmutableShortBag	toImmutable()	Returns an immutable copy of this bag.
MutableList<ShortIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.
ShortHashBag	with(short element)
ShortHashBag	with(short element1, short element2)
ShortHashBag	with(short element1, short element2, short element3)
ShortHashBag	withAll(ShortIterable iterable)
ShortHashBag	without(short element)
ShortHashBag	withoutAll(ShortIterable iterable)
void	writeExternal(ObjectOutput out)

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

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.MutableShortBag

selectDuplicates, tap

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

appendString, appendString, makeString, makeString, makeString, toString

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

toStringOfItemToCount

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

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

Constructor Details

ShortHashBag

public ShortHashBag()

ShortHashBag

public ShortHashBag(int size)

ShortHashBag

public ShortHashBag(ShortIterable iterable)

ShortHashBag

public ShortHashBag(short... elements)

ShortHashBag

public ShortHashBag(ShortHashBag bag)

Method Details

newBag

public static ShortHashBag newBag(int size)

newBagWith

public static ShortHashBag newBagWith(short... source)

newBag

public static ShortHashBag newBag(ShortIterable source)

newBag

public static ShortHashBag newBag(ShortBag 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: ShortBag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface ShortBag

clear

public void clear()

Specified by:

clear in interface MutableShortCollection

with

public ShortHashBag with(short element)

Specified by:

with in interface MutableShortBag

Specified by:

with in interface MutableShortCollection

with

public ShortHashBag with(short element1,
 short element2)

with

public ShortHashBag with(short element1,
 short element2,
 short element3)

withAll

public ShortHashBag withAll(ShortIterable iterable)

Specified by:

withAll in interface MutableShortBag

Specified by:

withAll in interface MutableShortCollection

without

public ShortHashBag without(short element)

Specified by:

without in interface MutableShortBag

Specified by:

without in interface MutableShortCollection

withoutAll

public ShortHashBag withoutAll(ShortIterable iterable)

Specified by:

withoutAll in interface MutableShortBag

Specified by:

withoutAll in interface MutableShortCollection

contains

public boolean contains(short value)

Description copied from interface: ShortIterable

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

Specified by:

contains in interface ShortIterable

occurrencesOf

public int occurrencesOf(short item)

Description copied from interface: ShortBag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface ShortBag

forEachWithOccurrences

public void forEachWithOccurrences(ShortIntProcedure procedure)

Description copied from interface: ShortBag

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

Specified by:

forEachWithOccurrences in interface ShortBag

selectByOccurrences

public ShortHashBag selectByOccurrences(IntPredicate predicate)

Description copied from interface: MutableShortBag

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

Specified by:

selectByOccurrences in interface MutableShortBag

Specified by:

selectByOccurrences in interface ShortBag

selectUnique

public MutableShortSet selectUnique()

Description copied from interface: MutableShortBag

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

Specified by:

selectUnique in interface MutableShortBag

Specified by:

selectUnique in interface ShortBag

topOccurrences

public MutableList<ShortIntPair> topOccurrences(int count)

Description copied from interface: MutableShortBag

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 MutableShortBag

Specified by:

topOccurrences in interface ShortBag

bottomOccurrences

public MutableList<ShortIntPair> bottomOccurrences(int count)

Description copied from interface: MutableShortBag

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 MutableShortBag

Specified by:

bottomOccurrences in interface ShortBag

add

public boolean add(short item)

Specified by:

add in interface MutableShortCollection

remove

public boolean remove(short item)

Specified by:

remove in interface MutableShortCollection

removeIf

public boolean removeIf(ShortPredicate predicate)

Specified by:

removeIf in interface MutableShortCollection

addAll

public boolean addAll(short... source)

Specified by:

addAll in interface MutableShortCollection

addAll

public boolean addAll(ShortIterable source)

Specified by:

addAll in interface MutableShortCollection

removeAll

public boolean removeAll(short... source)

Specified by:

removeAll in interface MutableShortCollection

removeAll

public boolean removeAll(ShortIterable source)

Specified by:

removeAll in interface MutableShortCollection

retainAll

public boolean retainAll(ShortIterable source)

Specified by:

retainAll in interface MutableShortCollection

See Also:

• Collection.retainAll(Collection)

retainAll

public boolean retainAll(short... source)

Specified by:

retainAll in interface MutableShortCollection

See Also:

• Collection.retainAll(Collection)

addOccurrences

public void addOccurrences(short item,
 int occurrences)

Specified by:

addOccurrences in interface MutableShortBag

removeOccurrences

public boolean removeOccurrences(short item,
 int occurrences)

Specified by:

removeOccurrences in interface MutableShortBag

each

public void each(ShortProcedure procedure)

Description copied from interface: ShortIterable

A synonym for forEach.

Specified by:

each in interface ShortIterable

Since:

7.0.

select

public ShortHashBag select(ShortPredicate predicate)

Description copied from interface: ShortIterable

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

Specified by:

select in interface MutableShortBag

Specified by:

select in interface MutableShortCollection

Specified by:

select in interface ShortBag

Specified by:

select in interface ShortIterable

reject

public ShortHashBag reject(ShortPredicate predicate)

Description copied from interface: ShortIterable

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

Specified by:

reject in interface MutableShortBag

Specified by:

reject in interface MutableShortCollection

Specified by:

reject in interface ShortBag

Specified by:

reject in interface ShortIterable

injectInto

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

Specified by:

injectInto in interface ShortIterable

chunk

public RichIterable<ShortIterable> chunk(int size)

Description copied from interface: ShortIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface ShortIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing ShortIterables 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: ShortBag

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

Specified by:

equals in interface ShortBag

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ShortBag

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

Specified by:

hashCode in interface ShortBag

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

Description copied from interface: ShortIterable

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

Specified by:

count in interface ShortIterable

anySatisfy

public boolean anySatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

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

Specified by:

anySatisfy in interface ShortIterable

allSatisfy

public boolean allSatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

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

Specified by:

allSatisfy in interface ShortIterable

noneSatisfy

public boolean noneSatisfy(ShortPredicate predicate)

Description copied from interface: ShortIterable

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

Specified by:

noneSatisfy in interface ShortIterable

detectIfNone

public short detectIfNone(ShortPredicate predicate,
 short ifNone)

Specified by:

detectIfNone in interface ShortIterable

collect

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

Description copied from interface: ShortIterable

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 MutableShortBag

Specified by:

collect in interface MutableShortCollection

Specified by:

collect in interface ShortBag

Specified by:

collect in interface ShortIterable

max

public short max()

Specified by:

max in interface ShortIterable

min

public short min()

Specified by:

min in interface ShortIterable

sum

public long sum()

Specified by:

sum in interface ShortIterable

toArray

public short[] toArray()

Description copied from interface: ShortIterable

Converts the ShortIterable to a primitive short array.

Specified by:

toArray in interface ShortIterable

toArray

public short[] toArray(short[] array)

Description copied from interface: ShortIterable

Converts the ShortIterable to a primitive short 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 ShortIterable

asUnmodifiable

public MutableShortBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableShortBag

Specified by:

asUnmodifiable in interface MutableShortCollection

asSynchronized

public MutableShortBag asSynchronized()

Specified by:

asSynchronized in interface MutableShortBag

Specified by:

asSynchronized in interface MutableShortCollection

toImmutable

public ImmutableShortBag toImmutable()

Description copied from interface: MutableShortBag

Returns an immutable copy of this bag.

Specified by:

toImmutable in interface MutableShortBag

Specified by:

toImmutable in interface MutableShortCollection

Specified by:

toImmutable in interface ShortBag

newEmpty

public ShortHashBag newEmpty()

Creates a new empty ShortHashBag.

Specified by:

newEmpty in interface MutableShortBag

Specified by:

newEmpty in interface MutableShortCollection

Since:

9.2.

shortIterator

public MutableShortIterator shortIterator()

Description copied from interface: ShortIterable

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

Specified by:

shortIterator in interface MutableShortCollection

Specified by:

shortIterator in interface ShortIterable

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