Package io.micronaut.inject.ast

Interface FieldElement

All Superinterfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Element, MemberElement, MutableAnnotationMetadataDelegate<Element>, Named, TypedElement

All Known Subinterfaces:

BeanFieldElement, EnumConstantElement

All Known Implementing Classes:

GroovyEnumConstantElement, GroovyFieldElement

public interface FieldElement
extends TypedElement, MemberElement

Stores data about an element that references a field.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Fields inherited from interface io.micronaut.inject.ast.Element

EMPTY_ELEMENT_ARRAY

Fields inherited from interface io.micronaut.inject.ast.annotation.MutableAnnotationMetadataDelegate

EMPTY

Method Summary

Modifier and Type	Method	Description
default @NonNull String	getDescription(boolean simple)	Allows returning a more simple description if requested.
default ClassElement	getGenericField()	Obtain the generic type with the associated annotation metadata for the field.
default boolean	hides(@NonNull MemberElement memberElement)	Checks if this member element hides another.
default FieldElement	withAnnotationMetadata(AnnotationMetadata annotationMetadata)	Copies this element and overrides its annotations.

Methods inherited from interface io.micronaut.core.annotation.AnnotatedElement

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata

enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasEvaluatedExpressions, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataDelegate

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, copyAnnotationMetadata, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, getTargetAnnotationMetadata, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasPropertyExpressions, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isRepeatableAnnotation, isRepeatableAnnotation, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, stringValues, stringValues, synthesize, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

getAnnotationMetadata

Methods inherited from interface io.micronaut.inject.ast.Element

annotate, annotate, annotate, annotate, annotate, getDescription, getDocumentation, getName, getNativeType, getSimpleName, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isSynthetic, removeAnnotation, removeAnnotation, removeAnnotationIf, removeStereotype, removeStereotype

Methods inherited from interface io.micronaut.inject.ast.MemberElement

getDeclaringType, getModifiers, getOwningType, isAccessible, isAccessible, isAccessible, isReflectionRequired, isReflectionRequired

Methods inherited from interface io.micronaut.inject.ast.TypedElement

getArrayDimensions, getGenericType, getType, isArray, isPrimitive, isVoid

Method Details

getGenericField

default ClassElement getGenericField()

Obtain the generic type with the associated annotation metadata for the field.

Returns:

The generic field

getDescription

@NonNull
default @NonNull String getDescription(boolean simple)

Description copied from interface: Described

Allows returning a more simple description if requested.

Specified by:

getDescription in interface Described

Specified by:

getDescription in interface Element

Parameters:

simple - True if a simple description is required

Returns:

The simple description

withAnnotationMetadata

default FieldElement withAnnotationMetadata(AnnotationMetadata annotationMetadata)

Description copied from interface: Element

Copies this element and overrides its annotations.

Specified by:

withAnnotationMetadata in interface Element

Specified by:

withAnnotationMetadata in interface MemberElement

Parameters:

annotationMetadata - The annotation metadata

Returns:

A new element

hides

default boolean hides(@NonNull
 @NonNull MemberElement memberElement)

Description copied from interface: MemberElement

Checks if this member element hides another.

Specified by:

hides in interface MemberElement

Parameters:

memberElement - The possibly hidden element

Returns:

true if this member element hides passed field element