JpaJoin (Hibernate JavaDocs)

All Superinterfaces:

jakarta.persistence.criteria.Expression<T>, jakarta.persistence.criteria.FetchParent<O,T>, jakarta.persistence.criteria.From<O,T>, jakarta.persistence.criteria.Join<O,T>, JpaCriteriaNode, JpaExpression<T>, JpaFetchParent<O,T>, JpaFrom<O,T>, JpaJoinedFrom<O,T>, JpaPath<T>, JpaSelection<T>, JpaTupleElement<T>, jakarta.persistence.criteria.Path<T>, jakarta.persistence.criteria.Selection<T>, Serializable, jakarta.persistence.TupleElement<T>

All Known Subinterfaces:

JpaCollectionJoin<O,T>, JpaListJoin<O,T>, JpaMapJoin<O,K,V>, JpaPluralJoin<O,C,E>, JpaSetJoin<O,T>, SqmAttributeJoin<O,T>

All Known Implementing Classes:

AbstractSqmAttributeJoin, AbstractSqmPluralJoin, SqmBagJoin, SqmCorrelatedBagJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmListJoin, SqmMapJoin, SqmSetJoin, SqmSingularJoin, SqmTreatedBagJoin, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedSetJoin, SqmTreatedSingularJoin
```
public interface JpaJoin<O,T>
extends JpaJoinedFrom<O,T>, jakarta.persistence.criteria.Join<O,T>
```
Consolidates the Join and Fetch hierarchies since that is how we implement them. This allows us to treat them polymorphically.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`PersistentAttribute<? super O,?>`	`getAttribute()`
`JpaJoin<O,T>`	`on(jakarta.persistence.criteria.Expression<Boolean> restriction)`
`JpaJoin<O,T>`	`on(jakarta.persistence.criteria.Predicate... restrictions)`
`JpaJoin<O,T>`	`on(JpaExpression<Boolean> restriction)`
`JpaJoin<O,T>`	`on(JpaPredicate... restrictions)`
`<S extends T> JpaJoin<O,S>`	`treatAs(Class<S> treatAsType)`	Support for JPA's explicit (TREAT) down-casting.
`<S extends T> JpaJoin<O,S>`	`treatAs(EntityDomainType<S> treatAsType)`	Support for JPA's explicit (TREAT) down-casting.

Methods inherited from interface jakarta.persistence.criteria.From
getJoins, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet

Methods inherited from interface jakarta.persistence.criteria.Join
getJoinType, getOn, getParent

Methods inherited from interface org.hibernate.query.criteria.JpaExpression
as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, in, in, in, in, isNotNull, isNull

Methods inherited from interface org.hibernate.query.criteria.JpaFetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches

Methods inherited from interface org.hibernate.query.criteria.JpaFrom
getCorrelationParent, join, join, join, join, join, join, join, joinLateral, joinLateral

Methods inherited from interface org.hibernate.query.criteria.JpaPath
get, get, get, get, getLhs, getNavigablePath, getParentPath, type

Methods inherited from interface org.hibernate.query.criteria.JpaSelection
alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement
getJavaType, getJavaTypeDescriptor

Methods inherited from interface jakarta.persistence.criteria.Path
getModel

Methods inherited from interface jakarta.persistence.criteria.Selection
isCompoundSelection

Methods inherited from interface jakarta.persistence.TupleElement
getAlias

- Method Detail
  - getAttribute
```
PersistentAttribute<? super O,?> getAttribute()
```
    Specified by:
    
    getAttribute in interface jakarta.persistence.criteria.Join<O,T>
  - on
```
JpaJoin<O,T> on(JpaExpression<Boolean> restriction)
```
  - on
```
JpaJoin<O,T> on(jakarta.persistence.criteria.Expression<Boolean> restriction)
```
    Specified by:
    
    on in interface jakarta.persistence.criteria.Join<O,T>
  - on
```
JpaJoin<O,T> on(JpaPredicate... restrictions)
```
  - on
```
JpaJoin<O,T> on(jakarta.persistence.criteria.Predicate... restrictions)
```
    Specified by:
    
    on in interface jakarta.persistence.criteria.Join<O,T>
  - treatAs
```
<S extends T> JpaJoin<O,S> treatAs(Class<S> treatAsType)
```
    Description copied from interface: JpaPath
    
    Support for JPA's explicit (TREAT) down-casting.
    
    Specified by:
    
    treatAs in interface JpaPath<O>
  - treatAs
```
<S extends T> JpaJoin<O,S> treatAs(EntityDomainType<S> treatAsType)
```
    Description copied from interface: JpaPath
    
    Support for JPA's explicit (TREAT) down-casting.
    
    Specified by:
    
    treatAs in interface JpaPath<O>