edu.umd.cs.findbugs.ba

Interface XField

All Superinterfaces:

AccessibleEntity, AnnotatedObject, ClassMember, java.lang.Comparable<ComparableField>, ComparableField, FieldOrMethodName, java.io.Serializable

All Known Implementing Classes:

AbstractField, FieldInfo, UnresolvedXField

public interface XField
extends ClassMember, AnnotatedObject, ComparableField

Abstract representation of a field. Note that this is called "XField" to distinguish it from BCEL's Field class. Also, you can think of the "X" as expanding to "Instance" or "Static".

This interface and its implementations exist because Field objects in BCEL are awkward to deal with. They are not Comparable, it is difficult to find out what class they belong to, etc.

If the resolved() method returns true, then any information queried from this object can be assumed to be accurate. If the resolved() method returns false, then FindBugs can't find the field and any information other than name/signature/etc. cannot be trusted.

Method Summary

Modifier and Type	Method and Description
FieldDescriptor	getFieldDescriptor()
boolean	isEnum()
boolean	isReferenceType() Is the type of the field a reference type?
boolean	isVolatile() Is this a volatile field?

Methods inherited from interface edu.umd.cs.findbugs.ba.ClassMember

getClassName, getName, getPackageName, getSignature, getSourceSignature, isResolved

Methods inherited from interface edu.umd.cs.findbugs.ba.AccessibleEntity

getAccessFlags, getClassDescriptor, isDeprecated, isFinal, isPrivate, isProtected, isPublic, isStatic, isSynthetic

Methods inherited from interface edu.umd.cs.findbugs.classfile.FieldOrMethodName

getClassDescriptor, isStatic

Methods inherited from interface edu.umd.cs.findbugs.classfile.analysis.AnnotatedObject

getAnnotation, getAnnotationDescriptors, getAnnotations, getClassDescriptor, getContainingScope, getElementType, isSynthetic

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

isReferenceType

boolean isReferenceType()

Is the type of the field a reference type?

isVolatile

boolean isVolatile()

Is this a volatile field?

isEnum

boolean isEnum()

Returns:

true if this is a enum constant

getFieldDescriptor

FieldDescriptor getFieldDescriptor()

Returns:

FieldDescriptor referring to this field