Class BuildCheckReturnAnnotationDatabase

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.detect.BuildCheckReturnAnnotationDatabase

All Implemented Interfaces:

org.apache.bcel.classfile.Visitor

Direct Known Subclasses:

NoteCheckReturnValueAnnotations

public class BuildCheckReturnAnnotationDatabase
extends AnnotationVisitor

Scan application classes for CheckReturnValue annotations.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DEFAULT_ANNOTATION_ANNOTATION_CLASS
private static final Map<String, AnnotationDatabase.Target>	defaultKind

Constructor Summary

Constructors

Constructor	Description
BuildCheckReturnAnnotationDatabase()

Method Summary

Modifier and Type	Method	Description
private void	handleClassElementValue(org.apache.bcel.classfile.ClassElementValue value, Map<String, org.apache.bcel.classfile.ElementValue> map, AnnotationDatabase.Target annotationTarget)
(package private) static String	simpleClassName(String className)
void	visitAnnotation(String annotationClassName, Map<String, org.apache.bcel.classfile.ElementValue> map, boolean runtimeVisible)	Visit annotation on a class, field or method

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, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitCode, 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, 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

DEFAULT_ANNOTATION_ANNOTATION_CLASS

private static final String DEFAULT_ANNOTATION_ANNOTATION_CLASS

See Also:

• Constant Field Values

defaultKind

@StaticConstant
private static final Map<String, AnnotationDatabase.Target> defaultKind

Constructor Details

BuildCheckReturnAnnotationDatabase

public BuildCheckReturnAnnotationDatabase()

Method Details

simpleClassName

static String simpleClassName(@DottedClassName
 String className)

visitAnnotation

public void visitAnnotation(@DottedClassName
 String annotationClassName,
 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:

annotationClassName - class of annotation

map - map from names to values

runtimeVisible - true if annotation is runtime visible

handleClassElementValue

private void handleClassElementValue(org.apache.bcel.classfile.ClassElementValue value,
 Map<String, org.apache.bcel.classfile.ElementValue> map,
 AnnotationDatabase.Target annotationTarget)