Top Description Methods
jakarta.persistence.criteria

public Interface CollectionJoin<Z, E>

extends PluralJoin<Z, Collection<E>, E>
Type Parameters
<Z>
the source type of the join
<E>
the element type of the target Collection
Imports
java.util.Collection, jakarta.persistence.metamodel.CollectionAttribute
The CollectionJoin interface is the type of the result of joining to a collection over an association or element collection that has been specified as a java.util.Collection.
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public CollectionAttribute<? super Z, E>

Returns:

metamodel type representing the Collection that is the target of the join
getModel()

Redeclares jakarta.persistence.criteria.PluralJoin.getModel.

Return the metamodel representation for the collection attribute.

public CollectionJoin<Z, E>

Returns:

the modified join object
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Redeclares jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.

public CollectionJoin<Z, E>

Returns:

the modified join object
on(Predicate...
zero or more restriction predicates
restrictions)

Redeclares jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.

Method Detail

getModelback to summary
public CollectionAttribute<? super Z, E> getModel()

Redeclares jakarta.persistence.criteria.PluralJoin.getModel.

Return the metamodel representation for the collection attribute.

Returns:CollectionAttribute<? super Z, E>

metamodel type representing the Collection that is the target of the join

onback to summary
public CollectionJoin<Z, E> on(Expression<Boolean> restriction)

Redeclares jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Parameters
restriction:Expression<Boolean>

a simple or compound boolean expression

Returns:CollectionJoin<Z, E>

the modified join object

Since
2.1
onback to summary
public CollectionJoin<Z, E> on(Predicate... restrictions)

Redeclares jakarta.persistence.criteria.Join.on.

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Parameters
restrictions:Predicate[]

zero or more restriction predicates

Returns:CollectionJoin<Z, E>

the modified join object

Since
2.1