FieldInfo (FastClasspathScanner 2.20.2 API)

java.lang.Object
- io.github.lukehutch.fastclasspathscanner.scanner.FieldInfo

All Implemented Interfaces:

Comparable<FieldInfo>
```
public class FieldInfo
extends Object
implements Comparable<FieldInfo>
```
Holds metadata about fields of a class encountered during a scan. All values are taken directly out of the classfile for the class.

Constructor Summary

Constructors
Constructor and Description
`FieldInfo(String className, String fieldName, int modifiers, String typeDescriptorStr, String typeSignatureStr, Object constValue, List<AnnotationInfo> annotationInfo)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(FieldInfo other)` Sort in order of class name then field name
`boolean`	`equals(Object obj)` Use class name and field name for equals().
`List<AnnotationInfo>`	`getAnnotationInfo()` Get a list of annotations on this field, along with any annotation parameter values, wrapped in AnnotationInfo objects, or the empty list if none.
`List<String>`	`getAnnotationNames()` Returns the names of unique annotations on the field, or the empty list if none.
`List<Class<?>>`	`getAnnotationTypes()` Returns Class references for the unique annotations on this field.
`String`	`getClassName()` Get the name of the class this method is part of.
`Object`	`getConstFinalValue()` Returns the constant final initializer value of the field, or null if none.
`String`	`getFieldName()` Returns the name of the field.
`int`	`getModifiers()` Returns the access flags of the field.
`String`	`getModifierStr()` Get the field modifiers as a string, e.g.
`String`	`getModifierStrs()` Deprecated.
`Class<?>`	`getType()` Returns the Class reference for the field.
`String`	`getTypeDescriptorStr()` Returns the type descriptor string for the field, without type parameters, e.g.
`TypeSignature`	`getTypeSignature()` Returns the type signature for the field.
`String`	`getTypeSignatureStr()` Returns the Java type signature string for the method.
`String`	`getTypeStr()` Returns the type of the field, in string representation (e.g.
`int`	`hashCode()` Use hash code of class name and field name.
`boolean`	`isFinal()` Returns true if this field is final.
`boolean`	`isPackagePrivate()` Returns true if this field is package-private.
`boolean`	`isPrivate()` Returns true if this field is private.
`boolean`	`isProtected()` Returns true if this field is protected.
`boolean`	`isPublic()` Returns true if this field is public.
`boolean`	`isStatic()` Returns true if this field is static.
`boolean`	`isTransient()` Returns true if this field is a transient field.
`String`	`toString()`

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

- Constructor Detail
  - FieldInfo
```
public FieldInfo(String className,
                 String fieldName,
                 int modifiers,
                 String typeDescriptorStr,
                 String typeSignatureStr,
                 Object constValue,
                 List<AnnotationInfo> annotationInfo)
```
- Method Detail
  - getClassName
```
public String getClassName()
```
    Get the name of the class this method is part of.
  - getFieldName
```
public String getFieldName()
```
    Returns the name of the field.
  - getModifierStrs
```
@Deprecated
public String getModifierStrs()
```
    Deprecated.
    
    Deprecated, use getModifierStr() instead.
  - getModifierStr
```
public String getModifierStr()
```
    Get the field modifiers as a string, e.g. "public static final". For the modifier bits, call getAccessFlags().
  - isPublic
```
public boolean isPublic()
```
    Returns true if this field is public.
  - isPrivate
```
public boolean isPrivate()
```
    Returns true if this field is private.
  - isProtected
```
public boolean isProtected()
```
    Returns true if this field is protected.
  - isPackagePrivate
```
public boolean isPackagePrivate()
```
    Returns true if this field is package-private.
  - isStatic
```
public boolean isStatic()
```
    Returns true if this field is static.
  - isFinal
```
public boolean isFinal()
```
    Returns true if this field is final.
  - isTransient
```
public boolean isTransient()
```
    Returns true if this field is a transient field.
  - getModifiers
```
public int getModifiers()
```
    Returns the access flags of the field.
  - getTypeDescriptorStr
```
public String getTypeDescriptorStr()
```
    Returns the type descriptor string for the field, without type parameters, e.g. "Ljava/util/List;".
  - getTypeSignatureStr
```
public String getTypeSignatureStr()
```
    Returns the Java type signature string for the method. This is the programmer-visible type signature, in the sense that type parameters are included if they are available.
  - getTypeSignature
```
public TypeSignature getTypeSignature()
```
    Returns the type signature for the field. Attempts to parse the type signature, or if not present, the type descriptor.
  - getType
```
public Class<?> getType()
                 throws IllegalArgumentException
```
    Returns the Class reference for the field. Note that this calls Class.forName() on the field type, which will cause the class to be loaded, and possibly initialized. If the class is initialized, this can trigger side effects.
    
    Throws:
    
    IllegalArgumentException - if the field type could not be loaded.
  - getTypeStr
```
public String getTypeStr()
```
    Returns the type of the field, in string representation (e.g. "int[][]").
  - getConstFinalValue
```
public Object getConstFinalValue()
```
    Returns the constant final initializer value of the field, or null if none.
  - getAnnotationNames
```
public List<String> getAnnotationNames()
```
    Returns the names of unique annotations on the field, or the empty list if none.
  - getAnnotationTypes
```
public List<Class<?>> getAnnotationTypes()
                                  throws IllegalArgumentException
```
    Returns Class references for the unique annotations on this field. Note that this calls Class.forName() on the annotation types, which will cause each annotation class to be loaded.
    
    Throws:
    
    IllegalArgumentException - if the annotation type could not be loaded.
  - getAnnotationInfo
```
public List<AnnotationInfo> getAnnotationInfo()
```
    Get a list of annotations on this field, along with any annotation parameter values, wrapped in AnnotationInfo objects, or the empty list if none.
  - equals
```
public boolean equals(Object obj)
```
    Use class name and field name for equals().
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Use hash code of class name and field name.
    
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(FieldInfo other)
```
    Sort in order of class name then field name
    
    Specified by:
    
    compareTo in interface Comparable<FieldInfo>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FieldInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldInfo

Method Detail

getClassName

getFieldName

getModifierStrs

getModifierStr

isPublic

isPrivate

isProtected

isPackagePrivate

isStatic

isFinal

isTransient

getModifiers

getTypeDescriptorStr

getTypeSignatureStr

getTypeSignature

getType

getTypeStr

getConstFinalValue

getAnnotationNames

getAnnotationTypes

getAnnotationInfo

equals

hashCode

compareTo

toString