Top Description Fields Constructors Methods
org.hibernate.query.criteria.internal.predicate

public Class InPredicate<T>

extends AbstractSimplePredicate
implements CriteriaBuilder.In<T>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, javax.persistence.criteria.CriteriaBuilder.In, javax.persistence.criteria.Predicate, javax.persistence.criteria.Expression, javax.persistence.criteria.Selection, javax.persistence.TupleElement
Imports
java.io.Serializable, java.util.ArrayList, .Arrays, .Collection, .List, javax.persistence.criteria.Expression, .Subquery, org.hibernate.engine.spi.SessionFactoryImplementor, org.hibernate.query.criteria.internal.CriteriaBuilderImpl, .ParameterRegistry, .Renderable, .ValueHandlerFactory, org.hibernate.query.criteria.internal.compile.RenderingContext, org.hibernate.query.criteria.internal.expression.LiteralExpression, .ParameterExpressionImpl, org.hibernate.type.Type

Models a [NOT] IN restriction
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final Expression<? extends T>
private final List<Expression<? extends T>>

Constructor Summary

AccessConstructor and Description
public
InPredicate(CriteriaBuilderImpl
The query builder from which this originates.
criteriaBuilder
,
Expression<? extends T>
The expression.
expression
)

Constructs an IN predicate against a given expression with an empty list of values.

public
InPredicate(CriteriaBuilderImpl
The query builder from which this originates.
criteriaBuilder
,
Expression<? extends T>
The expression.
expression
,
Expression<? extends T>...
The value list.
values
)

Constructs an IN predicate against a given expression with the given list of expression values.

public
InPredicate(CriteriaBuilderImpl
The query builder from which this originates.
criteriaBuilder
,
Expression<? extends T>
The expression.
expression
,
List<Expression<? extends T>>
The value list.
values
)

Constructs an IN predicate against a given expression with the given list of expression values.

public
InPredicate(CriteriaBuilderImpl
The query builder from which this originates.
criteriaBuilder
,
Expression<? extends T>
The expression.
expression
,
T...
The value list.
values
)

Constructs an IN predicate against a given expression with the given given literal value list.

public
InPredicate(CriteriaBuilderImpl
The query builder from which this originates.
criteriaBuilder
,
Expression<? extends T>
The expression.
expression
,
Collection<T>
The value list.
values
)

Constructs an IN predicate against a given expression with the given literal value list.

Method Summary

Modifier and TypeMethod and Description
public Expression<T>
getExpression()

Implements javax.persistence.criteria.CriteriaBuilder.In.getExpression.

Return the expression to be tested against the list of values.
public Expression<? extends T>
public List<Expression<? extends T>>
public void
registerParameters(ParameterRegistry
The parameter registry with which to register.
registry
)

Implements org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Register any parameters contained within this query component with the given registry.
public String
render(boolean
Should the predicate be negated.
isNegated
,
RenderingContext
The context for rendering
renderingContext
)

Implements org.hibernate.query.criteria.internal.predicate.PredicateImplementor.render.

Form of Renderable#render used when the predicate is wrapped in a negated wrapper.
public InPredicate<T>
value(T
value
value
)

Implements javax.persistence.criteria.CriteriaBuilder.In.value.

Add to list of values to be tested against.
public InPredicate<T>
value(Expression<? extends T>
expression
value
)

Implements javax.persistence.criteria.CriteriaBuilder.In.value, javax.persistence.criteria.CriteriaBuilder.In.value.

Add to list of values to be tested against.
Inherited from org.hibernate.query.criteria.internal.predicate.AbstractSimplePredicate:
getExpressionsgetOperatorisJunctionrender

Field Detail

expressionback to summary
private final Expression<? extends T> expression
valuesback to summary
private final List<Expression<? extends T>> values

Constructor Detail

InPredicateback to summary
public InPredicate(CriteriaBuilderImpl criteriaBuilder, Expression<? extends T> expression)

Constructs an IN predicate against a given expression with an empty list of values.

Parameters
criteriaBuilder:CriteriaBuilderImpl

The query builder from which this originates.

expression:Expression<? extends T>

The expression.

InPredicateback to summary
public InPredicate(CriteriaBuilderImpl criteriaBuilder, Expression<? extends T> expression, Expression<? extends T>... values)

Constructs an IN predicate against a given expression with the given list of expression values.

Parameters
criteriaBuilder:CriteriaBuilderImpl

The query builder from which this originates.

expression:Expression<? extends T>

The expression.

values:Expression<? extends T>[]

The value list.

InPredicateback to summary
public InPredicate(CriteriaBuilderImpl criteriaBuilder, Expression<? extends T> expression, List<Expression<? extends T>> values)

Constructs an IN predicate against a given expression with the given list of expression values.

Parameters
criteriaBuilder:CriteriaBuilderImpl

The query builder from which this originates.

expression:Expression<? extends T>

The expression.

values:List<Expression<? extends T>>

The value list.

InPredicateback to summary
public InPredicate(CriteriaBuilderImpl criteriaBuilder, Expression<? extends T> expression, T... values)

Constructs an IN predicate against a given expression with the given given literal value list.

Parameters
criteriaBuilder:CriteriaBuilderImpl

The query builder from which this originates.

expression:Expression<? extends T>

The expression.

values:T[]

The value list.

InPredicateback to summary
public InPredicate(CriteriaBuilderImpl criteriaBuilder, Expression<? extends T> expression, Collection<T> values)

Constructs an IN predicate against a given expression with the given literal value list.

Parameters
criteriaBuilder:CriteriaBuilderImpl

The query builder from which this originates.

expression:Expression<? extends T>

The expression.

values:Collection<T>

The value list.

Annotations
@SuppressWarnings:unchecked

Method Detail

getExpressionback to summary
public Expression<T> getExpression()

Implements javax.persistence.criteria.CriteriaBuilder.In.getExpression.

Doc from javax.persistence.criteria.CriteriaBuilder.In.getExpression.

Return the expression to be tested against the list of values.

Returns:Expression<T>

expression

Annotations
@Override
@SuppressWarnings:unchecked
getExpressionInternalback to summary
public Expression<? extends T> getExpressionInternal()
getValuesback to summary
public List<Expression<? extends T>> getValues()
registerParametersback to summary
public void registerParameters(ParameterRegistry registry)

Implements org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Doc from org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Register any parameters contained within this query component with the given registry.

Parameters
registry:ParameterRegistry

The parameter registry with which to register.

Annotations
@Override
renderback to summary
public String render(boolean isNegated, RenderingContext renderingContext)

Implements org.hibernate.query.criteria.internal.predicate.PredicateImplementor.render.

Doc from org.hibernate.query.criteria.internal.predicate.PredicateImplementor.render.

Form of Renderable#render used when the predicate is wrapped in a negated wrapper. Allows passing down the negation flag.

Note that this form is no-op in compound (junction) predicates. The reason being that compound predicates are more complex and the negation is applied during its creation.

Parameters
isNegated:boolean

Should the predicate be negated.

renderingContext:RenderingContext

The context for rendering

Returns:String

The rendered predicate fragment.

Annotations
@Override
valueback to summary
public InPredicate<T> value(T value)

Implements javax.persistence.criteria.CriteriaBuilder.In.value.

Doc from javax.persistence.criteria.CriteriaBuilder.In.value.

Add to list of values to be tested against.

Parameters
value:T

value

Returns:InPredicate<T>

in predicate

Annotations
@Override
valueback to summary
public InPredicate<T> value(Expression<? extends T> value)

Implements javax.persistence.criteria.CriteriaBuilder.In.value, javax.persistence.criteria.CriteriaBuilder.In.value.

Doc from javax.persistence.criteria.CriteriaBuilder.In.value.

Add to list of values to be tested against.

Parameters
value:Expression<? extends T>

expression

Returns:InPredicate<T>

in predicate

Annotations
@Override