Interface JpaTupleElement<T>

All Superinterfaces:

JpaCriteriaNode, Serializable, TupleElement<T>

All Known Subinterfaces:

DiscriminatorSqmPath<T>, JpaCoalesce<T>, JpaCollectionJoin<O,T>, JpaCompoundSelection<T>, JpaCrossJoin<L,T>, JpaDerivedFrom<T>, JpaDerivedJoin<T>, JpaDerivedRoot<T>, JpaEntityJoin<L,R>, JpaExpression<T>, JpaFrom<O,T>, JpaFunction<T>, JpaFunctionFrom<O,T>, JpaFunctionJoin<E>, JpaFunctionRoot<E>, JpaJoin<L,R>, JpaJsonExistsExpression, JpaJsonQueryExpression, JpaJsonValueExpression<T>, JpaListJoin<O,T>, JpaMapJoin<O,K,V>, JpaPath<T>, JpaPluralExpression<C,E>, JpaPluralJoin<O,C,E>, JpaRoot<T>, JpaSearchedCase<T>, JpaSelection<T>, JpaSetJoin<O,T>, JpaSimpleCase<C,R>, JpaSubQuery<T>, JpaTreatedFrom<L,R,R1>, JpaTreatedJoin<L,R,R1>, JpaTreatedPath<T,S>, JpaXmlElementExpression, SqmAggregateFunction<T>, SqmAttributeJoin<O,T>, SqmBooleanExpression, SqmBooleanExpressionImplementor, SqmBooleanPath, SqmComparableExpression<C>, SqmComparableExpressionImplementor<C>, SqmCorrelatedJoin<L,R>, SqmCorrelatedSingularValuedJoin<L,R>, SqmCorrelation<L,R>, SqmExpression<T>, SqmExpressionWrapper<T>, SqmFrom<L,R>, SqmInPredicate<T>, SqmJoin<L,R>, SqmNegatablePredicate, SqmNumericExpression<N>, SqmNumericExpressionImplementor<N>, SqmNumericPath<N>, SqmOrderedSetAggregateFunction<T>, SqmParameter<T>, SqmPath<T>, SqmPathWrapper<W,T>, SqmPluralPath<C,E>, SqmPredicate, SqmSelectableNode<T>, SqmSimplePath<T>, SqmSingularValuedJoin<L,R>, SqmTemporalExpression<T>, SqmTemporalExpressionImplementor<T>, SqmTemporalPath<T>, SqmTextExpression, SqmTextExpressionImplementor, SqmTextPath, SqmTreatedAttributeJoin<L,R,R1>, SqmTreatedFrom<L,R,R1>, SqmTreatedJoin<L,R,R1>, SqmTreatedPath<T,S>, SqmWindowFunction<T>

All Known Implementing Classes:

AbstractJpaSelection, AbstractJpaTupleElement, AbstractNegatableSqmPredicate, AbstractSqmAttributeJoin, AbstractSqmExpression, AbstractSqmFrom, AbstractSqmJoin, AbstractSqmJsonPathExpression, AbstractSqmParameter, AbstractSqmPath, AbstractSqmPluralJoin, AbstractSqmPredicate, AbstractSqmSimplePath, AbstractSqmSpecificPluralPartPath, AsWrapperSqmExpression, FormatFunction.FormatSqmFunction, InverseDistributionFunction.SelfRenderingInverseDistributionFunction, JpaCriteriaParameter, NonAggregatedCompositeSimplePath, SelfRenderingSqmAggregateFunction, SelfRenderingSqmFunction, SelfRenderingSqmOrderedSetAggregateFunction, SelfRenderingSqmWindowFunction, SqmAliasedNodeRef, SqmAny, SqmAnyDiscriminatorValue, SqmAnyValuedSimplePath, SqmBagJoin, SqmBasicValuedSimplePath, SqmBetweenPredicate, SqmBinaryArithmetic, SqmBooleanExpressionPredicate, SqmBooleanExpressionWrapper, SqmBooleanValuedSimplePath, SqmByUnit, SqmCaseSearched, SqmCaseSimple, SqmCoalesce, SqmCollation, SqmCollectionSize, SqmComparableExpressionWrapper, SqmComparableValuedSimplePath, SqmComparisonPredicate, SqmCorrelatedBagJoin, SqmCorrelatedCrossJoin, SqmCorrelatedCteJoin, SqmCorrelatedDerivedJoin, SqmCorrelatedDerivedRoot, SqmCorrelatedDerivedRootJoin, SqmCorrelatedEntityJoin, SqmCorrelatedListJoin, SqmCorrelatedMapJoin, SqmCorrelatedPluralPartJoin, SqmCorrelatedRoot, SqmCorrelatedRootJoin, SqmCorrelatedSetJoin, SqmCorrelatedSingularJoin, SqmCrossJoin, SqmCteJoin, SqmCteRoot, SqmDerivedJoin, SqmDerivedRoot, SqmDynamicInstantiation, SqmElementAggregateFunction, SqmEmbeddedValuedSimplePath, SqmEmptinessPredicate, SqmEntityJoin, SqmEntityValuedSimplePath, SqmEnumLiteral, SqmEvery, SqmExistsPredicate, SqmFieldLiteral, SqmFkExpression, SqmFormat, SqmFunction, SqmFunctionJoin, SqmFunctionPath, SqmFunctionRoot, SqmGroupedPredicate, SqmHqlNumericLiteral, SqmIndexAggregateFunction, SqmIndexedCollectionAccessPath, SqmInListPredicate, SqmInSubQueryPredicate, SqmJpaCompoundSelection, SqmJpaCriteriaParameterWrapper, SqmJsonExistsExpression, SqmJsonQueryExpression, SqmJsonValueExpression, SqmJunctionPredicate, SqmLikePredicate, SqmListJoin, SqmLiteral, SqmLiteralEmbeddableType, SqmLiteralEntityType, SqmLiteralNull, SqmMapEntryReference, SqmMapJoin, SqmMemberOfPredicate, SqmModifiedSubQueryExpression, SqmNamedExpression, SqmNamedParameter, SqmNegatedPredicate, SqmNullnessPredicate, SqmNumericExpressionWrapper, SqmNumericValuedSimplePath, SqmOver, SqmOverflow, SqmParameterizedEntityType, SqmPluralPartJoin, SqmPluralPartSelectionPath, SqmPluralValuedSimplePath, SqmPositionalParameter, SqmRoot, SqmSelectClause, SqmSelfRenderingExpression, SqmSetJoin, SqmSingularJoin, SqmStar, SqmSubQuery, SqmSummarization, SqmTemporalExpressionWrapper, SqmTemporalValuedSimplePath, SqmTextExpressionWrapper, SqmTextValuedSimplePath, SqmToDuration, SqmTreatedBagJoin, SqmTreatedCrossJoin, SqmTreatedEmbeddedValuedSimplePath, SqmTreatedEntityJoin, SqmTreatedEntityValuedSimplePath, SqmTreatedListJoin, SqmTreatedMapJoin, SqmTreatedPluralPartJoin, SqmTreatedRoot, SqmTreatedSetJoin, SqmTreatedSimplePath, SqmTreatedSingularJoin, SqmTruthnessPredicate, SqmTuple, SqmUnaryOperation, SqmXmlElementExpression, ValueBindJpaCriteriaParameter

public interface JpaTupleElement<T>
extends TupleElement<T>, JpaCriteriaNode

API extension to the JPA TupleElement contract

Method Summary

Modifier and Type	Method	Description
default Class<T>	getJavaType()	Return the Java type of the tuple element.
JavaType<T>	getJavaTypeDescriptor()	Return the Java type of this tuple element.
default Class<T>	getJavaTypeIfKnown()	Return the Java type, or null while type inference is incomplete.
default String	getJavaTypeName()	Return the Java type name of this tuple element, or null while type inference is incomplete.
default boolean	isEnum()	Return whether this tuple element has an enum Java type.

Methods inherited from interface TupleElement

getAlias

Method Details

getJavaTypeDescriptor

@SPI(USE)
@Nullable
JavaType<T> getJavaTypeDescriptor()

Return the Java type of this tuple element.

getJavaType

@Nonnull
default Class<T> getJavaType()

Return the Java type of the tuple element.

Specified by:

getJavaType in interface TupleElement<T>

Throws:

IllegalStateException - if the Java type has not yet been determined

getJavaTypeIfKnown

@Internal
@Nullable
default Class<T> getJavaTypeIfKnown()

Return the Java type, or null while type inference is incomplete.

getJavaTypeName

@Nullable
default String getJavaTypeName()

Return the Java type name of this tuple element, or null while type inference is incomplete.

isEnum

default boolean isEnum()

Return whether this tuple element has an enum Java type.