Package it.unimi.dsi.fastutil.booleans

Interface BooleanSet

All Superinterfaces:

BooleanCollection, BooleanIterable, java.util.Collection<java.lang.Boolean>, java.lang.Iterable<java.lang.Boolean>, java.util.Set<java.lang.Boolean>

All Known Implementing Classes:

AbstractBooleanSet, BooleanArraySet, BooleanOpenHashSet, BooleanSets.EmptySet, BooleanSets.Singleton, BooleanSets.SynchronizedSet, BooleanSets.UnmodifiableSet

public interface BooleanSet
extends BooleanCollection, java.util.Set<java.lang.Boolean>

A type-specific Set; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this interface strengthens (again) iterator().

See Also:

Set

Method Summary

Modifier and Type	Method	Description
default boolean	add(java.lang.Boolean o)	Deprecated. Please use the corresponding type-specific method instead.
default boolean	contains(java.lang.Object o)	Deprecated. Please use the corresponding type-specific method instead.
BooleanIterator	iterator()	Returns a type-specific iterator on the elements of this set.
static BooleanSet	of()	Returns an immutable empty set.
static BooleanSet	of(boolean e)	Returns an immutable set with the element given.
static BooleanSet	of(boolean... a)	Returns an immutable list with the elements given.
static BooleanSet	of(boolean e0, boolean e1)	Returns an immutable set with the elements given.
static BooleanSet	of(boolean e0, boolean e1, boolean e2)	Returns an immutable set with the elements given.
default boolean	rem(boolean k)	Deprecated. Please use remove() instead.
boolean	remove(boolean k)	Removes an element from this set.
default boolean	remove(java.lang.Object o)	Deprecated. Please use the corresponding type-specific method instead.
default BooleanSpliterator	spliterator()	Returns a type-specific spliterator on the elements of this set.

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanCollection

add, addAll, contains, containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toBooleanArray, toBooleanArray

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanIterable

forEach, forEach

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, size, toArray, toArray

Method Details

iterator

BooleanIterator iterator()

Returns a type-specific iterator on the elements of this set.

Specified by:

iterator in interface BooleanCollection

Specified by:

iterator in interface BooleanIterable

Specified by:

iterator in interface java.util.Collection<java.lang.Boolean>

Specified by:

iterator in interface java.lang.Iterable<java.lang.Boolean>

Specified by:

iterator in interface java.util.Set<java.lang.Boolean>

Returns:

a type-specific iterator on the elements of this set.

See Also:

Iterable.iterator()

API Notes:

This specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Set.

Also, this is generally the only iterator method subclasses should override.

spliterator

default BooleanSpliterator spliterator()

Returns a type-specific spliterator on the elements of this set.

Set spliterators must report at least Spliterator.DISTINCT.

See Set.spliterator() for more documentation on the requirements of the returned spliterator.

Specified by:

spliterator in interface BooleanCollection

Specified by:

spliterator in interface BooleanIterable

Specified by:

spliterator in interface java.util.Collection<java.lang.Boolean>

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Boolean>

Specified by:

spliterator in interface java.util.Set<java.lang.Boolean>

Returns:

a type-specific spliterator on the elements of this collection.

Since:

8.5.0

API Notes:

This specification strengthens the one given in Collection.spliterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Set.

Also, this is generally the only spliterator method subclasses should override.

Implementation Specification:

The default implementation returns a late-binding spliterator (see Spliterator for documentation on what binding policies mean) that wraps this instance's type specific iterator().

Additionally, it reports Spliterator.SIZED and Spliterator.DISTINCT.

Implementation Notes:

As this default implementation wraps the iterator, and Iterator is an inherently linear API, the returned spliterator will yield limited performance gains when run in parallel contexts, as the returned spliterator's trySplit() will have linear runtime.

remove

boolean remove(boolean k)

Removes an element from this set.

See Also:

Collection.remove(Object)

API Notes:

Note that the corresponding method of a type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

remove

@Deprecated
default boolean remove(java.lang.Object o)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

remove in interface BooleanCollection

Specified by:

remove in interface java.util.Collection<java.lang.Boolean>

Specified by:

remove in interface java.util.Set<java.lang.Boolean>

add

@Deprecated
default boolean add(java.lang.Boolean o)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

add in interface BooleanCollection

Specified by:

add in interface java.util.Collection<java.lang.Boolean>

Specified by:

add in interface java.util.Set<java.lang.Boolean>

contains

@Deprecated
default boolean contains(java.lang.Object o)

Deprecated.

Please use the corresponding type-specific method instead.

Specified by:

contains in interface BooleanCollection

Specified by:

contains in interface java.util.Collection<java.lang.Boolean>

Specified by:

contains in interface java.util.Set<java.lang.Boolean>

rem

@Deprecated
default boolean rem(boolean k)

Deprecated.

Please use remove() instead.

Removes an element from this set.

This method is inherited from the type-specific collection this type-specific set is based on, but it should not used as this interface reinstates remove() as removal method.

Specified by:

rem in interface BooleanCollection

See Also:

Collection.remove(Object)

of

static BooleanSet of()

Returns an immutable empty set.

Returns:

an immutable empty set.

of

static BooleanSet of(boolean e)

Returns an immutable set with the element given.

Parameters:

e - an element.

Returns:

an immutable set containing e.

of

static BooleanSet of(boolean e0,
boolean e1)

Returns an immutable set with the elements given.

Parameters:

e0 - the first element.

e1 - the second element.

Returns:

an immutable set containing e0 and e1.

Throws:

java.lang.IllegalArgumentException - if there were duplicate entries.

of

static BooleanSet of(boolean e0,
boolean e1,
boolean e2)

Returns an immutable set with the elements given.

Parameters:

e0 - the first element.

e1 - the second element.

e2 - the third element.

Returns:

an immutable set containing e0, e1, and e2.

Throws:

java.lang.IllegalArgumentException - if there were duplicate entries.

of

static BooleanSet of(boolean... a)

Returns an immutable list with the elements given.

Parameters:

a - the list of elements that will be in the final set.

Returns:

an immutable set containing the elements in a.

Throws:

java.lang.IllegalArgumentException - if there are any duplicate entries.