net.ashwork.functionality.primitive.booleans

Interface ToBooleanFunction0

All Superinterfaces:

Arity, FunctionN<java.lang.Boolean>, ResultChainable<java.lang.Boolean>, ResultChainableResult<java.lang.Boolean>, ToBooleanFunctionN, UnboxedResult<Function0<java.lang.Boolean>>, Variant<java.util.function.BooleanSupplier>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ToBooleanFunction0
extends ToBooleanFunctionN, UnboxedResult<Function0<java.lang.Boolean>>, Variant<java.util.function.BooleanSupplier>

Represents a function that accepts no arguments and produces a boolean-valued result. This is the zero-arity specialization of ToBooleanFunctionN. This is the boolean-producing primitive specialization of Function0.

This is a functional interface whose functional method is applyAsBoolean().

Since:

3.0.0

See Also:

Function0, ToBooleanFunctionN

Nested Class Summary

Nested classes/interfaces inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN

ToBooleanFunctionN.Instance

Nested classes/interfaces inherited from interface net.ashwork.functionality.FunctionN

FunctionN.FunctionSizeException

Method Summary

Modifier and Type	Method and Description
default <V> Function0<V>	andThen(Function1<? super java.lang.Boolean,? extends V> after) Returns a chained object that applies this chainable object, and then applies the after function to ths result.
default <V> Function0<V>	andThenUnchecked(Function1<? super java.lang.Boolean,? extends V> after) Returns a chained object that applies this chainable object, and then applies the after function to ths result.
default boolean	applyAllAsBooleanUnchecked(java.lang.Object... args) Applies this function to the given arguments.
boolean	applyAsBoolean() Applies this function.
default int	arity() Returns the number of arguments of the function.
default Function0<java.lang.Boolean>	boxResult() Returns the boxed version of this object with a boxed result.
static ToBooleanFunction0	fromVariant(java.util.function.BooleanSupplier supplier) Creates an instance of this object from its BooleanSupplier variant.
default java.util.function.BooleanSupplier	toVariant() Returns the variant of this object.

Methods inherited from interface net.ashwork.functionality.primitive.booleans.ToBooleanFunctionN

applyAllUnchecked

Methods inherited from interface net.ashwork.functionality.FunctionN

checkSize, checkSize, sizedApplyAllUnchecked

Method Detail

applyAsBoolean

boolean applyAsBoolean()

Applies this function.

Returns:

the function result

applyAllAsBooleanUnchecked

default boolean applyAllAsBooleanUnchecked(java.lang.Object... args)

Description copied from interface: ToBooleanFunctionN

Applies this function to the given arguments. Makes no assumptions of the arguments passed in and whether a value will compute successfully.

Specified by:

applyAllAsBooleanUnchecked in interface ToBooleanFunctionN

Parameters:

args - the function arguments

Returns:

the function result

arity

default int arity()

Description copied from interface: FunctionN

Returns the number of arguments of the function. If used as a functional interface with a non-specific number of arguments, this will return -1.

Specified by:

arity in interface Arity

Specified by:

arity in interface FunctionN<java.lang.Boolean>

Returns:

the number of arguments of the function

fromVariant

static ToBooleanFunction0 fromVariant(java.util.function.BooleanSupplier supplier)

Creates an instance of this object from its BooleanSupplier variant.

Parameters:

supplier - the variant of this object

Returns:

an instance of this object

See Also:

BooleanSupplier

toVariant

default java.util.function.BooleanSupplier toVariant()

Description copied from interface: Variant

Returns the variant of this object.

Specified by:

toVariant in interface Variant<java.util.function.BooleanSupplier>

Returns:

the variant of this object

boxResult

default Function0<java.lang.Boolean> boxResult()

Description copied from interface: UnboxedResult

Returns the boxed version of this object with a boxed result.

Specified by:

boxResult in interface UnboxedResult<Function0<java.lang.Boolean>>

Returns:

the boxed version of this object with a boxed result

See Also:

Function0

andThen

default <V> Function0<V> andThen(Function1<? super java.lang.Boolean,? extends V> after)

Description copied from interface: ResultChainable

Returns a chained object that applies this chainable object, and then applies the after function to ths result. If evaluation of either throws an exception, it is relayed to the caller of the chained object.

Specified by:

andThen in interface FunctionN<java.lang.Boolean>

Specified by:

andThen in interface ResultChainable<java.lang.Boolean>

Specified by:

andThen in interface ResultChainableResult<java.lang.Boolean>

Type Parameters:

V - the type of the output of the after function, and of the chained object

Parameters:

after - the function to apply after this chainable object is applied

Returns:

a chained object that applies this chainable object and then applies the after function

See Also:

Function0

andThenUnchecked

default <V> Function0<V> andThenUnchecked(Function1<? super java.lang.Boolean,? extends V> after)

Description copied from interface: ResultChainable

Returns a chained object that applies this chainable object, and then applies the after function to ths result. If evaluation of either throws an exception, it is relayed to the caller of the chained object. This makes no assumptions on the arguments of this method.

Specified by:

andThenUnchecked in interface FunctionN<java.lang.Boolean>

Specified by:

andThenUnchecked in interface ResultChainable<java.lang.Boolean>

Specified by:

andThenUnchecked in interface ResultChainableResult<java.lang.Boolean>

Type Parameters:

V - the type of the output of the after function, and of the chained object

Parameters:

after - the function to apply after this chainable object is applied

Returns:

a chained object that applies this chainable object and then applies the after function

See Also:

Function0