Class UnreadFields

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

edu.umd.cs.findbugs.visitclass.DismantleBytecode

edu.umd.cs.findbugs.BytecodeScanningDetector

edu.umd.cs.findbugs.bcel.OpcodeStackDetector

edu.umd.cs.findbugs.detect.UnreadFields

All Implemented Interfaces:

Detector, Priorities, org.apache.bcel.classfile.Visitor

public class UnreadFields
extends OpcodeStackDetector

Nested Class Summary

Nested classes/interfaces inherited from class OpcodeStackDetector

OpcodeStackDetector.WithCustomJumpInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String, List<BugAnnotation>>	anonymousClassAnnotation
private final BugAccumulator	bugAccumulator
private final BugReporter	bugReporter
(package private) int	count_aload_1
(package private) UnreadFieldsData	data
private static final boolean	DEBUG
(package private) static final int	DO_NOT_CONSIDER
(package private) static Pattern	dontComplainAbout
(package private) final ClassDescriptor	externalizable
(package private) boolean	hasNativeMethods
private static final List<String>	INITIALIZER_ANNOTATIONS
(package private) boolean	isSerializable
private final ClassDescriptor	junitNestedAnnotation
(package private) XField	pendingGetField
private int	previousOpcode
private int	previousPreviousOpcode
(package private) boolean	publicOrProtectedConstructor
private static final List<ClassDescriptor>	READ_BY_FRAMEWORK_ANNOTATIONS	A list of annotations for fields that might be read by frameworks, even though they are private
(package private) final ClassDescriptor	remote
(package private) int	saState
(package private) boolean	sawSelfCallInConstructor
(package private) boolean	seenInvokeStatic
(package private) boolean	seenMonitorEnter
(package private) final ClassDescriptor	serializable
(package private) static Pattern	withinAnonymousClass

Fields inherited from class OpcodeStackDetector

stack

Fields inherited from class DismantleBytecode

codeBytes, lineNumberTable, M_BR, M_CP, M_INT, M_PAD, M_R, M_UINT

Fields inherited from interface Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
UnreadFields(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
private BugInstance	addClassFieldAndAccess(BugInstance instance, XField f)
static boolean	classHasParameter(org.apache.bcel.classfile.JavaClass obj)
static boolean	containsSpecialAnnotation(Collection<AnnotationValue> annotationsToCheck)	Checks whether the collection of annotations associated with a given element include annotations that indicate the "URF_UNREAD_FIELD" detector should be skipped.
boolean	existsStrongEvidenceForIntendedSerialization(ClassDescriptor c)	Deprecated. Use UnreadFieldsData.existsStrongEvidenceForIntendedSerialization(ClassDescriptor) instead
Set<? extends XField>	getReadFields()	Deprecated. Use UnreadFieldsData.getReadFields() instead
Set<? extends XField>	getWrittenFields()	Deprecated. Use UnreadFieldsData.getWrittenFields() instead
boolean	isContainerField(XField f)	Deprecated. Use UnreadFieldsData.isContainerField(XField) instead
private boolean	isInitializerMethod()
static boolean	isInjectionAttribute(String annotationClass)
boolean	isReflexive(XField f)	Deprecated. Use UnreadFieldsData.isReflexive(XField) instead
static boolean	isSeleniumWebElement(String signature)
boolean	isWrittenDuringInitialization(XField f)	Deprecated. Use UnreadFieldsData.isWrittenDuringInitialization(XField) instead
boolean	isWrittenInConstructor(XField f)	Deprecated. Use UnreadFieldsData.isWrittenInConstructor(XField) instead
boolean	isWrittenOutsideOfInitialization(XField f)	Deprecated. Use UnreadFieldsData.isWrittenOutsideOfInitialization(XField) instead
void	report()	This method is called after all classes to be visited.
void	sawOpcode(int seen)	By default, this method will not be called when stack is TOP.
void	strongEvidenceForIntendedSerialization(ClassDescriptor c)	Deprecated. Use UnreadFieldsData.strongEvidenceForIntendedSerialization(ClassDescriptor) instead
void	visit(org.apache.bcel.classfile.Code obj)
void	visit(org.apache.bcel.classfile.ConstantValue obj)
void	visit(org.apache.bcel.classfile.Field obj)
void	visit(org.apache.bcel.classfile.JavaClass obj)
void	visit(org.apache.bcel.classfile.Method obj)
void	visitAfter(org.apache.bcel.classfile.JavaClass obj)
void	visitAnnotation(String annotationClass, Map<String, org.apache.bcel.classfile.ElementValue> map, boolean runtimeVisible)	Visit annotation on a class, field or method

Methods inherited from class OpcodeStackDetector

afterOpcode, beforeOpcode, getStack, isUsingCustomUserValue, visitCode

Methods inherited from class BytecodeScanningDetector

getClassContext, shouldVisitCode, visitClassContext

Methods inherited from class DismantleBytecode

areOppositeBranches, atCatchBlock, getBranchFallThrough, getBranchOffset, getBranchTarget, getClassConstantOperand, getClassDescriptorOperand, getCodeByte, getConstantRefOperand, getDefaultSwitchOffset, getDottedClassConstantOperand, getFieldDescriptorOperand, getIntConstant, getLongConstant, getMaxPC, getMethodDescriptorOperand, getNameConstantOperand, getNextCodeByte, getNextOpcode, getNextPC, getOpcode, getPC, getPrevOpcode, getRefConstantOperand, getRefFieldIsStatic, getRegisterOperand, getSigConstantOperand, getStringConstantOperand, getSwitchLabels, getSwitchOffsets, getXClassOperand, getXFieldOperand, getXMethodOperand, isBranch, isMethodCall, isRegisterLoad, isRegisterStore, isRegisterStore, isReturn, isShift, isSwitch, isWideOpcode, printOpCode, sawBranchTo, sawClass, sawDouble, sawField, sawFloat, sawIMethod, sawInt, sawLong, sawMethod, sawRegister, sawString

Methods inherited from class AnnotationVisitor

getAnnotationParameterAsEnum, getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitParameterAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

Methods inherited from class PreorderVisitor

amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingCaughtExceptionTypes, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

Methods inherited from class BetterVisitor

clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitField, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitMethod, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.bcel.classfile.Visitor

visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitRecord, visitRecordComponent, visitStackMapType

Field Details

DEBUG

private static final boolean DEBUG

INITIALIZER_ANNOTATIONS

private static final List<String> INITIALIZER_ANNOTATIONS

READ_BY_FRAMEWORK_ANNOTATIONS

private static final List<ClassDescriptor> READ_BY_FRAMEWORK_ANNOTATIONS

A list of annotations for fields that might be read by frameworks, even though they are private

hasNativeMethods

boolean hasNativeMethods

isSerializable

boolean isSerializable

sawSelfCallInConstructor

boolean sawSelfCallInConstructor

bugReporter

private final BugReporter bugReporter

bugAccumulator

private final BugAccumulator bugAccumulator

publicOrProtectedConstructor

boolean publicOrProtectedConstructor

anonymousClassAnnotation

private final Map<String, List<BugAnnotation>> anonymousClassAnnotation

junitNestedAnnotation

private final ClassDescriptor junitNestedAnnotation

DO_NOT_CONSIDER

static final int DO_NOT_CONSIDER

See Also:

• Constant Field Values

externalizable

final ClassDescriptor externalizable

serializable

final ClassDescriptor serializable

remote

final ClassDescriptor remote

count_aload_1

int count_aload_1

previousOpcode

private int previousOpcode

previousPreviousOpcode

private int previousPreviousOpcode

seenInvokeStatic

boolean seenInvokeStatic

seenMonitorEnter

boolean seenMonitorEnter

pendingGetField

XField pendingGetField

data

UnreadFieldsData data

saState

int saState

dontComplainAbout

static Pattern dontComplainAbout

withinAnonymousClass

static Pattern withinAnonymousClass

Constructor Details

UnreadFields

public UnreadFields(BugReporter bugReporter)

Method Details

isContainerField

@Deprecated
public boolean isContainerField(XField f)

Deprecated.

Use UnreadFieldsData.isContainerField(XField) instead

getReadFields

@Deprecated
public Set<? extends XField> getReadFields()

Deprecated.

Use UnreadFieldsData.getReadFields() instead

getWrittenFields

@Deprecated
public Set<? extends XField> getWrittenFields()

Deprecated.

Use UnreadFieldsData.getWrittenFields() instead

isWrittenOutsideOfInitialization

@Deprecated
public boolean isWrittenOutsideOfInitialization(XField f)

Deprecated.

Use UnreadFieldsData.isWrittenOutsideOfInitialization(XField) instead

isWrittenDuringInitialization

@Deprecated
public boolean isWrittenDuringInitialization(XField f)

Deprecated.

Use UnreadFieldsData.isWrittenDuringInitialization(XField) instead

isWrittenInConstructor

@Deprecated
public boolean isWrittenInConstructor(XField f)

Deprecated.

Use UnreadFieldsData.isWrittenInConstructor(XField) instead

strongEvidenceForIntendedSerialization

@Deprecated
public void strongEvidenceForIntendedSerialization(ClassDescriptor c)

Deprecated.

Use UnreadFieldsData.strongEvidenceForIntendedSerialization(ClassDescriptor) instead

existsStrongEvidenceForIntendedSerialization

@Deprecated
public boolean existsStrongEvidenceForIntendedSerialization(ClassDescriptor c)

Deprecated.

Use UnreadFieldsData.existsStrongEvidenceForIntendedSerialization(ClassDescriptor) instead

visit

public void visit(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visit in class BetterVisitor

classHasParameter

public static boolean classHasParameter(org.apache.bcel.classfile.JavaClass obj)

visitAfter

public void visitAfter(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visitAfter in class PreorderVisitor

visit

public void visit(org.apache.bcel.classfile.Field obj)

Overrides:

visit in class BetterVisitor

isSeleniumWebElement

public static boolean isSeleniumWebElement(String signature)

visitAnnotation

public void visitAnnotation(String annotationClass,
 Map<String, org.apache.bcel.classfile.ElementValue> map,
 boolean runtimeVisible)

Description copied from class: AnnotationVisitor

Visit annotation on a class, field or method

Overrides:

visitAnnotation in class AnnotationVisitor

Parameters:

annotationClass - class of annotation

map - map from names to values

runtimeVisible - true if annotation is runtime visible

isInjectionAttribute

public static boolean isInjectionAttribute(@DottedClassName
 String annotationClass)

visit

public void visit(org.apache.bcel.classfile.ConstantValue obj)

Overrides:

visit in class BetterVisitor

visit

public void visit(org.apache.bcel.classfile.Code obj)

Overrides:

visit in class DismantleBytecode

visit

public void visit(org.apache.bcel.classfile.Method obj)

Overrides:

visit in class BetterVisitor

sawOpcode

public void sawOpcode(int seen)

Description copied from class: OpcodeStackDetector

By default, this method will not be called when stack is TOP. To change this behavior, override #beforeOpcode(int) and change to return true even if stack is TOP.

see Using FindBugs for Research to learn lattice and what TOP means.

Specified by:

sawOpcode in class OpcodeStackDetector

See Also:

• OpcodeStackDetector.beforeOpcode(int)

isInitializerMethod

private boolean isInitializerMethod()

Returns:

true if the method is considered to be an initializer method. Fields might be initialized outside of a constructor, for instance through JUnit's BeforeEach

isReflexive

@Deprecated
public boolean isReflexive(XField f)

Deprecated.

Use UnreadFieldsData.isReflexive(XField) instead

report

public void report()

Description copied from interface: Detector

This method is called after all classes to be visited. It should be used by any detectors which accumulate information over all visited classes to generate results.

Specified by:

report in interface Detector

Overrides:

report in class BytecodeScanningDetector

addClassFieldAndAccess

private BugInstance addClassFieldAndAccess(BugInstance instance,
 XField f)

containsSpecialAnnotation

public static boolean containsSpecialAnnotation(Collection<AnnotationValue> annotationsToCheck)

Checks whether the collection of annotations associated with a given element include annotations that indicate the "URF_UNREAD_FIELD" detector should be skipped.

Parameters:

annotationsToCheck - Collections of annotations associated with given element.

Returns:

If true, "URF_UNREAD_FIELD" detector should be ignored for given field.

See Also:

• GitHub issue