All Superinterfaces:: PrimitiveIterable

All Known Subinterfaces:: BooleanBag, BooleanList, BooleanSet, BooleanStack, BooleanValuesMap, ByteBooleanMap, CharBooleanMap, DoubleBooleanMap, FloatBooleanMap, ImmutableBooleanBag, ImmutableBooleanCollection, ImmutableBooleanList, ImmutableBooleanSet, ImmutableBooleanStack, ImmutableByteBooleanMap, ImmutableCharBooleanMap, ImmutableDoubleBooleanMap, ImmutableFloatBooleanMap, ImmutableIntBooleanMap, ImmutableLongBooleanMap, ImmutableObjectBooleanMap<K>, ImmutableShortBooleanMap, IntBooleanMap, LazyBooleanIterable, LongBooleanMap, MutableBooleanBag, MutableBooleanCollection, MutableBooleanList, MutableBooleanSet, MutableBooleanStack, MutableBooleanValuesMap, MutableByteBooleanMap, MutableCharBooleanMap, MutableDoubleBooleanMap, MutableFloatBooleanMap, MutableIntBooleanMap, MutableLongBooleanMap, MutableObjectBooleanMap<K>, MutableShortBooleanMap, ObjectBooleanMap<K>, OrderedBooleanIterable, ReversibleBooleanIterable, ShortBooleanMap

All Known Implementing Classes:: AbstractBooleanIterable, AbstractBooleanStack, AbstractImmutableObjectBooleanMap, AbstractLazyBooleanIterable, AbstractMutableBooleanValuesMap, AbstractSynchronizedBooleanCollection, AbstractUnmodifiableBooleanCollection, BooleanArrayList, BooleanArrayStack, BooleanHashBag, BooleanHashSet, ByteBooleanHashMap, CharBooleanHashMap, CollectBooleanIterable, CollectBooleanToBooleanIterable, CollectByteToBooleanIterable, CollectCharToBooleanIterable, CollectDoubleToBooleanIterable, CollectFloatToBooleanIterable, CollectIntToBooleanIterable, CollectLongToBooleanIterable, CollectShortToBooleanIterable, DoubleBooleanHashMap, FloatBooleanHashMap, IntBooleanHashMap, LazyBooleanIterableAdapter, LongBooleanHashMap, ObjectBooleanHashMap, ObjectBooleanHashMapWithHashingStrategy, ReverseBooleanIterable, SelectBooleanIterable, ShortBooleanHashMap, SynchronizedBooleanBag, SynchronizedBooleanCollection, SynchronizedBooleanIterable, SynchronizedBooleanList, SynchronizedBooleanSet, SynchronizedBooleanStack, SynchronizedByteBooleanMap, SynchronizedCharBooleanMap, SynchronizedDoubleBooleanMap, SynchronizedFloatBooleanMap, SynchronizedIntBooleanMap, SynchronizedLongBooleanMap, SynchronizedObjectBooleanMap, SynchronizedShortBooleanMap, TapBooleanIterable, UnmodifiableBooleanBag, UnmodifiableBooleanCollection, UnmodifiableBooleanList, UnmodifiableBooleanSet, UnmodifiableBooleanStack, UnmodifiableByteBooleanMap, UnmodifiableCharBooleanMap, UnmodifiableDoubleBooleanMap, UnmodifiableFloatBooleanMap, UnmodifiableIntBooleanMap, UnmodifiableLongBooleanMap, UnmodifiableObjectBooleanMap, UnmodifiableShortBooleanMap

public interface BooleanIterable
extends PrimitiveIterable

BooleanIterable is an interface which is memory-optimized for boolean primitives. It is inspired by the interface RichIterable, and contains a subset of the internal iterator methods on RichIterable like collect, sum, etc. The API also includes an external iterator method, which returns an BooleanIterator. BooleanIterator helps iterate over the BooleanIterable without boxing the primitives. This file was automatically generated from template file primitiveIterable.stg.

Method Summary

Modifier and Type	Method	Description
`boolean`	`allSatisfy(BooleanPredicate predicate)`	Returns true if all of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
`boolean`	`anySatisfy(BooleanPredicate predicate)`	Returns true if any of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
`LazyBooleanIterable`	`asLazy()`	Returns a LazyBooleanIterable adapter wrapping the source BooleanIterable.
`BooleanIterator`	`booleanIterator()`	Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
`default RichIterable<BooleanIterable>`	`chunk(int size)`	Partitions elements in fixed size chunks.
`<V> RichIterable<V>`	`collect(BooleanToObjectFunction<? extends V> function)`	Returns a new collection with the results of applying the specified function on each element of the source collection.
`default <V, R extends Collection<V>> R`	`collect(BooleanToObjectFunction<? extends V> function, R target)`	Same as `collect(BooleanToObjectFunction)` , only the results are added to the target Collection.
`default <R extends MutableBooleanCollection> R`	`collectBoolean(BooleanToBooleanFunction function, R target)`	Returns the target `MutableBooleanCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableByteCollection> R`	`collectByte(BooleanToByteFunction function, R target)`	Returns the target `MutableByteCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableCharCollection> R`	`collectChar(BooleanToCharFunction function, R target)`	Returns the target `MutableCharCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableDoubleCollection> R`	`collectDouble(BooleanToDoubleFunction function, R target)`	Returns the target `MutableDoubleCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableFloatCollection> R`	`collectFloat(BooleanToFloatFunction function, R target)`	Returns the target `MutableFloatCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableIntCollection> R`	`collectInt(BooleanToIntFunction function, R target)`	Returns the target `MutableIntCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableLongCollection> R`	`collectLong(BooleanToLongFunction function, R target)`	Returns the target `MutableLongCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableShortCollection> R`	`collectShort(BooleanToShortFunction function, R target)`	Returns the target `MutableShortCollection` with the results of applying the specified function on each element of the source collection.
`boolean`	`contains(boolean value)`	Returns true if the value is contained in the BooleanIterable, and false if it is not.
`boolean`	`containsAll(boolean... source)`	Returns true if the all of the values specified in the source array are contained in the BooleanIterable, and false if they are not.
`boolean`	`containsAll(BooleanIterable source)`	Returns true if the all of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not.
`int`	`count(BooleanPredicate predicate)`	Returns a count of the number of elements in the BooleanIterable that return true for the specified predicate.
`boolean`	`detectIfNone(BooleanPredicate predicate, boolean ifNone)`
`void`	`each(BooleanProcedure procedure)`	A synonym for forEach.
`default <V, R extends Collection<V>> R`	`flatCollect(BooleanToObjectFunction<? extends Iterable<V>> function, R target)`	`flatCollect` is a special case of `collect(BooleanToObjectFunction)`.
`void`	`forEach(BooleanProcedure procedure)`	Applies the BooleanProcedure to each element in the BooleanIterable.
`<T> T`	`injectInto(T injectedValue, ObjectBooleanToObjectFunction<? super T,? extends T> function)`
`boolean`	`noneSatisfy(BooleanPredicate predicate)`	Returns true if none of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
`default boolean`	`reduce(BooleanBooleanToBooleanFunction accumulator)`
`default boolean`	`reduceIfEmpty(BooleanBooleanToBooleanFunction accumulator, boolean defaultValue)`
`BooleanIterable`	`reject(BooleanPredicate predicate)`	Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
`default <R extends MutableBooleanCollection> R`	`reject(BooleanPredicate predicate, R target)`	Same as `reject(BooleanPredicate)` , only the results are added to the target MutableBooleanCollection.
`BooleanIterable`	`select(BooleanPredicate predicate)`	Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
`default <R extends MutableBooleanCollection> R`	`select(BooleanPredicate predicate, R target)`	Same as `select(BooleanPredicate)` , only the results are added to the target MutableBooleanCollection.
`default BooleanIterable`	`tap(BooleanProcedure procedure)`
`boolean[]`	`toArray()`	Converts the BooleanIterable to a primitive boolean array.
`default boolean[]`	`toArray(boolean[] target)`	Converts the BooleanIterable to a primitive boolean array.
`MutableBooleanBag`	`toBag()`	Converts the BooleanIterable to a new MutableBooleanBag.
`MutableBooleanList`	`toList()`	Converts the BooleanIterable to a new MutableBooleanList.
`MutableBooleanSet`	`toSet()`	Converts the BooleanIterable to a new MutableBooleanSet.

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

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString

Method Details
- booleanIterator
  
  BooleanIterator booleanIterator()
  
  Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
- toArray
  
  boolean[] toArray()
  
  Converts the BooleanIterable to a primitive boolean array.
- toArray
  
  default boolean[] toArray(boolean[] target)
  
  Converts the BooleanIterable to a primitive boolean 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.
- contains
  
  boolean contains(boolean value)
  
  Returns true if the value is contained in the BooleanIterable, and false if it is not.
- containsAll
  
  boolean containsAll(boolean... source)
  
  Returns true if the all of the values specified in the source array are contained in the BooleanIterable, and false if they are not.
- containsAll
  
  boolean containsAll(BooleanIterable source)
  
  Returns true if the all of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not.
- forEach
  
  void forEach(BooleanProcedure procedure)
  
  Applies the BooleanProcedure to each element in the BooleanIterable.
- each
  
  void each(BooleanProcedure procedure)
  
  A synonym for forEach.
  
  Since:
  
  7.0.
- tap
  
  default BooleanIterable tap(BooleanProcedure procedure)
  
  Since:
  
  9.0.
- select
  
  BooleanIterable select(BooleanPredicate predicate)
  
  Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
- reject
  
  BooleanIterable reject(BooleanPredicate predicate)
  
  Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
- select
  
  default <R extends MutableBooleanCollection> R select(BooleanPredicate predicate, R target)
  
  Same as select(BooleanPredicate) , only the results are added to the target MutableBooleanCollection.
  
  Since:
  
  8.1.
- reject
  
  default <R extends MutableBooleanCollection> R reject(BooleanPredicate predicate, R target)
  
  Same as reject(BooleanPredicate) , only the results are added to the target MutableBooleanCollection.
  
  Since:
  
  8.1.
- collect
  
  <V> RichIterable<V> collect(BooleanToObjectFunction<? extends V> function)
  
  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.
- collect
  
  default <V, R extends Collection<V>> R collect(BooleanToObjectFunction<? extends V> function, R target)
  
  Same as collect(BooleanToObjectFunction) , only the results are added to the target Collection.
  
  Since:
  
  8.1.
- flatCollect
  
  default <V, R extends Collection<V>> R flatCollect(BooleanToObjectFunction<? extends Iterable<V>> function, R target)
  
  flatCollect is a special case of collect(BooleanToObjectFunction). With collect, when the BooleanToObjectFunction returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
  
  Since:
  
  8.1.
- collectBoolean
  
  default <R extends MutableBooleanCollection> R collectBoolean(BooleanToBooleanFunction function, R target)
  
  Returns the target MutableBooleanCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectByte
  
  default <R extends MutableByteCollection> R collectByte(BooleanToByteFunction function, R target)
  
  Returns the target MutableByteCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectChar
  
  default <R extends MutableCharCollection> R collectChar(BooleanToCharFunction function, R target)
  
  Returns the target MutableCharCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectShort
  
  default <R extends MutableShortCollection> R collectShort(BooleanToShortFunction function, R target)
  
  Returns the target MutableShortCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectInt
  
  default <R extends MutableIntCollection> R collectInt(BooleanToIntFunction function, R target)
  
  Returns the target MutableIntCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectFloat
  
  default <R extends MutableFloatCollection> R collectFloat(BooleanToFloatFunction function, R target)
  
  Returns the target MutableFloatCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectLong
  
  default <R extends MutableLongCollection> R collectLong(BooleanToLongFunction function, R target)
  
  Returns the target MutableLongCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- collectDouble
  
  default <R extends MutableDoubleCollection> R collectDouble(BooleanToDoubleFunction function, R target)
  
  Returns the target MutableDoubleCollection with the results of applying the specified function on each element of the source collection.
  
  Since:
  
  8.1.
- detectIfNone
  
  boolean detectIfNone(BooleanPredicate predicate, boolean ifNone)
- count
  
  int count(BooleanPredicate predicate)
  
  Returns a count of the number of elements in the BooleanIterable that return true for the specified predicate.
- anySatisfy
  
  boolean anySatisfy(BooleanPredicate predicate)
  
  Returns true if any of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
- allSatisfy
  
  boolean allSatisfy(BooleanPredicate predicate)
  
  Returns true if all of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
- noneSatisfy
  
  boolean noneSatisfy(BooleanPredicate predicate)
  
  Returns true if none of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
- toList
  
  MutableBooleanList toList()
  
  Converts the BooleanIterable to a new MutableBooleanList.
- toSet
  
  MutableBooleanSet toSet()
  
  Converts the BooleanIterable to a new MutableBooleanSet.
- toBag
  
  MutableBooleanBag toBag()
  
  Converts the BooleanIterable to a new MutableBooleanBag.
- asLazy
  
  LazyBooleanIterable asLazy()
  
  Returns a LazyBooleanIterable adapter wrapping the source BooleanIterable.
- injectInto
  
  <T> T injectInto(T injectedValue, ObjectBooleanToObjectFunction<? super T,? extends T> function)
- reduceIfEmpty
  
  default boolean reduceIfEmpty(BooleanBooleanToBooleanFunction accumulator, boolean defaultValue)
  
  Since:
  
  10.0
  
  See Also:
  
  reduce(BooleanBooleanToBooleanFunction)
- reduce
  
  default boolean reduce(BooleanBooleanToBooleanFunction accumulator)
  
  Since:
  
  10.0
  
  See Also:
  
  RichIterable.reduce(BinaryOperator)
- chunk
  
  default RichIterable<BooleanIterable> chunk(int size)
  
  Partitions elements in fixed size chunks.
  
  Parameters:
  
  size - the number of elements per chunk
  
  Returns:
  
  A RichIterable containing BooleanIterables of size size, except the last will be truncated if the elements don't divide evenly.
  
  Since:
  
  9.2

Interface BooleanIterable

Method Summary

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

Method Details