Class AnnotationVisitor

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

All Implemented Interfaces:

org.apache.bcel.classfile.Visitor

Direct Known Subclasses:

AnnotationDetector, BuildCheckReturnAnnotationDatabase, BuildNonNullAnnotationDatabase, DismantleBytecode, NoteAnnotationRetention, NoteJCIPAnnotation, NoteSuppressedWarnings

public class AnnotationVisitor
extends PreorderVisitor

Subclass of PreorderVisitor that visits annotations on classes, fields, methods, and method parameters.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final boolean	DEBUG

Fields inherited from class PreorderVisitor

argumentSignature, visitMethodsInCallOrder

Constructor Summary

Constructors

Constructor	Description
AnnotationVisitor()

Method Summary

Modifier and Type	Method	Description
protected static <E extends Enum<E>> E	getAnnotationParameterAsEnum(Map<String, org.apache.bcel.classfile.ElementValue> map, String parameter, Class<E> type)
protected static String	getAnnotationParameterAsString(Map<String, org.apache.bcel.classfile.ElementValue> map, String parameter)
protected static String[]	getAnnotationParameterAsStringArray(Map<String, org.apache.bcel.classfile.ElementValue> map, String parameter)
void	visitAnnotation(String annotationClass, Map<String, org.apache.bcel.classfile.ElementValue> map, boolean runtimeVisible)	Visit annotation on a class, field or method
void	visitAnnotation(org.apache.bcel.classfile.Annotations arg0)
void	visitParameterAnnotation(int p, String annotationClass, Map<String, org.apache.bcel.classfile.ElementValue> map, boolean runtimeVisible)	Visit annotation on a method parameter
void	visitParameterAnnotation(org.apache.bcel.classfile.ParameterAnnotations arg0)
void	visitSyntheticParameterAnnotation(int p, boolean runtimeVisible)

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

DEBUG

static final boolean DEBUG

Constructor Details

AnnotationVisitor

public AnnotationVisitor()

Method Details

visitAnnotation

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

Visit annotation on a class, field or method

Parameters:

annotationClass - class of annotation

map - map from names to values

runtimeVisible - true if annotation is runtime visible

getAnnotationParameterAsString

protected static String getAnnotationParameterAsString(Map<String, org.apache.bcel.classfile.ElementValue> map,
 String parameter)

getAnnotationParameterAsStringArray

@CheckForNull
protected static String[] getAnnotationParameterAsStringArray(Map<String, org.apache.bcel.classfile.ElementValue> map,
 String parameter)

getAnnotationParameterAsEnum

@CheckForNull
protected static <E extends Enum<E>> E getAnnotationParameterAsEnum(Map<String, org.apache.bcel.classfile.ElementValue> map,
 String parameter,
 Class<E> type)

visitParameterAnnotation

public void visitParameterAnnotation(int p,
 @DottedClassName
 String annotationClass,
 Map<String, org.apache.bcel.classfile.ElementValue> map,
 boolean runtimeVisible)

Visit annotation on a method parameter

Parameters:

p - parameter number, starting at zero ("this" parameter is not counted)

annotationClass - class of annotation

map - map from names to values

runtimeVisible - true if annotation is runtime visible

visitSyntheticParameterAnnotation

public void visitSyntheticParameterAnnotation(int p,
 boolean runtimeVisible)

visitParameterAnnotation

public void visitParameterAnnotation(org.apache.bcel.classfile.ParameterAnnotations arg0)

Specified by:

visitParameterAnnotation in interface org.apache.bcel.classfile.Visitor

Overrides:

visitParameterAnnotation in class PreorderVisitor

visitAnnotation

public void visitAnnotation(org.apache.bcel.classfile.Annotations arg0)

Specified by:

visitAnnotation in interface org.apache.bcel.classfile.Visitor

Overrides:

visitAnnotation in class PreorderVisitor