ToBoolean (Speedment - Build - Runtime Deploy 3.1.12 API)

Type Parameters:

T - type to extract from

All Superinterfaces:

Comparator<T>, Expression<T>, HasAsDouble<T>, HasAsInt<T>, HasAsLong<T>, HasCompare<T>, HasCompose<T>, HasHash<T>, HasMap<T,com.speedment.common.function.BooleanUnaryOperator,ToBoolean<T>>, HasMapToDouble<T,com.speedment.common.function.BooleanToDoubleFunction>, Predicate<T>, com.speedment.common.function.ToBooleanFunction<T>

All Known Subinterfaces:

BooleanField<ENTITY,D>, CombinedPredicate<ENTITY>, ComposedPredicate<ENTITY,A>, FieldIsNotNullPredicate<ENTITY,T>, FieldIsNullPredicate<ENTITY,T>, FieldPredicate<ENTITY>, SpeedmentPredicate<ENTITY>, ToBooleanOrElse<T>, ToBooleanOrElseGet<T>, ToBooleanOrThrow<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 ToBoolean<T>
extends Expression<T>, com.speedment.common.function.ToBooleanFunction<T>, HasAsDouble<T>, HasAsInt<T>, HasAsLong<T>, HasMap<T,com.speedment.common.function.BooleanUnaryOperator,ToBoolean<T>>, HasMapToDouble<T,com.speedment.common.function.BooleanToDoubleFunction>, HasHash<T>, HasCompare<T>, HasCompose<T>
```
Expression that given an entity returns a boolean value. 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:

ToBooleanFunction, Predicate

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`applyAsBoolean(T object)` Applies this function to the given argument.
`default ToDouble<T>`	`asDouble()` Returns an expression that casts the result of the current expression into a `double`.
`default ToInt<T>`	`asInt()` Returns an expression that casts the result of the current expression into an `int`.
`default ToLong<T>`	`asLong()` Returns an expression that casts the result of the current expression into a `long`.
`default int`	`compare(T first, T second)`
`default <V> ToBoolean<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 <V> ToBooleanNullable<V>`	`composeNullable(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 ToBoolean<T>`	`map(com.speedment.common.function.BooleanUnaryOperator operator)` Returns an expression for the value of this expression mapped using the specified mapping function.
`default ToDouble<T>`	`mapToDouble(com.speedment.common.function.BooleanToDoubleFunction operator)` 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> ToBoolean<T>`	`of(Predicate<T> lambda)` Returns a typed `ToBoolean<T>` using the provided `lambda`.

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 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> ToBoolean<T> of(Predicate<T> lambda)
```
    Returns a typed ToBoolean<T> using the provided lambda.
    
    Type Parameters:
    
    T - type to extract from
    
    Parameters:
    
    lambda - to convert
    
    Returns:
    
    a typed ToBoolean<T> using the provided lambda
    
    Throws:
    
    NullPointerException - if the provided lambda is null
  - applyAsBoolean
```
boolean applyAsBoolean(T object)
```
    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
  - 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
  - asDouble
```
default ToDouble<T> asDouble()
```
    Description copied from interface: HasAsDouble
    
    Returns an expression that casts the result of the current expression into a double.
    
    Specified by:
    
    asDouble in interface HasAsDouble<T>
    
    Returns:
    
    the casted expression
  - asInt
```
default ToInt<T> asInt()
```
    Description copied from interface: HasAsInt
    
    Returns an expression that casts the result of the current expression into an int.
    
    Specified by:
    
    asInt in interface HasAsInt<T>
    
    Returns:
    
    the casted expression
  - asLong
```
default ToLong<T> asLong()
```
    Description copied from interface: HasAsLong
    
    Returns an expression that casts the result of the current expression into a long.
    
    Specified by:
    
    asLong in interface HasAsLong<T>
    
    Returns:
    
    the casted expression
  - mapToDouble
```
default ToDouble<T> mapToDouble(com.speedment.common.function.BooleanToDoubleFunction operator)
```
    Description copied from interface: HasMapToDouble
    
    Maps the result of this expression into a double by passing it to the specified mapper, producing a new expression that implements ToDouble.
    
    Specified by:
    
    mapToDouble in interface HasMapToDouble<T,com.speedment.common.function.BooleanToDoubleFunction>
    
    Parameters:
    
    operator - the mapper to use on the result of this expression
    
    Returns:
    
    the new mapped expression
  - map
```
default ToBoolean<T> map(com.speedment.common.function.BooleanUnaryOperator operator)
```
    Description copied from interface: HasMap
    
    Returns an expression for the value of this expression mapped using the specified mapping function. The input type remains the same.
    
    Specified by:
    
    map in interface HasMap<T,com.speedment.common.function.BooleanUnaryOperator,ToBoolean<T>>
    
    Parameters:
    
    operator - 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> ToBoolean<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. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.
    ToBoolean is a bit special when it comes to the compose()-method. If the before method returns null, the composed expression will return false. This is to remain compatible with how Speedment handles predicates in streams. To get a ToBooleanNullable that acts as you might expect, instead use compose(java.util.function.Function<? super V, ? extends T>)
    
    Specified by:
    
    compose in interface HasCompose<T>
    
    Type Parameters:
    
    V - the input type of the before function
    
    Parameters:
    
    before - the function to apply before this function is applied
    
    Returns:
    
    the composed expression
  - composeNullable
```
default <V> ToBooleanNullable<V> composeNullable(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. If evaluation of either function throws an exception, it is relayed to the caller of the composed function.
    
    Type Parameters:
    
    V - the input type of the before function
    
    Parameters:
    
    before - the function to apply before this function is applied
    
    Returns:
    
    the composed expression
    
    Since:
    
    3.1.2

Interface ToBoolean<T>

Method Summary

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

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface java.util.Comparator

Method Detail

of

applyAsBoolean

expressionType

asDouble

asInt

asLong

mapToDouble

map

hash

compare

compose

composeNullable