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

Class BooleanHashBag

java.lang.Object

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

All Implemented Interfaces:

Externalizable, Serializable, BooleanBag, MutableBooleanBag, BooleanIterable, MutableBooleanCollection, PrimitiveIterable

@NotThreadSafe
public final class BooleanHashBag
extends Object
implements MutableBooleanBag, Externalizable

BooleanHashBag is similar to HashBag, and is memory-optimized for boolean primitives.

Since:

3.0.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BooleanHashBag()
BooleanHashBag(boolean... elements)
BooleanHashBag(BooleanHashBag bag)
BooleanHashBag(BooleanIterable iterable)

Method Summary

Modifier and Type	Method and Description
boolean	add(boolean item)
boolean	addAll(boolean... source)
boolean	addAll(BooleanIterable source)
void	addOccurrences(boolean item, int occurrences)
boolean	allSatisfy(BooleanPredicate predicate)
boolean	anySatisfy(BooleanPredicate 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.
LazyBooleanIterable	asLazy()
MutableBooleanBag	asSynchronized()
MutableBooleanBag	asUnmodifiable()
MutableBooleanIterator	booleanIterator()
MutableList<BooleanIntPair>	bottomOccurrences(int count) Returns the count least frequently occurring items.
void	clear()
<V> MutableBag<V>	collect(BooleanToObjectFunction<? extends V> function)
boolean	contains(boolean value)
boolean	containsAll(boolean... source)
boolean	containsAll(BooleanIterable source)
int	count(BooleanPredicate predicate)
boolean	detectIfNone(BooleanPredicate predicate, boolean ifNone)
void	each(BooleanProcedure procedure)
boolean	equals(Object otherBag) Follows the same general contract as Bag.equals(Object).
void	forEach(BooleanProcedure procedure)
void	forEachWithOccurrences(BooleanIntProcedure 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, ObjectBooleanToObjectFunction<? super T,? extends T> function)
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.
static BooleanHashBag	newBag(BooleanIterable source)
static BooleanHashBag	newBagWith(boolean... source)
boolean	noneSatisfy(BooleanPredicate predicate)
boolean	notEmpty() The English equivalent of !this.isEmpty()
int	occurrencesOf(boolean item) The occurrences of a distinct item in the bag.
void	readExternal(ObjectInput in)
MutableBooleanBag	reject(BooleanPredicate predicate)
boolean	remove(boolean item)
boolean	removeAll(boolean... source)
boolean	removeAll(BooleanIterable source)
boolean	removeOccurrences(boolean item, int occurrences)
boolean	retainAll(boolean... source)
boolean	retainAll(BooleanIterable elements)
MutableBooleanBag	select(BooleanPredicate predicate)
MutableBooleanBag	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.
boolean[]	toArray()
MutableBooleanBag	toBag()
ImmutableBooleanBag	toImmutable() Returns an immutable copy of this bag.
MutableBooleanList	toList()
MutableList<BooleanIntPair>	topOccurrences(int count) Returns the count most frequently occurring items.
MutableBooleanSet	toSet()
String	toString() Returns a string representation of this PrimitiveIterable.
BooleanHashBag	with(boolean element)
BooleanHashBag	with(boolean element1, boolean element2)
BooleanHashBag	with(boolean element1, boolean element2, boolean element3)
BooleanHashBag	withAll(BooleanIterable iterable)
BooleanHashBag	without(boolean element)
BooleanHashBag	withoutAll(BooleanIterable iterable)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BooleanHashBag

public BooleanHashBag()

BooleanHashBag

public BooleanHashBag(BooleanIterable iterable)

BooleanHashBag

public BooleanHashBag(boolean... elements)

BooleanHashBag

public BooleanHashBag(BooleanHashBag bag)

Method Detail

newBagWith

public static BooleanHashBag newBagWith(boolean... source)

newBag

public static BooleanHashBag newBag(BooleanIterable 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: BooleanBag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface BooleanBag

clear

public void clear()

Specified by:

clear in interface MutableBooleanCollection

with

public BooleanHashBag with(boolean element)

Specified by:

with in interface MutableBooleanBag

Specified by:

with in interface MutableBooleanCollection

with

public BooleanHashBag with(boolean element1,
                           boolean element2)

with

public BooleanHashBag with(boolean element1,
                           boolean element2,
                           boolean element3)

withAll

public BooleanHashBag withAll(BooleanIterable iterable)

Specified by:

withAll in interface MutableBooleanBag

Specified by:

withAll in interface MutableBooleanCollection

without

public BooleanHashBag without(boolean element)

Specified by:

without in interface MutableBooleanBag

Specified by:

without in interface MutableBooleanCollection

withoutAll

public BooleanHashBag withoutAll(BooleanIterable iterable)

Specified by:

withoutAll in interface MutableBooleanBag

Specified by:

withoutAll in interface MutableBooleanCollection

asUnmodifiable

public MutableBooleanBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableBooleanBag

Specified by:

asUnmodifiable in interface MutableBooleanCollection

asSynchronized

public MutableBooleanBag asSynchronized()

Specified by:

asSynchronized in interface MutableBooleanBag

Specified by:

asSynchronized in interface MutableBooleanCollection

toImmutable

public ImmutableBooleanBag toImmutable()

Description copied from interface: MutableBooleanBag

Returns an immutable copy of this bag.

Specified by:

toImmutable in interface BooleanBag

Specified by:

toImmutable in interface MutableBooleanBag

Specified by:

toImmutable in interface MutableBooleanCollection

contains

public boolean contains(boolean value)

Specified by:

contains in interface BooleanIterable

containsAll

public boolean containsAll(boolean... source)

Specified by:

containsAll in interface BooleanIterable

containsAll

public boolean containsAll(BooleanIterable source)

Specified by:

containsAll in interface BooleanIterable

occurrencesOf

public int occurrencesOf(boolean item)

Description copied from interface: BooleanBag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface BooleanBag

forEachWithOccurrences

public void forEachWithOccurrences(BooleanIntProcedure procedure)

Description copied from interface: BooleanBag

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

Specified by:

forEachWithOccurrences in interface BooleanBag

add

public boolean add(boolean item)

Specified by:

add in interface MutableBooleanCollection

remove

public boolean remove(boolean item)

Specified by:

remove in interface MutableBooleanCollection

addAll

public boolean addAll(boolean... source)

Specified by:

addAll in interface MutableBooleanCollection

addAll

public boolean addAll(BooleanIterable source)

Specified by:

addAll in interface MutableBooleanCollection

removeAll

public boolean removeAll(boolean... source)

Specified by:

removeAll in interface MutableBooleanCollection

removeAll

public boolean removeAll(BooleanIterable source)

Specified by:

removeAll in interface MutableBooleanCollection

retainAll

public boolean retainAll(BooleanIterable elements)

Specified by:

retainAll in interface MutableBooleanCollection

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(boolean... source)

Specified by:

retainAll in interface MutableBooleanCollection

See Also:

Collection.retainAll(Collection)

addOccurrences

public void addOccurrences(boolean item,
                           int occurrences)

Specified by:

addOccurrences in interface MutableBooleanBag

removeOccurrences

public boolean removeOccurrences(boolean item,
                                 int occurrences)

Specified by:

removeOccurrences in interface MutableBooleanBag

forEach

public void forEach(BooleanProcedure procedure)

Specified by:

forEach in interface BooleanIterable

each

public void each(BooleanProcedure procedure)

Specified by:

each in interface BooleanIterable

Since:

7.0.

select

public MutableBooleanBag select(BooleanPredicate predicate)

Specified by:

select in interface BooleanBag

Specified by:

select in interface MutableBooleanBag

Specified by:

select in interface BooleanIterable

Specified by:

select in interface MutableBooleanCollection

selectByOccurrences

public MutableBooleanBag selectByOccurrences(IntPredicate predicate)

Description copied from interface: MutableBooleanBag

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

Specified by:

selectByOccurrences in interface BooleanBag

Specified by:

selectByOccurrences in interface MutableBooleanBag

topOccurrences

public MutableList<BooleanIntPair> topOccurrences(int count)

Description copied from interface: MutableBooleanBag

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 BooleanBag

Specified by:

topOccurrences in interface MutableBooleanBag

bottomOccurrences

public MutableList<BooleanIntPair> bottomOccurrences(int count)

Description copied from interface: MutableBooleanBag

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 BooleanBag

Specified by:

bottomOccurrences in interface MutableBooleanBag

reject

public MutableBooleanBag reject(BooleanPredicate predicate)

Specified by:

reject in interface BooleanBag

Specified by:

reject in interface MutableBooleanBag

Specified by:

reject in interface BooleanIterable

Specified by:

reject in interface MutableBooleanCollection

injectInto

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

Specified by:

injectInto in interface BooleanIterable

equals

public boolean equals(Object otherBag)

Description copied from interface: BooleanBag

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

Specified by:

equals in interface BooleanBag

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: BooleanBag

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

Specified by:

hashCode in interface BooleanBag

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

Specified by:

count in interface BooleanIterable

anySatisfy

public boolean anySatisfy(BooleanPredicate predicate)

Specified by:

anySatisfy in interface BooleanIterable

allSatisfy

public boolean allSatisfy(BooleanPredicate predicate)

Specified by:

allSatisfy in interface BooleanIterable

noneSatisfy

public boolean noneSatisfy(BooleanPredicate predicate)

Specified by:

noneSatisfy in interface BooleanIterable

detectIfNone

public boolean detectIfNone(BooleanPredicate predicate,
                            boolean ifNone)

Specified by:

detectIfNone in interface BooleanIterable

collect

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

Specified by:

collect in interface BooleanBag

Specified by:

collect in interface MutableBooleanBag

Specified by:

collect in interface BooleanIterable

Specified by:

collect in interface MutableBooleanCollection

toArray

public boolean[] toArray()

Specified by:

toArray in interface BooleanIterable

toList

public MutableBooleanList toList()

Specified by:

toList in interface BooleanIterable

toSet

public MutableBooleanSet toSet()

Specified by:

toSet in interface BooleanIterable

toBag

public MutableBooleanBag toBag()

Specified by:

toBag in interface BooleanIterable

asLazy

public LazyBooleanIterable asLazy()

Specified by:

asLazy in interface BooleanIterable

booleanIterator

public MutableBooleanIterator booleanIterator()

Specified by:

booleanIterator in interface BooleanIterable

Specified by:

booleanIterator in interface MutableBooleanCollection

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