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

Class ByteHashBag

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractByteIterable

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

All Implemented Interfaces:

Externalizable, Serializable, ByteBag, MutableByteBag, ByteIterable, MutableByteCollection, PrimitiveIterable

public class ByteHashBag
extends AbstractByteIterable
implements MutableByteBag, Externalizable

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ByteHashBag()
ByteHashBag(byte... elements)
ByteHashBag(int size)
ByteHashBag(ByteIterable iterable)
ByteHashBag(ByteHashBag bag)

Method Summary

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

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

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

toStringOfItemToCount

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

asLazy, average, averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, flatCollect, 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.MutableByteBag

selectDuplicates, tap

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

appendString, appendString, makeString, makeString, makeString, toString

Constructor Details

ByteHashBag

public ByteHashBag()

ByteHashBag

public ByteHashBag(int size)

ByteHashBag

public ByteHashBag(ByteIterable iterable)

ByteHashBag

public ByteHashBag(byte... elements)

ByteHashBag

public ByteHashBag(ByteHashBag bag)

Method Details

newBag

public static ByteHashBag newBag(int size)

newBagWith

public static ByteHashBag newBagWith(byte... source)

newBag

public static ByteHashBag newBag(ByteIterable source)

newBag

public static ByteHashBag newBag(ByteBag 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: ByteBag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface ByteBag

clear

public void clear()

Specified by:

clear in interface MutableByteCollection

with

public ByteHashBag with(byte element)

Specified by:

with in interface MutableByteBag

Specified by:

with in interface MutableByteCollection

with

public ByteHashBag with(byte element1,
 byte element2)

with

public ByteHashBag with(byte element1,
 byte element2,
 byte element3)

withAll

public ByteHashBag withAll(ByteIterable iterable)

Specified by:

withAll in interface MutableByteBag

Specified by:

withAll in interface MutableByteCollection

without

public ByteHashBag without(byte element)

Specified by:

without in interface MutableByteBag

Specified by:

without in interface MutableByteCollection

withoutAll

public ByteHashBag withoutAll(ByteIterable iterable)

Specified by:

withoutAll in interface MutableByteBag

Specified by:

withoutAll in interface MutableByteCollection

contains

public boolean contains(byte value)

Description copied from interface: ByteIterable

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

Specified by:

contains in interface ByteIterable

occurrencesOf

public int occurrencesOf(byte item)

Description copied from interface: ByteBag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface ByteBag

forEachWithOccurrences

public void forEachWithOccurrences(ByteIntProcedure procedure)

Description copied from interface: ByteBag

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

Specified by:

forEachWithOccurrences in interface ByteBag

selectByOccurrences

public ByteHashBag selectByOccurrences(IntPredicate predicate)

Description copied from interface: MutableByteBag

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

Specified by:

selectByOccurrences in interface ByteBag

Specified by:

selectByOccurrences in interface MutableByteBag

selectUnique

public MutableByteSet selectUnique()

Description copied from interface: MutableByteBag

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

Specified by:

selectUnique in interface ByteBag

Specified by:

selectUnique in interface MutableByteBag

topOccurrences

public MutableList<ByteIntPair> topOccurrences(int count)

Description copied from interface: MutableByteBag

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 ByteBag

Specified by:

topOccurrences in interface MutableByteBag

bottomOccurrences

public MutableList<ByteIntPair> bottomOccurrences(int count)

Description copied from interface: MutableByteBag

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 ByteBag

Specified by:

bottomOccurrences in interface MutableByteBag

add

public boolean add(byte item)

Specified by:

add in interface MutableByteCollection

remove

public boolean remove(byte item)

Specified by:

remove in interface MutableByteCollection

removeIf

public boolean removeIf(BytePredicate predicate)

Specified by:

removeIf in interface MutableByteCollection

addAll

public boolean addAll(byte... source)

Specified by:

addAll in interface MutableByteCollection

addAll

public boolean addAll(ByteIterable source)

Specified by:

addAll in interface MutableByteCollection

removeAll

public boolean removeAll(byte... source)

Specified by:

removeAll in interface MutableByteCollection

removeAll

public boolean removeAll(ByteIterable source)

Specified by:

removeAll in interface MutableByteCollection

retainAll

public boolean retainAll(ByteIterable source)

Specified by:

retainAll in interface MutableByteCollection

See Also:

• Collection.retainAll(Collection)

retainAll

public boolean retainAll(byte... source)

Specified by:

retainAll in interface MutableByteCollection

See Also:

• Collection.retainAll(Collection)

addOccurrences

public void addOccurrences(byte item,
 int occurrences)

Specified by:

addOccurrences in interface MutableByteBag

removeOccurrences

public boolean removeOccurrences(byte item,
 int occurrences)

Specified by:

removeOccurrences in interface MutableByteBag

forEach

public void forEach(ByteProcedure procedure)

Description copied from interface: ByteIterable

Applies the ByteProcedure to each element in the ByteIterable.

Specified by:

forEach in interface ByteIterable

each

public void each(ByteProcedure procedure)

Description copied from interface: ByteIterable

A synonym for forEach.

Specified by:

each in interface ByteIterable

Since:

7.0.

select

public ByteHashBag select(BytePredicate predicate)

Description copied from interface: ByteIterable

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

Specified by:

select in interface ByteBag

Specified by:

select in interface ByteIterable

Specified by:

select in interface MutableByteBag

Specified by:

select in interface MutableByteCollection

reject

public ByteHashBag reject(BytePredicate predicate)

Description copied from interface: ByteIterable

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

Specified by:

reject in interface ByteBag

Specified by:

reject in interface ByteIterable

Specified by:

reject in interface MutableByteBag

Specified by:

reject in interface MutableByteCollection

injectInto

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

Specified by:

injectInto in interface ByteIterable

chunk

public RichIterable<ByteIterable> chunk(int size)

Description copied from interface: ByteIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface ByteIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing ByteIterables 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: ByteBag

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

Specified by:

equals in interface ByteBag

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ByteBag

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

Specified by:

hashCode in interface ByteBag

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

Description copied from interface: ByteIterable

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

Specified by:

count in interface ByteIterable

anySatisfy

public boolean anySatisfy(BytePredicate predicate)

Description copied from interface: ByteIterable

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

Specified by:

anySatisfy in interface ByteIterable

allSatisfy

public boolean allSatisfy(BytePredicate predicate)

Description copied from interface: ByteIterable

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

Specified by:

allSatisfy in interface ByteIterable

noneSatisfy

public boolean noneSatisfy(BytePredicate predicate)

Description copied from interface: ByteIterable

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

Specified by:

noneSatisfy in interface ByteIterable

detectIfNone

public byte detectIfNone(BytePredicate predicate,
 byte ifNone)

Specified by:

detectIfNone in interface ByteIterable

collect

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

Description copied from interface: ByteIterable

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 ByteBag

Specified by:

collect in interface ByteIterable

Specified by:

collect in interface MutableByteBag

Specified by:

collect in interface MutableByteCollection

max

public byte max()

Specified by:

max in interface ByteIterable

min

public byte min()

Specified by:

min in interface ByteIterable

sum

public long sum()

Specified by:

sum in interface ByteIterable

toArray

public byte[] toArray()

Description copied from interface: ByteIterable

Converts the ByteIterable to a primitive byte array.

Specified by:

toArray in interface ByteIterable

toArray

public byte[] toArray(byte[] array)

Description copied from interface: ByteIterable

Converts the ByteIterable to a primitive byte 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 ByteIterable

asUnmodifiable

public MutableByteBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableByteBag

Specified by:

asUnmodifiable in interface MutableByteCollection

asSynchronized

public MutableByteBag asSynchronized()

Specified by:

asSynchronized in interface MutableByteBag

Specified by:

asSynchronized in interface MutableByteCollection

toImmutable

public ImmutableByteBag toImmutable()

Description copied from interface: MutableByteBag

Returns an immutable copy of this bag.

Specified by:

toImmutable in interface ByteBag

Specified by:

toImmutable in interface MutableByteBag

Specified by:

toImmutable in interface MutableByteCollection

newEmpty

public ByteHashBag newEmpty()

Creates a new empty ByteHashBag.

Specified by:

newEmpty in interface MutableByteBag

Specified by:

newEmpty in interface MutableByteCollection

Since:

9.2.

byteIterator

public MutableByteIterator byteIterator()

Description copied from interface: ByteIterable

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

Specified by:

byteIterator in interface ByteIterable

Specified by:

byteIterator in interface MutableByteCollection

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