FieldInfo (Java Annotation Indexer 2.0.2.Final 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
`List<AnnotationInstance>`	`annotations()` Returns the list of annotation instances declared on this field.
`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`
`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.
`ClassInfo`	`declaringClass()` Returns the class which declared the field
`short`	`flags()` Returns the access fields of this field.
`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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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.
  - 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
  - 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
  - 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation for 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

Class FieldInfo

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

name

declaringClass

type

kind

annotations

flags

toString

asClass

asField

asMethod

asMethodParameter

asType