Java Persistence API 2.2 · javax.persistence.criteria.ListJoin

Method Summary

Modifier and Type	Method and Description
public ListAttribute<? super Z, E>	Returns: metamodel type representing the `List` that is the target of the join getModel() Redeclares javax.persistence.criteria.PluralJoin.getModel. Return the metamodel representation for the list attribute.
public Expression<Integer>	Returns: expression denoting the index index() Create an expression that corresponds to the index of the object in the referenced association or element collection.
public ListJoin<Z, E>	Returns: the modified join object on(Expression<Boolean> a simple or compound boolean expression restriction) Redeclares javax.persistence.criteria.Join.on. Modify the join to restrict the result according to the specified ON condition and return the join object.
public ListJoin<Z, E>	Returns: the modified join object on(Predicate... zero or more restriction predicates restrictions) Redeclares javax.persistence.criteria.Join.on. Modify the join to restrict the result according to the specified ON condition and return the join object.

Method Detail

getModel back to summary

getModel	back to summary
public ListAttribute<? super Z, E> getModel() Redeclares javax.persistence.criteria.PluralJoin.getModel. Return the metamodel representation for the list attribute. Returns:ListAttribute<? super Z, E> metamodel type representing the `List` that is the target of the join

public ListAttribute<? super Z, E> getModel()

Redeclares javax.persistence.criteria.PluralJoin.getModel.

Return the metamodel representation for the list attribute.

Returns:ListAttribute<? super Z, E>: metamodel type representing the List that is the target of the join

index	back to summary
public Expression<Integer> index() Create an expression that corresponds to the index of the object in the referenced association or element collection. This method must only be invoked upon an object that represents an association or element collection for which an order column has been defined. Returns:Expression<Integer> expression denoting the index

index

back to summary

public Expression<Integer> index()

Create an expression that corresponds to the index of the object in the referenced association or element collection. This method must only be invoked upon an object that represents an association or element collection for which an order column has been defined.

Returns:Expression<Integer>: expression denoting the index

on	back to summary
public ListJoin<Z, E> on(Expression<Boolean> restriction) Redeclares javax.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:ListJoin<Z, E> the modified join object Since Java Persistence 2.1

back to summary

public ListJoin<Z, E> on(Expression<Boolean> restriction)

Redeclares javax.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:ListJoin<Z, E>

the modified join object

Since

Java Persistence 2.1

on	back to summary
public ListJoin<Z, E> on(Predicate... restrictions) Redeclares javax.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:ListJoin<Z, E> the modified join object Since Java Persistence 2.1

back to summary

public ListJoin<Z, E> on(Predicate... restrictions)

Redeclares javax.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:ListJoin<Z, E>

the modified join object

Since

Java Persistence 2.1

public Interface ListJoin<Z, E>

Method Summary

Method Detail