Top Description Methods
jakarta.persistence.criteria

public Interface MapJoin<Z, K, V>

extends PluralJoin<Z, Map<K, V>, V>
Type Parameters
<Z>
the source type of the join
<K>
the type of the target Map key
<V>
the type of the target Map value
Imports
java.util.Map, jakarta.persistence.metamodel.MapAttribute
The MapJoin 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.Map.
Since
2.0

Method Summary

Modifier and TypeMethod and Description
public Expression<Map.Entry<K, V>>

Returns:

expression corresponding to the map entry
entry()

Create an expression that corresponds to the map entry.

public MapAttribute<? super Z, K, V>

Returns:

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

Redeclares jakarta.persistence.criteria.PluralJoin.getModel.

Return the metamodel representation for the map attribute.
public Path<K>

Returns:

path corresponding to map key
key()

Create a path expression that corresponds to the map key.

public MapJoin<Z, K, V>

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 MapJoin<Z, K, V>

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.
public Path<V>

Returns:

path corresponding to the map value
value()

Create a path expression that corresponds to the map value.

Method Detail

entryback to summary
public Expression<Map.Entry<K, V>> entry()

Create an expression that corresponds to the map entry.

Returns:Expression<Map.Entry<K, V>>

expression corresponding to the map entry

getModelback to summary
public MapAttribute<? super Z, K, V> getModel()

Redeclares jakarta.persistence.criteria.PluralJoin.getModel.

Return the metamodel representation for the map attribute.

Returns:MapAttribute<? super Z, K, V>

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

keyback to summary
public Path<K> key()

Create a path expression that corresponds to the map key.

Returns:Path<K>

path corresponding to map key

onback to summary
public MapJoin<Z, K, V> 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:MapJoin<Z, K, V>

the modified join object

Since
2.1
onback to summary
public MapJoin<Z, K, V> 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:MapJoin<Z, K, V>

the modified join object

Since
2.1
valueback to summary
public Path<V> value()

Create a path expression that corresponds to the map value. This method is for stylistic use only: it just returns this.

Returns:Path<V>

path corresponding to the map value