io.micronaut.inject.ast

Interface Element

All Superinterfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Named

All Known Subinterfaces:

ClassElement, ConstructorElement, EnumElement, FieldElement, MemberElement, MethodElement, ParameterElement, PropertyElement, TypedElement

All Known Implementing Classes:

AbstractGroovyElement, AbstractJavaElement, GroovyClassElement, GroovyConstructorElement, GroovyFieldElement, GroovyMethodElement, GroovyParameterElement, JavaClassElement, JavaPrimitiveElement

public interface Element
extends AnnotationMetadataDelegate, AnnotatedElement

Stores data about a compile time element. The underlying object can be a class, field, or method.

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

Method Summary

Modifier and Type	Method and Description
default <T extends Annotation> Element	annotate(Class<T> annotationType) Annotate this element with the given annotation type.
default <T extends Annotation> Element	annotate(Class<T> annotationType, Consumer<AnnotationValueBuilder<T>> consumer) Annotate this element with the given annotation type.
default <T extends Annotation> Element	annotate(String annotationType) Annotate this element with the given annotation type.
default <T extends Annotation> Element	annotate(String annotationType, Consumer<AnnotationValueBuilder<T>> consumer) Annotate this element with the given annotation type.
default Optional<String>	getDocumentation()
String	getName()
Object	getNativeType() Returns the native underlying type.
default String	getSimpleName() The simple name of the element.
default boolean	isAbstract()
default boolean	isFinal()
default boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
default boolean	isStatic()

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

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

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

hasSimpleAnnotation, hasSimpleDeclaredAnnotation

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

isDeclaredNullable, isNullable

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

getAnnotationMetadata

Method Detail

getName

@Nonnull
String getName()

Specified by:

getName in interface Named

Returns:

The name of the element.

isProtected

boolean isProtected()

Returns:

True if the element is protected.

isPublic

boolean isPublic()

Returns:

True if the element is public.

getNativeType

@Nonnull
Object getNativeType()

Returns the native underlying type. This API is extended by all of the inject language implementations. The object returned by this method will be the language native type the information is being retrieved from.

Returns:

The native type

annotate

@Nonnull
default <T extends Annotation> Element annotate(@Nonnull
                                                         String annotationType,
                                                         @Nonnull
                                                         Consumer<AnnotationValueBuilder<T>> consumer)

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

consumer - A function that receives the AnnotationValueBuilder

Returns:

This element

annotate

@Nonnull
default <T extends Annotation> Element annotate(@Nonnull
                                                         String annotationType)

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

Returns:

This element

annotate

@Nonnull
default <T extends Annotation> Element annotate(@Nonnull
                                                         Class<T> annotationType,
                                                         @Nonnull
                                                         Consumer<AnnotationValueBuilder<T>> consumer)

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

consumer - A function that receives the AnnotationValueBuilder

Returns:

The AnnotationValueBuilder

annotate

@Nonnull
default <T extends Annotation> Element annotate(@Nonnull
                                                         Class<T> annotationType)

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

Returns:

The AnnotationValueBuilder

getSimpleName

@Nonnull
default String getSimpleName()

The simple name of the element. For a class this will be the name without the package.

Returns:

The simple name

isAbstract

default boolean isAbstract()

Returns:

True if the element is abstract.

isStatic

default boolean isStatic()

Returns:

True if the element is static.

getDocumentation

default Optional<String> getDocumentation()

Returns:

The documentation, if any.

isPrivate

default boolean isPrivate()

Returns:

True if the element is private.

isFinal

default boolean isFinal()

Returns:

True if the element is final.