Package org.hibernate.models.spi

Interface FieldDetails

All Superinterfaces:

AnnotationTarget, MemberDetails

All Known Implementing Classes:

DynamicFieldDetails, JdkFieldDetails

public interface FieldDetails
extends MemberDetails

Models a field in a class

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.models.spi.AnnotationTarget

AnnotationTarget.AnnotationUsageProcessor<T,A extends Annotation>, AnnotationTarget.Kind

Nested classes/interfaces inherited from interface org.hibernate.models.spi.MemberDetails

MemberDetails.Visibility

Method Summary

Modifier and Type	Method	Description
default FieldDetails	asFieldDetails()	Safe cast method for cases when the target is a field.
default MethodDetails	asMethodDetails()	Safe cast method for cases when the target is a method.
default RecordComponentDetails	asRecordComponentDetails()	Safe cast method for cases when the target is a record component.
default AnnotationTarget.Kind	getKind()	The kind of target
default boolean	isPersistable()	Can this member be a persistent attribute
default String	resolveAttributeName()	For members potentially representing attributes based on naming patterns, determine the attribute name.
Field	toJavaMember()	Access to the underlying Member.
Field	toJavaMember(Class<?> declaringClass, ClassLoading classLoading, ModelsContext modelContext)

Methods inherited from interface org.hibernate.models.spi.AnnotationTarget

forEachAnnotationUsage, forEachAnnotationUsage, forEachDirectAnnotationUsage, forEachRepeatedAnnotationUsages, forEachRepeatedAnnotationUsages, fromAnnotations, fromContainers, fromSelfAndContainers, getAnnotationUsage, getAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsages, getMetaAnnotated, getNamedAnnotationUsage, getNamedAnnotationUsage, getNamedAnnotationUsage, getNamedAnnotationUsage, getRepeatedAnnotationUsages, getRepeatedAnnotationUsages, hasAnnotationUsage, hasDirectAnnotationUsage, locateAnnotationUsage, walkContainers, walkSelfAndContainers

Methods inherited from interface org.hibernate.models.spi.MemberDetails

asAnnotationDescriptor, asClassDetails, asMemberDetails, getAssociatedType, getContainer, getDeclaringType, getElementType, getMapKeyType, getModifiers, getName, getType, getVisibility, isArray, isField, isFinal, isPlural, isStatic, isSynthetic, resolveRelativeAssociatedType, resolveRelativeClassType, resolveRelativeType

Method Details

getKind

default AnnotationTarget.Kind getKind()

Description copied from interface: AnnotationTarget

The kind of target

Specified by:

getKind in interface AnnotationTarget

resolveAttributeName

default String resolveAttributeName()

Description copied from interface: MemberDetails

For members potentially representing attributes based on naming patterns, determine the attribute name. Return null if the name does not match the pattern for an attribute name.

Specified by:

resolveAttributeName in interface MemberDetails

Returns:

The potential attribute name, or null.

isPersistable

default boolean isPersistable()

Description copied from interface: MemberDetails

Can this member be a persistent attribute

Specified by:

isPersistable in interface MemberDetails

toJavaMember

Field toJavaMember()

Description copied from interface: MemberDetails

Access to the underlying Member. May return null. May throw an exception.

Specified by:

toJavaMember in interface MemberDetails

Returns:

The underlying member, or null if there is no underlying member.

toJavaMember

Field toJavaMember(Class<?> declaringClass,
 ClassLoading classLoading,
 ModelsContext modelContext)

Specified by:

toJavaMember in interface MemberDetails

asFieldDetails

default FieldDetails asFieldDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a field.

Specified by:

asFieldDetails in interface AnnotationTarget

asMethodDetails

default MethodDetails asMethodDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a method.

Specified by:

asMethodDetails in interface AnnotationTarget

asRecordComponentDetails

default RecordComponentDetails asRecordComponentDetails()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is a record component.

Specified by:

asRecordComponentDetails in interface AnnotationTarget