BooleanFunction1 (core 3.0.0 API)

Type Parameters:

R - the type of the result of the function

All Superinterfaces:

Arity, FunctionN<R>, InputChainable<java.lang.Boolean>, InputChainableInput<java.lang.Boolean>, ResultChainable<R>, ResultChainableResult<R>, UnboxedInput<Function1<java.lang.Boolean,R>>

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 BooleanFunction1<R>
extends FunctionN<R>, InputChainableInput<java.lang.Boolean>, UnboxedInput<Function1<java.lang.Boolean,R>>
```
Represents a function that accepts a boolean-valued argument and produces a result. This is the one-arity specialization of FunctionN. This is the boolean-consuming primitive specialization of Function1.
This is a functional interface whose functional method is apply(boolean).

Since:

3.0.0

See Also:

Function1, FunctionN

Nested Class Summary
- Nested classes/interfaces inherited from interface net.ashwork.functionality.FunctionN
  FunctionN.FunctionSizeException, FunctionN.Instance<R>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <V> BooleanFunction1<V>`	`andThen(Function1<? super R,? extends V> after)` Returns a chained object that applies this chainable object, and then applies the `after` function to ths result.
`default <V> BooleanFunction1<V>`	`andThenUnchecked(Function1<? super R,? extends V> after)` Returns a chained object that applies this chainable object, and then applies the `after` function to ths result.
`R`	`apply(boolean value)` Applies this function to the given argument.
`default R`	`applyAllUnchecked(java.lang.Object... args)` Applies this function to the given arguments.
`default int`	`arity()` Returns the number of arguments of the function.
`default Function1<java.lang.Boolean,R>`	`boxInput()` Returns the boxed version of this object with a boxed input.
`default <V> Function1<V,R>`	`compose(Function1<? super V,? extends java.lang.Boolean> before)` Returns a chained object that applies the `before` function to its input, and then applies this chainable object to the result.
`default <V> Function1<V,R>`	`composeUnchecked(Function1<? super V,? extends java.lang.Boolean> before)` Returns a chained object that applies the `before` function to its input, and then applies this chainable object to the result.

Methods inherited from interface net.ashwork.functionality.FunctionN
checkSize, checkSize, sizedApplyAllUnchecked

- Method Detail
  - apply
```
R apply(boolean value)
```
    Applies this function to the given argument.
    
    Parameters:
    
    value - the function argument
    
    Returns:
    
    the function result
  - applyAllUnchecked
```
default R applyAllUnchecked(java.lang.Object... args)
```
    Description copied from interface: FunctionN
    
    Applies this function to the given arguments. Makes no assumptions of the arguments passed in and whether a value will compute successfully.
    
    Specified by:
    
    applyAllUnchecked in interface FunctionN<R>
    
    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<R>
    
    Returns:
    
    the number of arguments of the function
  - boxInput
```
default Function1<java.lang.Boolean,R> boxInput()
```
    Description copied from interface: UnboxedInput
    
    Returns the boxed version of this object with a boxed input.
    
    Specified by:
    
    boxInput in interface UnboxedInput<Function1<java.lang.Boolean,R>>
    
    Returns:
    
    the boxed version of this object with a boxed input
    
    See Also:
    
    Function1
  - compose
```
default <V> Function1<V,R> compose(Function1<? super V,? extends java.lang.Boolean> before)
```
    Description copied from interface: InputChainable
    
    Returns a chained object that applies the before function to its input, and then applies this chainable object to the result. If evaluation of either throws an exception, it is relayed to the caller of the chained object.
    
    Specified by:
    
    compose in interface InputChainable<java.lang.Boolean>
    
    Specified by:
    
    compose in interface InputChainableInput<java.lang.Boolean>
    
    Type Parameters:
    
    V - the type of the input to the before function, and to then chained object
    
    Parameters:
    
    before - the function to apply before this chainable object is applied
    
    Returns:
    
    a chained object that first applies the before function and then applies this chainable object
    
    See Also:
    
    Function1
  - composeUnchecked
```
default <V> Function1<V,R> composeUnchecked(Function1<? super V,? extends java.lang.Boolean> before)
```
    Description copied from interface: InputChainable
    
    Returns a chained object that applies the before function to its input, and then applies this chainable object to the 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:
    
    composeUnchecked in interface InputChainable<java.lang.Boolean>
    
    Specified by:
    
    composeUnchecked in interface InputChainableInput<java.lang.Boolean>
    
    Type Parameters:
    
    V - the type of the input to the before function, and to then chained object
    
    Parameters:
    
    before - the function to apply before this chainable object is applied
    
    Returns:
    
    a chained object that first applies the before function and then applies this chainable object
    
    See Also:
    
    Function1
  - andThen
```
default <V> BooleanFunction1<V> andThen(Function1<? super R,? 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<R>
    
    Specified by:
    
    andThen in interface ResultChainable<R>
    
    Specified by:
    
    andThen in interface ResultChainableResult<R>
    
    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
  - andThenUnchecked
```
default <V> BooleanFunction1<V> andThenUnchecked(Function1<? super R,? 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<R>
    
    Specified by:
    
    andThenUnchecked in interface ResultChainable<R>
    
    Specified by:
    
    andThenUnchecked in interface ResultChainableResult<R>
    
    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

Interface BooleanFunction1<R>

Nested Class Summary

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

Method Summary

Methods inherited from interface net.ashwork.functionality.FunctionN

Method Detail

apply

applyAllUnchecked

arity

boxInput

compose

composeUnchecked

andThen

andThenUnchecked