Package org.hibernate.models.internal.dynamic

Class DynamicFieldDetails

java.lang.Object

org.hibernate.models.internal.dynamic.AbstractAnnotationTarget

org.hibernate.models.internal.dynamic.DynamicFieldDetails

All Implemented Interfaces:

AnnotationTargetSupport, AnnotationTarget, FieldDetails, MemberDetails, MutableAnnotationTarget, MutableMemberDetails

public class DynamicFieldDetails
extends AbstractAnnotationTarget
implements FieldDetails, MutableMemberDetails

FieldDetails which does not necessarily map to a physical Field (dynamic models).

See Also:

• ModifierUtils.DYNAMIC_ATTRIBUTE_MODIFIERS

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

Constructor Summary

Constructors

Constructor	Description
DynamicFieldDetails(String name, TypeDetails type, ClassDetails declaringType, int modifierFlags, boolean isArray, boolean isPlural, ModelsContext modelsContext)	Constructs a dynamic FieldDetails.

Method Summary

Modifier and Type	Method	Description
<A extends Annotation> AnnotationDescriptor<A>	asAnnotationDescriptor()	Safe cast method for cases when the target is an annotation.
MutableClassDetails	asClassDetails()	Safe cast method for cases when the target is a class.
FieldDetails	asFieldDetails()	Safe cast method for cases when the target is a field.
MutableMemberDetails	asMemberDetails()	Safe cast method for cases when the target is a field, method or record component.
MethodDetails	asMethodDetails()	Safe cast method for cases when the target is a method.
RecordComponentDetails	asRecordComponentDetails()	Safe cast method for cases when the target is a record component.
ClassDetails	getDeclaringType()	The class which declares this member
int	getModifiers()	Access to the member modifier flags.
String	getName()	The name of the member.
TypeDetails	getType()	The member type.
boolean	isArray()
boolean	isPlural()	For member's with an associated type, whether that type considered plural.
TypeDetails	resolveRelativeType(TypeVariableScope container)	Determine the type of the member relative to the given container type.
Field	toJavaMember()	Access to the underlying Member.
Field	toJavaMember(Class<?> declaringClass, ClassLoading classLoading, ModelsContext modelContext)
String	toString()

Methods inherited from class org.hibernate.models.internal.dynamic.AbstractAnnotationTarget

clearAnnotationUsages, getModelContext, getUsageMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

forEachAnnotationUsage, forEachAnnotationUsage, forEachDirectAnnotationUsage, fromAnnotations, fromContainers, fromSelfAndContainers, getNamedAnnotationUsage, getRepeatedAnnotationUsages, walkContainers, walkSelfAndContainers

Methods inherited from interface org.hibernate.models.internal.AnnotationTargetSupport

addAnnotationUsage, forEachRepeatedAnnotationUsages, forEachRepeatedAnnotationUsages, getAnnotationUsage, getAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsage, getDirectAnnotationUsages, getMetaAnnotated, getNamedAnnotationUsage, getNamedAnnotationUsage, getNamedAnnotationUsage, getRepeatedAnnotationUsages, hasAnnotationUsage, hasDirectAnnotationUsage, locateAnnotationUsage, removeAnnotationUsage, replaceAnnotationUsage

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

getKind, isPersistable, resolveAttributeName

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

getAssociatedType, getContainer, getElementType, getMapKeyType, getVisibility, isField, isFinal, isStatic, isSynthetic, resolveRelativeAssociatedType, resolveRelativeClassType

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

applyAnnotationUsage, replaceAnnotationUsage

Constructor Details

DynamicFieldDetails

public DynamicFieldDetails(String name,
 TypeDetails type,
 ClassDetails declaringType,
 int modifierFlags,
 boolean isArray,
 boolean isPlural,
 ModelsContext modelsContext)

Constructs a dynamic FieldDetails.

Parameters:

name - The name of the "field"

type - The type of the "field"

declaringType - The type on which the "field" is declared

modifierFlags - The modifier flags (public, static, etc.) for the "field". Typically, callers should use ModifierUtils.DYNAMIC_ATTRIBUTE_MODIFIERS when defining a field to be used as a persistable member.

isArray - Whether the "field" is an array

isPlural - Whether the "field" is plural

modelsContext - Context for the creation (access to useful information).

Method Details

getName

public String getName()

Description copied from interface: MemberDetails

The name of the member. This would be the name of the method or field.

Specified by:

getName in interface AnnotationTarget

Specified by:

getName in interface MemberDetails

getType

public TypeDetails getType()

Description copied from interface: MemberDetails

The member type. May be null

Specified by:

getType in interface MemberDetails

Returns:

Returns one of:

• for a field, the field type
• for a getter method, the return type
• for a setter method, the argument type
• otherwise, null

getDeclaringType

public ClassDetails getDeclaringType()

Description copied from interface: MemberDetails

The class which declares this member

Specified by:

getDeclaringType in interface MemberDetails

isPlural

public boolean isPlural()

Description copied from interface: MemberDetails

For member's with an associated type, whether that type considered plural.

Specified by:

isPlural in interface MemberDetails

Returns:

true When the member has a type and that type is an array or a Map or Collection inheritor

isArray

public boolean isArray()

Specified by:

isArray in interface MemberDetails

getModifiers

public int getModifiers()

Description copied from interface: MemberDetails

Access to the member modifier flags.

Specified by:

getModifiers in interface MemberDetails

See Also:

• Member.getModifiers()

toJavaMember

public Field toJavaMember()

Description copied from interface: MemberDetails

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

Specified by:

toJavaMember in interface FieldDetails

Specified by:

toJavaMember in interface MemberDetails

Returns:

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

toJavaMember

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

Specified by:

toJavaMember in interface FieldDetails

Specified by:

toJavaMember in interface MemberDetails

resolveRelativeType

public TypeDetails resolveRelativeType(TypeVariableScope container)

Description copied from interface: MemberDetails

Determine the type of the member relative to the given container type.

For example, given

 class Thing<T extends Number> {
     T id;
 }
 class SubThing extends Thing<Integer> {
     ...
 }
 

Accessing the id member relative to Thing simply returns the type variable T. However, asking the id member for its type relative to SubThing will report Integer.

Specified by:

resolveRelativeType in interface MemberDetails

toString

public String toString()

Overrides:

toString in class Object

asFieldDetails

public FieldDetails asFieldDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asFieldDetails in interface AnnotationTarget

Specified by:

asFieldDetails in interface AnnotationTargetSupport

Specified by:

asFieldDetails in interface FieldDetails

asMemberDetails

public MutableMemberDetails asMemberDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asMemberDetails in interface AnnotationTarget

Specified by:

asMemberDetails in interface AnnotationTargetSupport

Specified by:

asMemberDetails in interface MemberDetails

Specified by:

asMemberDetails in interface MutableAnnotationTarget

Specified by:

asMemberDetails in interface MutableMemberDetails

asMethodDetails

public MethodDetails asMethodDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asMethodDetails in interface AnnotationTarget

Specified by:

asMethodDetails in interface AnnotationTargetSupport

Specified by:

asMethodDetails in interface FieldDetails

asRecordComponentDetails

public 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

Specified by:

asRecordComponentDetails in interface AnnotationTargetSupport

Specified by:

asRecordComponentDetails in interface FieldDetails

asClassDetails

public MutableClassDetails asClassDetails()

Description copied from interface: AnnotationTarget

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

Specified by:

asClassDetails in interface AnnotationTarget

Specified by:

asClassDetails in interface AnnotationTargetSupport

Specified by:

asClassDetails in interface MemberDetails

Specified by:

asClassDetails in interface MutableAnnotationTarget

Specified by:

asClassDetails in interface MutableMemberDetails

asAnnotationDescriptor

public <A extends Annotation>
AnnotationDescriptor<A> asAnnotationDescriptor()

Description copied from interface: AnnotationTarget

Safe cast method for cases when the target is an annotation.

Specified by:

asAnnotationDescriptor in interface AnnotationTarget

Specified by:

asAnnotationDescriptor in interface AnnotationTargetSupport

Specified by:

asAnnotationDescriptor in interface MemberDetails

Specified by:

asAnnotationDescriptor in interface MutableMemberDetails