io.github.classgraph

Class FieldInfo

java.lang.Object

io.github.classgraph.ClassMemberInfo

io.github.classgraph.FieldInfo

All Implemented Interfaces:

HasName, Comparable<FieldInfo>

public class FieldInfo
extends ClassMemberInfo
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.

Method Summary

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().
Object	getConstantInitializerValue() Returns the constant initializer value of a field.
String	getModifiersStr() Get the field modifiers as a string, e.g.
String	getModifierStr() Deprecated. Use getModifiersStr() instead.
TypeSignature	getTypeDescriptor() Returns the parsed type descriptor 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.
int	hashCode() Use hash code of class name and field name.
boolean	isEnum() Returns true if this field is an enum constant.
boolean	isTransient() Returns true if this field is a transient field.
Field	loadClassAndGetField() Load the class this field is associated with, and get the Field reference for this field.
String	toString() Render to string.
String	toStringWithSimpleNames() Render to string, using only simple names for classes.

Methods inherited from class io.github.classgraph.ClassMemberInfo

getAnnotationInfo, getAnnotationInfo, getAnnotationInfo, getAnnotationInfoRepeatable, getAnnotationInfoRepeatable, getClassInfo, getClassName, getModifiers, getName, getTypeDescriptorStr, getTypeSignatureOrTypeDescriptorStr, getTypeSignatureStr, hasAnnotation, hasAnnotation, isFinal, isPrivate, isProtected, isPublic, isStatic, isSynthetic

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getModifierStr

@Deprecated
public String getModifierStr()

Deprecated. Use getModifiersStr() instead.

Deprecated -- use getModifiersStr() instead.

Returns:

The field modifiers, as a string.

getModifiersStr

public String getModifiersStr()

Get the field modifiers as a string, e.g. "public static final". For the modifier bits, call getModifiers().

Specified by:

getModifiersStr in class ClassMemberInfo

Returns:

The field modifiers, as a string.

isTransient

public boolean isTransient()

Returns true if this field is a transient field.

Returns:

True if the field is transient.

isEnum

public boolean isEnum()

Returns true if this field is an enum constant.

Returns:

True if the field is an enum constant.

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.

Specified by:

getTypeDescriptor in class ClassMemberInfo

Returns:

The parsed 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.

Specified by:

getTypeSignature in class ClassMemberInfo

Returns:

The parsed type signature for the field, or null if not available.

Throws:

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).

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.

Specified by:

getTypeSignatureOrTypeDescriptor in class ClassMemberInfo

Returns:

The parsed type signature for the field, or if not available, the parsed type descriptor for the field.

getConstantInitializerValue

public 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.

loadClassAndGetField

public Field loadClassAndGetField()
                           throws 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:

IllegalArgumentException - if the field does not exist.

equals

public boolean equals(Object obj)

Use class name and field name for equals().

Overrides:

equals in class 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 Object

Returns:

the hashcode

compareTo

public int compareTo(FieldInfo other)

Sort in order of class name then field name.

Specified by:

compareTo in interface Comparable<FieldInfo>

Parameters:

other - the other FieldInfo object to compare to.

Returns:

the result of comparison.

toStringWithSimpleNames

public String toStringWithSimpleNames()

Render to string, using only simple names for classes.

Returns:

the string representation, using simple names for classes.

toString

public String toString()

Render to string.

Overrides:

toString in class Object

Returns:

the string representation.