Top Description Inners Methods
jakarta.enterprise.lang.model.declarations

public Interface DeclarationInfo

extends AnnotationTarget
Known Direct Subinterfaces
jakarta.enterprise.lang.model.declarations.FieldInfo, jakarta.enterprise.lang.model.declarations.MethodInfo, jakarta.enterprise.lang.model.declarations.PackageInfo, jakarta.enterprise.lang.model.declarations.ParameterInfo, jakarta.enterprise.lang.model.declarations.RecordComponentInfo, jakarta.enterprise.lang.model.declarations.ClassInfo
Imports
jakarta.enterprise.lang.model.AnnotationTarget, jakarta.enterprise.lang.model.types.Type

A declaration is an element of a program source code. Declarations are:
Since
4.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Method Summary

Modifier and TypeMethod and Description
public default ClassInfo

Returns:

this class, never null
asClass
()

Returns this declaration as a class.

public default DeclarationInfo
public default FieldInfo

Returns:

this field, never null
asField
()

Returns this declaration as a field.

public default MethodInfo

Returns:

this method, never null
asMethod
()

Returns this declaration as a method.

public default PackageInfo

Returns:

this package, never null
asPackage
()

Returns this declaration as a package.

public default ParameterInfo

Returns:

this parameter, never null
asParameter
()

Returns this declaration as a method parameter.

public default RecordComponentInfo

Returns:

this record component, never null
asRecordComponent
()

Returns this declaration as a record component.

public default Type
asType()

Implements jakarta.enterprise.lang.model.AnnotationTarget.asType.

Returns this annotation target as a type.
public default boolean

Returns:

true if this is a class, false otherwise
isClass
()

Returns whether this declaration is a class.

public default boolean
isDeclaration()

Implements jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration.

Returns whether this annotation target is a declaration.
public default boolean

Returns:

true if this is a field, false otherwise
isField
()

Returns whether this declaration is a field.

public default boolean

Returns:

true if this is a method, false otherwise
isMethod
()

Returns whether this declaration is a method.

public default boolean

Returns:

true if this is a package, false otherwise
isPackage
()

Returns whether this declaration is a package.

public default boolean

Returns:

true if this is a parameter, false otherwise
isParameter
()

Returns whether this declaration is a method parameter.

public default boolean

Returns:

true if this is a record component, false otherwise
isRecordComponent
()

Returns whether this declaration is a record component.

public default boolean
isType()

Implements jakarta.enterprise.lang.model.AnnotationTarget.isType.

Returns whether this annotation target is a type.
public DeclarationInfo.Kind

Returns:

the kind of this declaration
kind
()

Returns the kind of this declaration.

Inherited from jakarta.enterprise.lang.model.AnnotationTarget:
annotationannotationsannotationshasAnnotationhasAnnotationrepeatableAnnotation

Method Detail

asClassback to summary
public default ClassInfo asClass()

Returns this declaration as a class.

Returns:ClassInfo

this class, never null

Exceptions
IllegalStateException:
if isClass() returns false
asDeclarationback to summary
public default DeclarationInfo asDeclaration()

Implements jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.asDeclaration.

Returns this annotation target as a declaration.

Returns:DeclarationInfo

this declaration, never null

Annotations
@Override
asFieldback to summary
public default FieldInfo asField()

Returns this declaration as a field.

Returns:FieldInfo

this field, never null

Exceptions
IllegalStateException:
if isField() returns false
asMethodback to summary
public default MethodInfo asMethod()

Returns this declaration as a method.

Returns:MethodInfo

this method, never null

Exceptions
IllegalStateException:
if isMethod() returns false
asPackageback to summary
public default PackageInfo asPackage()

Returns this declaration as a package.

Returns:PackageInfo

this package, never null

Exceptions
IllegalStateException:
if isPackage() returns false
asParameterback to summary
public default ParameterInfo asParameter()

Returns this declaration as a method parameter.

Returns:ParameterInfo

this parameter, never null

Exceptions
IllegalStateException:
if isParameter() returns false
asRecordComponentback to summary
public default RecordComponentInfo asRecordComponent()

Returns this declaration as a record component.

Returns:RecordComponentInfo

this record component, never null

Exceptions
IllegalStateException:
if isRecordComponent() returns false
asTypeback to summary
public default Type asType()

Implements jakarta.enterprise.lang.model.AnnotationTarget.asType.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.asType.

Returns this annotation target as a type.

Returns:Type

this type, never null

Annotations
@Override
isClassback to summary
public default boolean isClass()

Returns whether this declaration is a class.

Returns:boolean

true if this is a class, false otherwise

isDeclarationback to summary
public default boolean isDeclaration()

Implements jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.isDeclaration.

Returns whether this annotation target is a declaration.

Returns:boolean

true if this is a declaration, false otherwise

Annotations
@Override
isFieldback to summary
public default boolean isField()

Returns whether this declaration is a field.

Returns:boolean

true if this is a field, false otherwise

isMethodback to summary
public default boolean isMethod()

Returns whether this declaration is a method.

Returns:boolean

true if this is a method, false otherwise

isPackageback to summary
public default boolean isPackage()

Returns whether this declaration is a package.

Returns:boolean

true if this is a package, false otherwise

isParameterback to summary
public default boolean isParameter()

Returns whether this declaration is a method parameter.

Returns:boolean

true if this is a parameter, false otherwise

isRecordComponentback to summary
public default boolean isRecordComponent()

Returns whether this declaration is a record component.

Returns:boolean

true if this is a record component, false otherwise

isTypeback to summary
public default boolean isType()

Implements jakarta.enterprise.lang.model.AnnotationTarget.isType.

Doc from jakarta.enterprise.lang.model.AnnotationTarget.isType.

Returns whether this annotation target is a type.

Returns:boolean

true if this is a type, false otherwise

Annotations
@Override
kindback to summary
public DeclarationInfo.Kind kind()

Returns the kind of this declaration.

Returns:DeclarationInfo.Kind

the kind of this declaration

jakarta.enterprise.lang.model.declarations back to summary

public final Enum DeclarationInfo.Kind

extends Enum<DeclarationInfo.Kind>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final DeclarationInfo.Kind
public static final DeclarationInfo.Kind
public static final DeclarationInfo.Kind
public static final DeclarationInfo.Kind
public static final DeclarationInfo.Kind
public static final DeclarationInfo.Kind

Constructor Summary

AccessConstructor and Description
private
Kind()

Method Summary

Modifier and TypeMethod and Description
public static DeclarationInfo.Kind
public static DeclarationInfo.Kind[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLASSback to summary
public static final DeclarationInfo.Kind CLASS
FIELDback to summary
public static final DeclarationInfo.Kind FIELD
METHODback to summary
public static final DeclarationInfo.Kind METHOD
PACKAGEback to summary
public static final DeclarationInfo.Kind PACKAGE
PARAMETERback to summary
public static final DeclarationInfo.Kind PARAMETER
RECORD_COMPONENTback to summary
public static final DeclarationInfo.Kind RECORD_COMPONENT

Constructor Detail

Kindback to summary
private Kind()

Method Detail

valueOfback to summary
public static DeclarationInfo.Kind valueOf(String name)
valuesback to summary
public static DeclarationInfo.Kind[] values()