ToBooleanNullable (Speedment - Runtime

Type Parameters:

T - type to extract from

All Superinterfaces:

Comparator<T>, Expression<T>, Function<T,Boolean>, HasCompare<T>, HasCompose<T>, HasHash<T>, HasMapIfPresent<T,com.speedment.common.function.BooleanUnaryOperator,ToBooleanNullable<T>>, HasMapToDoubleIfPresent<T,com.speedment.common.function.BooleanToDoubleFunction>, Predicate<T>, com.speedment.common.function.ToBooleanFunction<T>, ToNullable<T,Boolean,ToBoolean<T>>

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 ToBooleanNullable<T>
extends Expression<T>, com.speedment.common.function.ToBooleanFunction<T>, ToNullable<T,Boolean,ToBoolean<T>>, HasMapToDoubleIfPresent<T,com.speedment.common.function.BooleanToDoubleFunction>, HasMapIfPresent<T,com.speedment.common.function.BooleanUnaryOperator,ToBooleanNullable<T>>, HasHash<T>, HasCompare<T>, HasCompose<T>
```
Expression that given an entity returns a boolean value, or null. This expression can be implemented using a lambda, or it can be a result of another operation. It has additional methods for operating on it.

Since:

3.1.0

Author:

Emil Forslund

See Also:

Function

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`applyAsBoolean(T object)` Applies this function to the given argument.
`default int`	`compare(T first, T second)`
`default <V> ToBooleanNullable<V>`	`compose(Function<? super V,? extends T> before)` Returns a composed expression that first applies the `before` function to its input, and then applies this function to the result.
`default ExpressionType`	`expressionType()` Returns the expression type of this expression.
`default long`	`hash(T object)` Hash the specified object into a 64-bit hash.
`default ToBooleanNullable<T>`	`mapIfPresent(com.speedment.common.function.BooleanUnaryOperator mapper)` Returns an expression for the value of this expression mapped using the specified mapping function.
`default ToDoubleNullable<T>`	`mapToDoubleIfPresent(com.speedment.common.function.BooleanToDoubleFunction mapper)` Maps the result of this expression into a `double` by passing it to the specified `mapper`, producing a new expression that implements `ToDouble`.
`static <T> ToBooleanNullable<T>`	`of(Function<T,Boolean> lambda)` Returns a typed `ToBooleanNullable<T>` using the provided `lambda`.
`default ToBoolean<T>`	`orElse(Boolean value)` Returns an equivalent expression as this, except that it will return the `value` if given an argument that would cause this expression to return `null`.
`default ToBoolean<T>`	`orElseGet(ToBoolean<T> getter)` Returns an equivalent expression as this, except that it will return the `getter` expression if given an argument that would cause this expression to return `null`.
`default ToBoolean<T>`	`orThrow()` Returns an equivalent expression as this, except that it will throw a `NullPointerException` if given an argument that would cause this expression to return `null`.

Methods inherited from interface com.speedment.common.function.ToBooleanFunction
test

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

Methods inherited from interface com.speedment.runtime.compute.trait.ToNullable
isNotNull, isNotNull, isNull, isNull

Methods inherited from interface java.util.function.Function
andThen, apply, identity

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Method Detail
  - of
```
static <T> ToBooleanNullable<T> of(Function<T,Boolean> lambda)
```
    Returns a typed ToBooleanNullable<T> using the provided lambda.
    
    Type Parameters:
    
    T - type to extract from
    
    Parameters:
    
    lambda - to convert
    
    Returns:
    
    a typed ToBooleanNullable<T> using the provided lambda
    
    Throws:
    
    NullPointerException - if the provided lambda is null
  - expressionType
```
default ExpressionType expressionType()
```
    Description copied from interface: Expression
    
    Returns the expression type of this expression. It should be safe to cast this instance into the corresponding interface.
    
    Specified by:
    
    expressionType in interface Expression<T>
    
    Returns:
    
    the expression type
  - applyAsBoolean
```
default boolean applyAsBoolean(T object)
                        throws NullPointerException
```
    Description copied from interface: com.speedment.common.function.ToBooleanFunction
    
    Applies this function to the given argument.
    
    Specified by:
    
    applyAsBoolean in interface com.speedment.common.function.ToBooleanFunction<T>
    
    Parameters:
    
    object - the argument
    
    Returns:
    
    the result
    
    Throws:
    
    NullPointerException
  - orThrow
```
default ToBoolean<T> orThrow()
                      throws NullPointerException
```
    Description copied from interface: ToNullable
    
    Returns an equivalent expression as this, except that it will throw a NullPointerException if given an argument that would cause this expression to return null.
    
    Specified by:
    
    orThrow in interface ToNullable<T,Boolean,ToBoolean<T>>
    
    Returns:
    
    the expression if present
    
    Throws:
    
    NullPointerException
  - orElseGet
```
default ToBoolean<T> orElseGet(ToBoolean<T> getter)
```
    Description copied from interface: ToNullable
    
    Returns an equivalent expression as this, except that it will return the getter expression if given an argument that would cause this expression to return null.
    
    Specified by:
    
    orElseGet in interface ToNullable<T,Boolean,ToBoolean<T>>
    
    Parameters:
    
    getter - to apply if null
    
    Returns:
    
    the expression if present, otherwise return getter
  - orElse
```
default ToBoolean<T> orElse(Boolean value)
```
    Description copied from interface: ToNullable
    
    Returns an equivalent expression as this, except that it will return the value if given an argument that would cause this expression to return null.
    
    Specified by:
    
    orElse in interface ToNullable<T,Boolean,ToBoolean<T>>
    
    Parameters:
    
    value - value to use if null
    
    Returns:
    
    the expression if present, otherwise return value
  - mapToDoubleIfPresent
```
default ToDoubleNullable<T> mapToDoubleIfPresent(com.speedment.common.function.BooleanToDoubleFunction mapper)
```
    Description copied from interface: HasMapToDoubleIfPresent
    
    Maps the result of this expression into a double by passing it to the specified mapper, producing a new expression that implements ToDouble. If this expression would have evaluated to null, then the new expression will as well.
    
    Specified by:
    
    mapToDoubleIfPresent in interface HasMapToDoubleIfPresent<T,com.speedment.common.function.BooleanToDoubleFunction>
    
    Parameters:
    
    mapper - the mapper to use on the result of this expression
    
    Returns:
    
    the new mapped expression
  - mapIfPresent
```
default ToBooleanNullable<T> mapIfPresent(com.speedment.common.function.BooleanUnaryOperator mapper)
```
    Description copied from interface: HasMapIfPresent
    
    Returns an expression for the value of this expression mapped using the specified mapping function. The input type remains the same.
    
    Specified by:
    
    mapIfPresent in interface HasMapIfPresent<T,com.speedment.common.function.BooleanUnaryOperator,ToBooleanNullable<T>>
    
    Parameters:
    
    mapper - the mapping function
    
    Returns:
    
    the mapped expression
  - hash
```
default long hash(T object)
```
    Description copied from interface: HasHash
    
    Hash the specified object into a 64-bit hash. If two equal objects are hashed, they must always result in the same hash. However, objects that are not equal may also result in the same hash.
    
    Specified by:
    
    hash in interface HasHash<T>
    
    Parameters:
    
    object - the object to hash
    
    Returns:
    
    the 64-bit hashcode
  - compare
```
default int compare(T first,
                    T second)
```
    Specified by:
    
    compare in interface Comparator<T>
    
    Specified by:
    
    compare in interface HasCompare<T>
  - compose
```
default <V> ToBooleanNullable<V> compose(Function<? super V,? extends T> before)
```
    Description copied from interface: HasCompose
    
    Returns a composed expression that first applies the before function to its input, and then applies this function to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.
    
    Specified by:
    
    compose in interface Function<T,Boolean>
    
    Specified by:
    
    compose in interface HasCompose<T>
    
    Type Parameters:
    
    V - the type of input to the before function, and to the composed expression
    
    Parameters:
    
    before - the function to apply before this function is applied
    
    Returns:
    
    a composed function that first applies the before function and then applies this function

Interface ToBooleanNullable<T>

Method Summary

Methods inherited from interface com.speedment.common.function.ToBooleanFunction

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface com.speedment.runtime.compute.trait.ToNullable

Methods inherited from interface java.util.function.Function

Methods inherited from interface java.util.Comparator

Method Detail

of

expressionType

applyAsBoolean

orThrow

orElseGet

orElse

mapToDoubleIfPresent

mapIfPresent

hash

compare

compose