Interface BooleanCollection

All Superinterfaces:
BooleanIterable, java.util.Collection<java.lang.Boolean>, java.lang.Iterable<java.lang.Boolean>
All Known Subinterfaces:
BooleanBigList, BooleanList, BooleanSet
All Known Implementing Classes:
AbstractBooleanBigList, AbstractBooleanBigList.BooleanRandomAccessSubList, AbstractBooleanBigList.BooleanSubList, AbstractBooleanCollection, AbstractBooleanList, AbstractBooleanList.BooleanRandomAccessSubList, AbstractBooleanList.BooleanSubList, AbstractBooleanSet, BooleanArrayList, BooleanArraySet, BooleanBigArrayBigList, BooleanBigLists.EmptyBigList, BooleanBigLists.ListBigList, BooleanBigLists.Singleton, BooleanBigLists.SynchronizedBigList, BooleanBigLists.UnmodifiableBigList, BooleanCollections.EmptyCollection, BooleanCollections.IterableCollection, BooleanImmutableList, BooleanLists.EmptyList, BooleanLists.Singleton, BooleanLists.SynchronizedList, BooleanLists.SynchronizedRandomAccessList, BooleanLists.UnmodifiableList, BooleanLists.UnmodifiableRandomAccessList, BooleanOpenHashSet, BooleanSets.EmptySet, BooleanSets.Singleton, BooleanSets.SynchronizedSet, BooleanSets.UnmodifiableSet

public interface BooleanCollection
extends java.util.Collection<java.lang.Boolean>, BooleanIterable
A type-specific Collection; provides some additional methods that use polymorphism to avoid (un)boxing.

Additionally, this class defines strengthens (again) iterator().

This interface specifies reference equality semantics (members will be compared equal with == instead of equals), which may result in breaks in contract if attempted to be used with non reference-equality semantics based Collections. For example, a aReferenceCollection.equals(aObjectCollection) may return different a different result then aObjectCollection.equals(aReferenceCollection), in violation of equals's contract requiring it being symmetric.

See Also:
Collection
  • Method Summary

    Modifier and Type Method Description
    boolean add​(boolean key)
    Ensures that this collection contains the specified element (optional operation).
    default boolean add​(java.lang.Boolean key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean addAll​(BooleanCollection c)
    Adds all elements of the given type-specific collection to this collection.
    boolean contains​(boolean key)
    Returns true if this collection contains the specified element.
    default boolean contains​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean containsAll​(BooleanCollection c)
    Checks whether this collection contains all elements from the given type-specific collection.
    BooleanIterator iterator()
    Returns a type-specific iterator on the elements of this collection.
    boolean rem​(boolean key)
    Removes a single instance of the specified element from this collection, if it is present (optional operation).
    default boolean remove​(java.lang.Object key)
    Deprecated.
    Please use (and implement) the rem() method instead.
    boolean removeAll​(BooleanCollection c)
    Remove from this collection all elements in the given type-specific collection.
    default boolean removeIf​(BooleanPredicate filter)
    Remove from this collection all elements which satisfy the given predicate.
    default boolean removeIf​(java.util.function.Predicate<? super java.lang.Boolean> filter)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean retainAll​(BooleanCollection c)
    Retains in this collection only elements from the given type-specific collection.
    default BooleanSpliterator spliterator()
    Returns a type-specific spliterator on the elements of this collection.
    boolean[] toArray​(boolean[] a)
    Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
    boolean[] toBooleanArray()
    Returns a primitive type array containing the items of this collection.
    default boolean[] toBooleanArray​(boolean[] a)
    Deprecated.
    Please use toArray() instead—this method is redundant and will be removed in the future.

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

    forEach, forEach

    Methods inherited from interface java.util.Collection

    addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, retainAll, size, stream, toArray, toArray, toArray
  • Method Details

    • iterator

      BooleanIterator iterator()
      Returns a type-specific iterator on the elements of this collection.
      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>
      Returns:
      a type-specific iterator on the elements of this collection.
      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 Collection.
    • spliterator

      default BooleanSpliterator spliterator()
      Returns a type-specific spliterator on the elements of this collection.

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

      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>
      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().

      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

      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.
    • add

      boolean add​(boolean key)
      Ensures that this collection contains the specified element (optional operation).
      See Also:
      Collection.add(Object)
    • contains

      boolean contains​(boolean key)
      Returns true if this collection contains the specified element.
      See Also:
      Collection.contains(Object)
    • rem

      boolean rem​(boolean key)
      Removes a single instance of the specified element from this collection, if it is present (optional operation).

      Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

      See Also:
      Collection.remove(Object)
    • add

      @Deprecated default boolean add​(java.lang.Boolean key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      add in interface java.util.Collection<java.lang.Boolean>
    • contains

      @Deprecated default boolean contains​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      contains in interface java.util.Collection<java.lang.Boolean>
    • remove

      @Deprecated default boolean remove​(java.lang.Object key)
      Deprecated.
      Please use (and implement) the rem() method instead.
      Specified by:
      remove in interface java.util.Collection<java.lang.Boolean>
    • toBooleanArray

      boolean[] toBooleanArray()
      Returns a primitive type array containing the items of this collection.
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray()
    • toBooleanArray

      @Deprecated default boolean[] toBooleanArray​(boolean[] a)
      Deprecated.
      Please use toArray() instead—this method is redundant and will be removed in the future.
      Returns a primitive type array containing the items of this collection.

      Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

      Parameters:
      a - if this array is big enough, it will be used to store this collection.
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray(Object[])
    • toArray

      boolean[] toArray​(boolean[] a)
      Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

      Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

      Parameters:
      a - if this array is big enough, it will be used to store this collection.
      Returns:
      a primitive type array containing the items of this collection.
      See Also:
      Collection.toArray(Object[])
    • addAll

      boolean addAll​(BooleanCollection c)
      Adds all elements of the given type-specific collection to this collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.addAll(Collection)
    • containsAll

      boolean containsAll​(BooleanCollection c)
      Checks whether this collection contains all elements from the given type-specific collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection contains all elements of the argument.
      See Also:
      Collection.containsAll(Collection)
    • removeAll

      boolean removeAll​(BooleanCollection c)
      Remove from this collection all elements in the given type-specific collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.removeAll(Collection)
    • removeIf

      @Deprecated default boolean removeIf​(java.util.function.Predicate<? super java.lang.Boolean> filter)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      removeIf in interface java.util.Collection<java.lang.Boolean>
    • removeIf

      default boolean removeIf​(BooleanPredicate filter)
      Remove from this collection all elements which satisfy the given predicate.
      Parameters:
      filter - a predicate which returns true for elements to be removed.
      Returns:
      true if any elements were removed.
      See Also:
      Collection.removeIf(java.util.function.Predicate)
      API Notes:
      Implementing classes should generally override this method, and take the default implementation of the other overloads which will delegate to this method (after proper conversions).
    • retainAll

      boolean retainAll​(BooleanCollection c)
      Retains in this collection only elements from the given type-specific collection.
      Parameters:
      c - a type-specific collection.
      Returns:
      true if this collection changed as a result of the call.
      See Also:
      Collection.retainAll(Collection)