Package org.jboss.jandex
Class FieldInfo
- java.lang.Object
-
- org.jboss.jandex.FieldInfo
-
- All Implemented Interfaces:
AnnotationTarget
public final class FieldInfo extends Object implements AnnotationTarget
Represents a field.Thread-Safety
This class is immutable and can be shared between threads without safe publication.- Author:
- Jason T. Greene
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTarget
AnnotationTarget.Kind
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AnnotationInstance
annotation(DotName name)
Retrieves an annotation instance declared on this field.List<AnnotationInstance>
annotations()
Returns the list of annotation instances declared on this field.List<AnnotationInstance>
annotationsWithRepeatable(DotName name, IndexView index)
Retrieves annotation instances declared on this field, by the name of the annotation.ClassInfo
asClass()
Casts and returns this target as aClassInfo
if it is of kindCLASS
FieldInfo
asField()
Casts and returns this target as aFieldInfo
if it is of kindFIELD
MethodInfo
asMethod()
Casts and returns this target as aMethodInfo
if it is of kindMETHOD
MethodParameterInfo
asMethodParameter()
Casts and returns this target as aMethodParameterInfo
if it is of kindMETHOD_PARAMETER
RecordComponentInfo
asRecordComponent()
Casts and returns this target as aRecordComponentInfo
if it is of kindRECORD_COMPONENT
TypeTarget
asType()
Casts and returns this target as aTypeTarget
if it is of kindTYPE
static FieldInfo
create(ClassInfo clazz, String name, Type type, short flags)
Construct a new mock Field instance.ClassInfo
declaringClass()
Returns the class which declared the fieldboolean
equals(Object o)
short
flags()
Returns the access fields of this field.boolean
hasAnnotation(DotName name)
Returns whether or not the annotation instance with the given name occurs on this fieldint
hashCode()
boolean
isEnumConstant()
Returns whether or not this field is declared as an element of an enum.boolean
isSynthetic()
AnnotationTarget.Kind
kind()
Returns the kind of object this target represents.String
name()
Returns the local name of the fieldString
toString()
Returns a string representation describing this field.Type
type()
Returns theType
declared on this field.
-
-
-
Method Detail
-
create
public static FieldInfo create(ClassInfo clazz, String name, Type type, short flags)
Construct a new mock Field instance.- Parameters:
clazz
- the class declaring the fieldname
- the name of the fieldtype
- the Java field typeflags
- the field attributes- Returns:
- a mock field
-
name
public final String name()
Returns the local name of the field- Returns:
- the local name of the field
-
declaringClass
public final ClassInfo declaringClass()
Returns the class which declared the field- Returns:
- the declaring class
-
type
public final Type type()
Returns theType
declared on this field. This may be an array, a primitive, or a generic type definition.- Returns:
- the type of this field
-
kind
public final AnnotationTarget.Kind kind()
Description copied from interface:AnnotationTarget
Returns the kind of object this target represents.- Specified by:
kind
in interfaceAnnotationTarget
- Returns:
- the target kind.
-
annotations
public List<AnnotationInstance> annotations()
Returns the list of annotation instances declared on this field. It may be empty, but never null.- Returns:
- the list of annotations on this field
-
annotation
public final AnnotationInstance annotation(DotName name)
Retrieves an annotation instance declared on this field. If an annotation by that name is not present, null will be returned.- Parameters:
name
- the name of the annotation to locate on this field- Returns:
- the annotation if found, otherwise, null
-
annotationsWithRepeatable
public final List<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index)
Retrieves annotation instances declared on this field, by the name of the annotation. If the specified annotation is repeatable (JLS 9.6), the result also contains all values from the container annotation instance.- Parameters:
name
- the name of the annotationindex
- the index used to obtain the annotation class- Returns:
- the annotation instances declared on this field, or an empty list if none
- Throws:
IllegalArgumentException
- If the index does not contain the annotation definition or if it does not represent an annotation type
-
hasAnnotation
public final boolean hasAnnotation(DotName name)
Returns whether or not the annotation instance with the given name occurs on this field- Parameters:
name
- the name of the annotation to look for- Returns:
- true if the annotation is present, false otherwise
- See Also:
annotations()
,annotation(DotName)
-
isEnumConstant
public boolean isEnumConstant()
Returns whether or not this field is declared as an element of an enum.- Returns:
- true if the field is declared as an element of an enum, false otherwise.
- See Also:
Field.isEnumConstant()
-
flags
public final short flags()
Returns the access fields of this field.Modifier
can be used on this value.- Returns:
- the access flags of this field
-
isSynthetic
public final boolean isSynthetic()
- Returns:
true
if this field is a synthetic field
-
toString
public String toString()
Returns a string representation describing this field. It is similar although not necessarily equivalent to a Java source code expression representing this field.
-
asClass
public final ClassInfo asClass()
Description copied from interface:AnnotationTarget
Casts and returns this target as aClassInfo
if it is of kindCLASS
- Specified by:
asClass
in interfaceAnnotationTarget
- Returns:
- this instance cast to a class
-
asField
public final FieldInfo asField()
Description copied from interface:AnnotationTarget
Casts and returns this target as aFieldInfo
if it is of kindFIELD
- Specified by:
asField
in interfaceAnnotationTarget
- Returns:
- this instance cast to a field
-
asMethod
public final MethodInfo asMethod()
Description copied from interface:AnnotationTarget
Casts and returns this target as aMethodInfo
if it is of kindMETHOD
- Specified by:
asMethod
in interfaceAnnotationTarget
- Returns:
- this instance cast to a method
-
asMethodParameter
public final MethodParameterInfo asMethodParameter()
Description copied from interface:AnnotationTarget
Casts and returns this target as aMethodParameterInfo
if it is of kindMETHOD_PARAMETER
- Specified by:
asMethodParameter
in interfaceAnnotationTarget
- Returns:
- this instance cast to a method parameter
-
asType
public final TypeTarget asType()
Description copied from interface:AnnotationTarget
Casts and returns this target as aTypeTarget
if it is of kindTYPE
- Specified by:
asType
in interfaceAnnotationTarget
- Returns:
- this instance cast to a type target
-
asRecordComponent
public RecordComponentInfo asRecordComponent()
Description copied from interface:AnnotationTarget
Casts and returns this target as aRecordComponentInfo
if it is of kindRECORD_COMPONENT
- Specified by:
asRecordComponent
in interfaceAnnotationTarget
- Returns:
- this instance cast to a record component
-
-