FieldInfo (Jandex: Core 3.0.1 API)

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 and Description
`AnnotationInstance`	`annotation(DotName name)` Returns the annotation instance with given name declared on this field or any type within its signature.
`List<AnnotationInstance>`	`annotations()` Returns the annotation instances declared on this field or any type within its signature.
`List<AnnotationInstance>`	`annotations(DotName name)` Returns the annotation instances with given name declared on this field or any type within its signature.
`List<AnnotationInstance>`	`annotationsWithRepeatable(DotName name, IndexView index)` Returns the annotation instances with given name declared on this field or any type within its signature.
`ClassInfo`	`asClass()` Casts and returns this target as a `ClassInfo` if it is of kind `CLASS`
`FieldInfo`	`asField()` Casts and returns this target as a `FieldInfo` if it is of kind `FIELD`
`MethodInfo`	`asMethod()` Casts and returns this target as a `MethodInfo` if it is of kind `METHOD`
`MethodParameterInfo`	`asMethodParameter()` Casts and returns this target as a `MethodParameterInfo` if it is of kind `METHOD_PARAMETER`
`RecordComponentInfo`	`asRecordComponent()` Casts and returns this target as a `RecordComponentInfo` if it is of kind `RECORD_COMPONENT`
`TypeTarget`	`asType()` Casts and returns this target as a `TypeTarget` if it is of kind `TYPE`
`static FieldInfo`	`create(ClassInfo clazz, String name, Type type, short flags)` Construct a new mock Field instance.
`AnnotationInstance`	`declaredAnnotation(DotName name)` Returns the annotation instance with given name declared on this field.
`List<AnnotationInstance>`	`declaredAnnotations()` Returns the annotation instances declared on this field.
`List<AnnotationInstance>`	`declaredAnnotationsWithRepeatable(DotName name, IndexView index)` Returns the annotation instances with given name declared on this field.
`ClassInfo`	`declaringClass()` Returns the class which declared the field
`int`	`enumConstantOrdinal()` Returns an ordinal of this enum constant, that is, the zero-based position in the enum declaration.
`boolean`	`equals(Object o)`
`short`	`flags()` Returns the access fields of this field.
`boolean`	`hasAnnotation(DotName name)` Returns whether an annotation instance with given name is declared on this field or any type within its signature.
`boolean`	`hasDeclaredAnnotation(DotName name)` Returns whether an annotation instance with given name is declared on this field.
`int`	`hashCode()`
`boolean`	`isEnumConstant()` Returns whether 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 field
`String`	`toString()` Returns a string representation describing this field.
`Type`	`type()` Returns the `Type` declared on this field.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.jandex.AnnotationTarget
annotation, annotation, annotations, annotations, annotationsWithRepeatable, annotationsWithRepeatable, declaredAnnotation, declaredAnnotation, declaredAnnotationsWithRepeatable, declaredAnnotationsWithRepeatable, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation

- 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 field
    
    name - the name of the field
    
    type - the Java field type
    
    flags - 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 the Type 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 interface AnnotationTarget
    
    Returns:
    
    the target kind.
  - hasAnnotation
```
public final boolean hasAnnotation(DotName name)
```
    Returns whether an annotation instance with given name is declared on this field or any type within its signature.
    
    Specified by:
    
    hasAnnotation in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type to look for, must not be null
    
    Returns:
    
    true if the annotation is present, false otherwise
    
    See Also:
    
    annotation(DotName)
  - annotation
```
public final AnnotationInstance annotation(DotName name)
```
    Returns the annotation instance with given name declared on this field or any type within its signature. The target() method of the returned annotation instance may be used to determine the exact location of the annotation instance.
    The following is a non-exhaustive list of examples of annotations returned by this method:
```
 @MyFieldAnnotation
 public String foo;

 public List<@MyTypeAnnotation String> bar;
 
```
    In case an annotation with given name occurs more than once, the result of this method is not deterministic. For such situations, annotations(DotName) is preferable.
    Specified by:
    
    annotation in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type to look for, must not be null
    
    Returns:
    
    the annotation instance, or null if not found
    
    See Also:
    
    annotations(DotName)
  - annotations
```
public final List<AnnotationInstance> annotations(DotName name)
```
    Returns the annotation instances with given name declared on this field or any type within its signature. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
    The following is a non-exhaustive list of examples of annotations returned by this method:
```
 @MyFieldAnnotation
 public String foo;

 public List<@MyTypeAnnotation String> bar;
 
```
    Specified by:
    
    annotations in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type, must not be null
    
    Returns:
    
    immutable list of annotation instances, never null
    
    See Also:
    
    annotationsWithRepeatable(DotName, IndexView), annotations()
  - annotationsWithRepeatable
```
public final List<AnnotationInstance> annotationsWithRepeatable(DotName name,
                                                                IndexView index)
```
    Returns the annotation instances with given name declared on this field or any type within its signature. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
    If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.
    
    Specified by:
    
    annotationsWithRepeatable in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type, must not be null
    
    index - index used to obtain the annotation type, must not be null
    
    Returns:
    
    immutable list of annotation instances, never null
    
    Throws:
    
    IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
    
    See Also:
    
    annotations(DotName), annotations()
  - annotations
```
public final List<AnnotationInstance> annotations()
```
    Returns the annotation instances declared on this field or any type within its signature. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.
    The following is a non-exhaustive list of examples of annotations returned by this method:
```
 @MyFieldAnnotation
 public String foo;

 public List<@MyTypeAnnotation String> bar;
 
```
    Specified by:
    
    annotations in interface AnnotationTarget
    
    Returns:
    
    collection of annotation instances, never null
  - hasDeclaredAnnotation
```
public final boolean hasDeclaredAnnotation(DotName name)
```
    Returns whether an annotation instance with given name is declared on this field.
    Unlike hasAnnotation(DotName), this method ignores annotations declared on types within the field signature.
    
    Specified by:
    
    hasDeclaredAnnotation in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type to look for, must not be null
    
    Returns:
    
    true if the annotation is present, false otherwise
    
    Since:
    
    3.0
    
    See Also:
    
    hasAnnotation(DotName)
  - declaredAnnotation
```
public final AnnotationInstance declaredAnnotation(DotName name)
```
    Returns the annotation instance with given name declared on this field.
    Unlike annotation(DotName), this method doesn't return annotations declared on types within the field signature.
    
    Specified by:
    
    declaredAnnotation in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type to look for, must not be null
    
    Returns:
    
    the annotation instance, or null if not found
    
    Since:
    
    3.0
    
    See Also:
    
    annotation(DotName)
  - declaredAnnotationsWithRepeatable
```
public final List<AnnotationInstance> declaredAnnotationsWithRepeatable(DotName name,
                                                                        IndexView index)
```
    Returns the annotation instances with given name declared on this field.
    If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance.target() returns the target of the container annotation instance.
    Unlike annotationsWithRepeatable(DotName, IndexView), this method doesn't return annotations declared on types within the field signature.
    
    Specified by:
    
    declaredAnnotationsWithRepeatable in interface AnnotationTarget
    
    Parameters:
    
    name - name of the annotation type, must not be null
    
    index - index used to obtain the annotation type, must not be null
    
    Returns:
    
    list of annotation instances, never null
    
    Throws:
    
    IllegalArgumentException - if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type
    
    Since:
    
    3.0
    
    See Also:
    
    annotationsWithRepeatable(DotName, IndexView)
  - declaredAnnotations
```
public final List<AnnotationInstance> declaredAnnotations()
```
    Returns the annotation instances declared on this field.
    Unlike annotations(), this method doesn't return annotations declared on types within the field signature.
    
    Specified by:
    
    declaredAnnotations in interface AnnotationTarget
    
    Returns:
    
    list of annotation instances, never null
    
    Since:
    
    3.0
    
    See Also:
    
    annotations()
  - isEnumConstant
```
public final boolean isEnumConstant()
```
    Returns whether 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
  - enumConstantOrdinal
```
public int enumConstantOrdinal()
```
    Returns an ordinal of this enum constant, that is, the zero-based position in the enum declaration. This is currently very inefficient (requires traversing fields of the declaring class), but may be improved in the future.
    If this field is not an enum constant, returns -1.
    Note that for the result to actually be the ordinal value, the index must be produced by at least Jandex 2.4. Previous Jandex versions do not store field positions. At most 256 fields may be present in the class; if there's more, outcome is undefined. This also assumes that the bytecode order corresponds to declaration order, which is not guaranteed, but practically always holds.
    
    Returns:
    
    ordinal of this enum constant, or -1 if this field is not an enum constant
    
    Since:
    
    3.0.1
  - toString
```
public String toString()
```
    Returns a string representation describing this field. It is similar although not necessarily identical to a Java source code expression representing this field.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this field
  - asClass
```
public final ClassInfo asClass()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a ClassInfo if it is of kind CLASS
    
    Specified by:
    
    asClass in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a class
  - asField
```
public final FieldInfo asField()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a FieldInfo if it is of kind FIELD
    
    Specified by:
    
    asField in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a field
  - asMethod
```
public final MethodInfo asMethod()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a MethodInfo if it is of kind METHOD
    
    Specified by:
    
    asMethod in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a method
  - asMethodParameter
```
public final MethodParameterInfo asMethodParameter()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER
    
    Specified by:
    
    asMethodParameter in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a method parameter
  - asType
```
public final TypeTarget asType()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a TypeTarget if it is of kind TYPE
    
    Specified by:
    
    asType in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a type target
  - asRecordComponent
```
public final RecordComponentInfo asRecordComponent()
```
    Description copied from interface: AnnotationTarget
    
    Casts and returns this target as a RecordComponentInfo if it is of kind RECORD_COMPONENT
    
    Specified by:
    
    asRecordComponent in interface AnnotationTarget
    
    Returns:
    
    this instance cast to a record component
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object

Class FieldInfo

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTarget

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jboss.jandex.AnnotationTarget

Method Detail

create

name

declaringClass

type

kind

hasAnnotation

annotation

annotations

annotationsWithRepeatable

annotations

hasDeclaredAnnotation

declaredAnnotation

declaredAnnotationsWithRepeatable

declaredAnnotations

isEnumConstant

flags

isSynthetic

enumConstantOrdinal

toString

asClass

asField

asMethod

asMethodParameter

asType

asRecordComponent

hashCode

equals