Package org.omnifaces.persistence.criteria

Class Enumerated

java.lang.Object

org.omnifaces.persistence.criteria.Criteria<Enum<?>>

org.omnifaces.persistence.criteria.Enumerated

public final class Enumerated
extends Criteria<Enum<?>>

Creates path = enum.

Author:

Bauke Scholtz

Nested Class Summary

Nested classes/interfaces inherited from class org.omnifaces.persistence.criteria.Criteria

Criteria.ParameterBuilder

Method Summary

Modifier and Type	Method	Description
boolean	applies(Object modelValue)	Returns whether this criteria value would apply to the given model value.
Predicate	build(Expression<?> path, CriteriaBuilder criteriaBuilder, Criteria.ParameterBuilder parameterBuilder)	Returns a predicate for the criteria value.
static Enumerated	parse(Object searchValue, Class<Enum<?>> targetType)
static Enumerated	value(Enum<?> value)

Methods inherited from class org.omnifaces.persistence.criteria.Criteria

equals, getValue, hashCode, toString, unwrap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

value

public static Enumerated value(Enum<?> value)

parse

public static Enumerated parse(Object searchValue,
                               Class<Enum<?>> targetType)

build

public Predicate build(Expression<?> path,
                       CriteriaBuilder criteriaBuilder,
                       Criteria.ParameterBuilder parameterBuilder)

Description copied from class: Criteria

Returns a predicate for the criteria value. Below is an example implementation:

 return criteriaBuilder.equal(path, parameterBuilder.create(getValue()));
 

Specified by:

build in class Criteria<Enum<?>>

Parameters:

path - Entity property path. You can use this to inspect the target entity property.

criteriaBuilder - So you can build a predicate with a ParameterExpression.

parameterBuilder - You must use this to create a ParameterExpression for the criteria value.

Returns:

A predicate for the criteria value.

applies

public boolean applies(Object modelValue)

Description copied from class: Criteria

Returns whether this criteria value would apply to the given model value. This must basically represent the "plain Java" equivalent of the SQL behavior as achieved by Criteria.build(Expression, CriteriaBuilder, ParameterBuilder).

Overrides:

applies in class Criteria<Enum<?>>

Parameters:

modelValue - The model value to test this criteria on.

Returns:

Whether this criteria value would apply to the given model value.