Eclipse Collections 13.0.0 · org.eclipse.collections.api.BooleanIterable

Method Summary

Modifier and Type	Method and Description
public boolean	allSatisfy(BooleanPredicate predicate) Returns true if all of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
public boolean	anySatisfy(BooleanPredicate predicate) Returns true if any of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
public LazyBooleanIterable	asLazy() Returns a LazyBooleanIterable adapter wrapping the source BooleanIterable.
public BooleanIterator	booleanIterator() Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
public default RichIterable<BooleanIterable>	Returns: A `RichIterable` containing `BooleanIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. chunk(int the number of elements per chunk size) Partitions elements in fixed size chunks.
public <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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public boolean	contains(boolean value) Returns true if the value is contained in the BooleanIterable, and false if it is not.
public default boolean	containsAll(boolean... source) Returns true if all of the values specified in the source array are contained in the BooleanIterable, and false if they are not.
public default boolean	containsAll(BooleanIterable source) Returns true if all of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not.
public default boolean	containsAny(boolean... source) Returns true if any of the values specified in the source array are contained in the BooleanIterable, and false if they are not.
public default boolean	containsAny(BooleanIterable source) Returns true if any of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not.
public default boolean	containsNone(boolean... source) Returns true if none of the values specified in the source array are contained in the BooleanIterable, and false if they are.
public default boolean	containsNone(BooleanIterable source) Returns true if none of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are.
public int	count(BooleanPredicate predicate) Returns a count of the number of elements in the BooleanIterable that return true for the specified predicate.
public boolean	detectIfNone(BooleanPredicate predicate, boolean ifNone)
public void	each(BooleanProcedure procedure) A synonym for forEach.
public default <V, R extends Collection<V>> R	flatCollect(BooleanToObjectFunction<? extends Iterable<V>> function, R target) `flatCollect` is a special case of `collect(BooleanToObjectFunction)`.
public default void	forEach(BooleanProcedure procedure) Applies the BooleanProcedure to each element in the BooleanIterable.
public <T> T	injectInto(T injectedValue, ObjectBooleanToObjectFunction<? super T, ? extends T> function)
public default boolean	injectIntoBoolean(boolean injectedValue, BooleanBooleanToBooleanFunction function) Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default byte	injectIntoByte(byte injectedValue, ByteBooleanToByteFunction function) Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default char	injectIntoChar(char injectedValue, CharBooleanToCharFunction function) Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default double	injectIntoDouble(double injectedValue, DoubleBooleanToDoubleFunction function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default float	injectIntoFloat(float injectedValue, FloatBooleanToFloatFunction function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default int	injectIntoInt(int injectedValue, IntBooleanToIntFunction function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default long	injectIntoLong(long injectedValue, LongBooleanToLongFunction function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default short	injectIntoShort(short injectedValue, ShortBooleanToShortFunction function) Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default boolean	noneSatisfy(BooleanPredicate predicate) Returns true if none of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.
public default boolean	reduce(BooleanBooleanToBooleanFunction accumulator)
public default boolean	reduceIfEmpty(BooleanBooleanToBooleanFunction accumulator, boolean defaultValue)
public BooleanIterable	reject(BooleanPredicate predicate) Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
public default <R extends MutableBooleanCollection> R	reject(BooleanPredicate predicate, R target) Same as `reject(BooleanPredicate)` , only the results are added to the target MutableBooleanCollection.
public BooleanIterable	select(BooleanPredicate predicate) Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
public default <R extends MutableBooleanCollection> R	select(BooleanPredicate predicate, R target) Same as `select(BooleanPredicate)` , only the results are added to the target MutableBooleanCollection.
public default BooleanIterable	tap(BooleanProcedure procedure)
public boolean[]	toArray() Converts the BooleanIterable to a primitive boolean array.
public default boolean[]	toArray(boolean[] target) Converts the BooleanIterable to a primitive boolean array.
public MutableBooleanBag	toBag() Converts the BooleanIterable to a new MutableBooleanBag.
public MutableBooleanList	toList() Converts the BooleanIterable to a new MutableBooleanList.
public MutableBooleanSet	toSet() Converts the BooleanIterable to a new MutableBooleanSet.

Inherited from org.eclipse.collections.api.PrimitiveIterable:: appendString appendString appendString isEmpty makeString makeString makeString notEmpty size toString

Method Detail

allSatisfy	back to summary
public boolean allSatisfy(BooleanPredicate predicate) Returns true if all of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.

anySatisfy	back to summary
public boolean anySatisfy(BooleanPredicate predicate) Returns true if any of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.

asLazy	back to summary
public LazyBooleanIterable asLazy() Returns a LazyBooleanIterable adapter wrapping the source BooleanIterable.

booleanIterator	back to summary
public BooleanIterator booleanIterator() Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.

chunk back to summary

chunk	back to summary
public default RichIterable<BooleanIterable> chunk(int size) Partitions elements in fixed size chunks. Parameters size:int the number of elements per chunk Returns:RichIterable<BooleanIterable> A `RichIterable` containing `BooleanIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. Since 9.2

public default RichIterable<BooleanIterable> chunk(int size)

Partitions elements in fixed size chunks.

Parameters

size:int: the number of elements per chunk

Returns:RichIterable<BooleanIterable>

A RichIterable containing BooleanIterables of size size, except the last will be truncated if the elements don't divide evenly.

Since

9.2

collect	back to summary
public <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 back to summary

collect	back to summary
public 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.

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

collectBoolean back to summary

collectBoolean	back to summary
public 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.

public 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 back to summary

collectByte	back to summary
public 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.

public 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 back to summary

collectChar	back to summary
public 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.

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

collectDouble back to summary

collectDouble	back to summary
public 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.

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

collectFloat back to summary

collectFloat	back to summary
public 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.

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

collectInt back to summary

collectInt	back to summary
public 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.

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

collectLong back to summary

collectLong	back to summary
public 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.

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

collectShort back to summary

collectShort	back to summary
public 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.

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

contains	back to summary
public boolean contains(boolean value) Returns true if the value is contained in the BooleanIterable, and false if it is not.

containsAll	back to summary
public default boolean containsAll(boolean... source) Returns true if all of the values specified in the source array are contained in the BooleanIterable, and false if they are not.

containsAll	back to summary
public default boolean containsAll(BooleanIterable source) Returns true if all of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not.

containsAny	back to summary
public default boolean containsAny(boolean... source) Returns true if any of the values specified in the source array are contained in the BooleanIterable, and false if they are not. Since 11.0

containsAny

back to summary

public default boolean containsAny(boolean... source)

Returns true if any of the values specified in the source array are contained in the BooleanIterable, and false if they are not.

Since: 11.0

containsAny	back to summary
public default boolean containsAny(BooleanIterable source) Returns true if any of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not. Since 11.0

containsAny

back to summary

public default boolean containsAny(BooleanIterable source)

Returns true if any of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are not.

Since: 11.0

containsNone	back to summary
public default boolean containsNone(boolean... source) Returns true if none of the values specified in the source array are contained in the BooleanIterable, and false if they are. Since 11.0

containsNone

back to summary

public default boolean containsNone(boolean... source)

Returns true if none of the values specified in the source array are contained in the BooleanIterable, and false if they are.

Since: 11.0

containsNone	back to summary
public default boolean containsNone(BooleanIterable source) Returns true if none of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are. Since 11.0

containsNone

back to summary

public default boolean containsNone(BooleanIterable source)

Returns true if none of the values specified in the source BooleanIterable are contained in the BooleanIterable, and false if they are.

Since: 11.0

count	back to summary
public int count(BooleanPredicate predicate) Returns a count of the number of elements in the BooleanIterable that return true for the specified predicate.

detectIfNone	back to summary
public boolean detectIfNone(BooleanPredicate predicate, boolean ifNone)

each	back to summary
public void each(BooleanProcedure procedure) A synonym for forEach. Since 7.0.

each

back to summary

public void each(BooleanProcedure procedure)

A synonym for forEach.

Since: 7.0.

flatCollect back to summary

flatCollect	back to summary
public 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.

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

forEach	back to summary
public default void forEach(BooleanProcedure procedure) Applies the BooleanProcedure to each element in the BooleanIterable.

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

injectIntoBoolean	back to summary
public default boolean injectIntoBoolean(boolean injectedValue, BooleanBooleanToBooleanFunction function) Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoBoolean

back to summary

public default boolean injectIntoBoolean(boolean injectedValue, BooleanBooleanToBooleanFunction function)

Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoByte	back to summary
public default byte injectIntoByte(byte injectedValue, ByteBooleanToByteFunction function) Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoByte

back to summary

public default byte injectIntoByte(byte injectedValue, ByteBooleanToByteFunction function)

Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoChar	back to summary
public default char injectIntoChar(char injectedValue, CharBooleanToCharFunction function) Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoChar

back to summary

public default char injectIntoChar(char injectedValue, CharBooleanToCharFunction function)

Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoDouble	back to summary
public default double injectIntoDouble(double injectedValue, DoubleBooleanToDoubleFunction function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoDouble

back to summary

public default double injectIntoDouble(double injectedValue, DoubleBooleanToDoubleFunction function)

Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoFloat	back to summary
public default float injectIntoFloat(float injectedValue, FloatBooleanToFloatFunction function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoFloat

back to summary

public default float injectIntoFloat(float injectedValue, FloatBooleanToFloatFunction function)

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoInt	back to summary
public default int injectIntoInt(int injectedValue, IntBooleanToIntFunction function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoInt

back to summary

public default int injectIntoInt(int injectedValue, IntBooleanToIntFunction function)

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoLong	back to summary
public default long injectIntoLong(long injectedValue, LongBooleanToLongFunction function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoLong

back to summary

public default long injectIntoLong(long injectedValue, LongBooleanToLongFunction function)

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoShort	back to summary
public default short injectIntoShort(short injectedValue, ShortBooleanToShortFunction function) Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoShort

back to summary

public default short injectIntoShort(short injectedValue, ShortBooleanToShortFunction function)

Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

noneSatisfy	back to summary
public default boolean noneSatisfy(BooleanPredicate predicate) Returns true if none of the elements in the BooleanIterable return true for the specified predicate, otherwise returns false.

reduce	back to summary
public default boolean reduce(BooleanBooleanToBooleanFunction accumulator) Since 10.0 See Also `RichIterable#reduce(BinaryOperator)`

reduceIfEmpty	back to summary
public default boolean reduceIfEmpty(BooleanBooleanToBooleanFunction accumulator, boolean defaultValue) Since 10.0 See Also `reduce(BooleanBooleanToBooleanFunction)`

reject	back to summary
public BooleanIterable reject(BooleanPredicate predicate) Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.

reject back to summary

reject	back to summary
public 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.

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

select	back to summary
public BooleanIterable select(BooleanPredicate predicate) Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.

select back to summary

select	back to summary
public 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.

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

tap	back to summary
public default BooleanIterable tap(BooleanProcedure procedure) Since 9.0.

toArray	back to summary
public boolean[] toArray() Converts the BooleanIterable to a primitive boolean array.

toArray	back to summary
public 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.

toBag	back to summary
public MutableBooleanBag toBag() Converts the BooleanIterable to a new MutableBooleanBag.

toList	back to summary
public MutableBooleanList toList() Converts the BooleanIterable to a new MutableBooleanList.

toSet	back to summary
public MutableBooleanSet toSet() Converts the BooleanIterable to a new MutableBooleanSet.

public Interface BooleanIterable

Method Summary

Method Detail