FieldInfo

java.lang.Object
- io.github.classgraph.FieldInfo

All Implemented Interfaces:

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

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Class<?> classRef
The class ref, once the class is loaded.

protected ScanResult scanResult
The scan result.

Fields
Modifier and Type	Field and Description
`protected java.lang.Class<?>`	`classRef` The class ref, once the class is loaded.
`protected ScanResult`	`scanResult` The scan result.

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(java.lang.Object obj)` Use class name and field name for equals().
`protected void`	`findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log)` Get `ClassInfo` objects for any classes referenced in the type descriptor or type signature.
`AnnotationInfoList`	`getAnnotationInfo()` Get a list of annotations on this field, along with any annotation parameter values, wrapped in `AnnotationInfo` objects.
`AnnotationInfo`	`getAnnotationInfo(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Get a the non-`Repeatable` annotation on this field, or null if the field does not have the annotation.
`AnnotationInfo`	`getAnnotationInfo(java.lang.String annotationName)` Get a the named non-`Repeatable` annotation on this field, or null if the field does not have the named annotation.
`AnnotationInfoList`	`getAnnotationInfoRepeatable(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Get a the `Repeatable` annotation on this field, or the empty list if the field does not have the annotation.
`AnnotationInfoList`	`getAnnotationInfoRepeatable(java.lang.String annotationName)` Get a the named `Repeatable` annotation on this field, or the empty list if the field does not have the named annotation.
`ClassInfo`	`getClassInfo()` Get the `ClassInfo` object for the class that declares this field.
`java.lang.String`	`getClassName()` Get the name of the class that declares this field.
`java.lang.Object`	`getConstantInitializerValue()` Returns the constant initializer value of a field.
`int`	`getModifiers()` Returns the modifier bits for the field.
`java.lang.String`	`getModifiersStr()` Get the field modifiers as a string, e.g.
`java.lang.String`	`getModifierStr()` Deprecated. Use `getModifiersStr()` instead.
`java.lang.String`	`getName()` Get the name of the field.
`TypeSignature`	`getTypeDescriptor()` Returns the parsed type descriptor for the field, which will not include type parameters.
`java.lang.String`	`getTypeDescriptorStr()` Returns the type descriptor string for the field, which will not include type parameters.
`TypeSignature`	`getTypeSignature()` Returns the parsed type signature for the field, possibly including type parameters.
`TypeSignature`	`getTypeSignatureOrTypeDescriptor()` Returns the type signature for the field, possibly including type parameters.
`java.lang.String`	`getTypeSignatureOrTypeDescriptorStr()` Returns the type signature string for the field, possibly including type parameters.
`java.lang.String`	`getTypeSignatureStr()` Returns the type signature string for the field, possibly including type parameters.
`boolean`	`hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)` Check if the field has a given annotation.
`boolean`	`hasAnnotation(java.lang.String annotationName)` Check if the field has a given named annotation.
`int`	`hashCode()` Use hash code of class name and field name.
`boolean`	`isEnum()` Returns true if this field is an enum constant.
`boolean`	`isFinal()` Returns true if this field is final.
`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`	`isSynthetic()` Returns true if this field is synthetic.
`boolean`	`isTransient()` Returns true if this field is a transient field.
`java.lang.reflect.Field`	`loadClassAndGetField()` Load the class this field is associated with, and get the `Field` reference for this field.
`java.lang.String`	`toString()` Render to string.
`protected void`	`toString(boolean useSimpleNames, java.lang.StringBuilder buf)` Render to string.
`java.lang.String`	`toStringWithSimpleNames()` Render to string, using only simple names for classes.

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

- Field Detail
  - scanResult
```
protected transient ScanResult scanResult
```
    The scan result.
  - classRef
```
protected transient java.lang.Class<?> classRef
```
    The class ref, once the class is loaded.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Get the name of the field.
    
    Specified by:
    
    getName in interface HasName
    
    Returns:
    
    The name of the field.
  - getClassInfo
```
public ClassInfo getClassInfo()
```
    Get the ClassInfo object for the class that declares this field.
    
    Returns:
    
    The ClassInfo object for the declaring class.
    
    See Also:
    
    getClassName()
  - getModifierStr
```
@Deprecated
public java.lang.String getModifierStr()
```
    Deprecated. Use getModifiersStr() instead.
    
    Deprecated -- use getModifiersStr() instead.
    
    Returns:
    
    The field modifiers, as a string.
  - getModifiersStr
```
public java.lang.String getModifiersStr()
```
    Get the field modifiers as a string, e.g. "public static final". For the modifier bits, call getModifiers().
    
    Returns:
    
    The field modifiers, as a string.
  - isPublic
```
public boolean isPublic()
```
    Returns true if this field is public.
    
    Returns:
    
    True if the field is public.
  - isPrivate
```
public boolean isPrivate()
```
    Returns true if this field is private.
    
    Returns:
    
    True if the field is private.
  - isProtected
```
public boolean isProtected()
```
    Returns true if this field is protected.
    
    Returns:
    
    True if the field is protected.
  - isStatic
```
public boolean isStatic()
```
    Returns true if this field is static.
    
    Returns:
    
    True if the field is static.
  - isFinal
```
public boolean isFinal()
```
    Returns true if this field is final.
    
    Returns:
    
    True if the field is final.
  - isTransient
```
public boolean isTransient()
```
    Returns true if this field is a transient field.
    
    Returns:
    
    True if the field is transient.
  - isSynthetic
```
public boolean isSynthetic()
```
    Returns true if this field is synthetic.
    
    Returns:
    
    True if the field is synthetic.
  - isEnum
```
public boolean isEnum()
```
    Returns true if this field is an enum constant.
    
    Returns:
    
    True if the field is an enum constant.
  - getModifiers
```
public int getModifiers()
```
    Returns the modifier bits for the field.
    
    Returns:
    
    The modifier bits.
  - getTypeDescriptor
```
public TypeSignature getTypeDescriptor()
```
    Returns the parsed type descriptor for the field, which will not include type parameters. If you need generic type parameters, call getTypeSignature() instead.
    
    Returns:
    
    The parsed type descriptor string for the field.
  - getTypeDescriptorStr
```
public java.lang.String getTypeDescriptorStr()
```
    Returns the type descriptor string for the field, which will not include type parameters. If you need generic type parameters, call getTypeSignatureStr() instead.
    
    Returns:
    
    The type descriptor string for the field.
  - getTypeSignature
```
public TypeSignature getTypeSignature()
```
    Returns the parsed type signature for the field, possibly including type parameters. If this returns null, indicating that no type signature information is available for this field, call getTypeDescriptor() instead.
    
    Returns:
    
    The parsed type signature for the field, or null if not available.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the field type signature cannot be parsed (this should only be thrown in the case of classfile corruption, or a compiler bug that causes an invalid type signature to be written to the classfile).
  - getTypeSignatureStr
```
public java.lang.String getTypeSignatureStr()
```
    Returns the type signature string for the field, possibly including type parameters. If this returns null, indicating that no type signature information is available for this field, call getTypeDescriptorStr() instead.
    
    Returns:
    
    The type signature string for the field, or null if not available.
  - getTypeSignatureOrTypeDescriptor
```
public TypeSignature getTypeSignatureOrTypeDescriptor()
```
    Returns the type signature for the field, possibly including type parameters. If the type signature is null, indicating that no type signature information is available for this field, returns the type descriptor instead.
    
    Returns:
    
    The parsed type signature for the field, or if not available, the parsed type descriptor for the field.
  - getTypeSignatureOrTypeDescriptorStr
```
public java.lang.String getTypeSignatureOrTypeDescriptorStr()
```
    Returns the type signature string for the field, possibly including type parameters. If the type signature string is null, indicating that no type signature information is available for this field, returns the type descriptor string instead.
    
    Returns:
    
    The type signature string for the field, or if not available, the type descriptor string for the method.
  - getConstantInitializerValue
```
public java.lang.Object getConstantInitializerValue()
```
    Returns the constant initializer value of a field. Requires ClassGraph.enableStaticFinalFieldConstantInitializerValues() to have been called. Will only return non-null for fields that have constant initializers, which is usually only fields of primitive type, or String constants. Also note that it is up to the compiler as to whether or not a constant-valued field is assigned as a constant in the field definition itself, or whether it is assigned manually in static or non-static class initializer blocks or the constructor -- so your mileage may vary in being able to extract constant initializer values.
    
    Returns:
    
    The initializer value, if this field has a constant initializer value, or null if none.
  - getAnnotationInfo
```
public AnnotationInfoList getAnnotationInfo()
```
    Get a list of annotations on this field, along with any annotation parameter values, wrapped in AnnotationInfo objects.
    
    Returns:
    
    A list of annotations on this field, along with any annotation parameter values, wrapped in AnnotationInfo objects, or the empty list if none.
  - getAnnotationInfo
```
public AnnotationInfo getAnnotationInfo(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Get a the non-Repeatable annotation on this field, or null if the field does not have the annotation. (Use getAnnotationInfoRepeatable(Class) for Repeatable annotations.)
    
    Parameters:
    
    annotation - The annotation.
    
    Returns:
    
    An AnnotationInfo object representing the annotation on this field, or null if the field does not have the annotation.
  - getAnnotationInfo
```
public AnnotationInfo getAnnotationInfo(java.lang.String annotationName)
```
    Get a the named non-Repeatable annotation on this field, or null if the field does not have the named annotation. (Use getAnnotationInfoRepeatable(String) for Repeatable annotations.)
    
    Parameters:
    
    annotationName - The annotation name.
    
    Returns:
    
    An AnnotationInfo object representing the named annotation on this field, or null if the field does not have the named annotation.
  - getAnnotationInfoRepeatable
```
public AnnotationInfoList getAnnotationInfoRepeatable(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Get a the Repeatable annotation on this field, or the empty list if the field does not have the annotation.
    
    Parameters:
    
    annotation - The annotation.
    
    Returns:
    
    An AnnotationInfoList of all instances of the annotation on this field, or the empty list if the field does not have the annotation.
  - getAnnotationInfoRepeatable
```
public AnnotationInfoList getAnnotationInfoRepeatable(java.lang.String annotationName)
```
    Get a the named Repeatable annotation on this field, or the empty list if the field does not have the named annotation.
    
    Parameters:
    
    annotationName - The annotation name.
    
    Returns:
    
    An AnnotationInfoList of all instances of the named annotation on this field, or the empty list if the field does not have the named annotation.
  - hasAnnotation
```
public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)
```
    Check if the field has a given annotation.
    
    Parameters:
    
    annotation - The annotation.
    
    Returns:
    
    true if this field has the annotation.
  - hasAnnotation
```
public boolean hasAnnotation(java.lang.String annotationName)
```
    Check if the field has a given named annotation.
    
    Parameters:
    
    annotationName - The name of an annotation.
    
    Returns:
    
    true if this field has the named annotation.
  - loadClassAndGetField
```
public java.lang.reflect.Field loadClassAndGetField()
                                             throws java.lang.IllegalArgumentException
```
    Load the class this field is associated with, and get the Field reference for this field.
    
    Returns:
    
    The Field reference for this field.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the field does not exist.
  - getClassName
```
public java.lang.String getClassName()
```
    Get the name of the class that declares this field.
    
    Returns:
    
    The name of the declaring class.
    
    See Also:
    
    getClassInfo()
  - findReferencedClassInfo
```
protected void findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo,
                                       java.util.Set<ClassInfo> refdClassInfo,
                                       LogNode log)
```
    Get ClassInfo objects for any classes referenced in the type descriptor or type signature.
    
    Parameters:
    
    classNameToClassInfo - the map from class name to ClassInfo.
    
    refdClassInfo - the referenced class info
    
    log - the log
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Use class name and field name for equals().
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the object to compare to
    
    Returns:
    
    true if equal
  - hashCode
```
public int hashCode()
```
    Use hash code of class name and field name.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hashcode
  - compareTo
```
public int compareTo(FieldInfo other)
```
    Sort in order of class name then field name.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<FieldInfo>
    
    Parameters:
    
    other - the other FieldInfo object to compare to.
    
    Returns:
    
    the result of comparison.
  - toString
```
protected void toString(boolean useSimpleNames,
                        java.lang.StringBuilder buf)
```
    Render to string.
    
    Parameters:
    
    useSimpleNames - if true, use just the simple name of each class.
    
    buf - the buf
  - toStringWithSimpleNames
```
public java.lang.String toStringWithSimpleNames()
```
    Render to string, using only simple names for classes.
    
    Returns:
    
    the string representation, using simple names for classes.
  - toString
```
public java.lang.String toString()
```
    Render to string.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation.

Class FieldInfo

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

scanResult

classRef

Method Detail

getName

getClassInfo

getModifierStr

getModifiersStr

isPublic

isPrivate

isProtected

isStatic

isFinal

isTransient

isSynthetic

isEnum

getModifiers

getTypeDescriptor

getTypeDescriptorStr

getTypeSignature

getTypeSignatureStr

getTypeSignatureOrTypeDescriptor

getTypeSignatureOrTypeDescriptorStr

getConstantInitializerValue

getAnnotationInfo

getAnnotationInfo

getAnnotationInfo

getAnnotationInfoRepeatable

getAnnotationInfoRepeatable

hasAnnotation

hasAnnotation

loadClassAndGetField

getClassName

findReferencedClassInfo

equals

hashCode

compareTo

toString

toStringWithSimpleNames

toString