Package edu.umd.cs.findbugs.detect

Class CheckRelaxingNullnessAnnotation

java.lang.Object

org.objectweb.asm.ClassVisitor

org.objectweb.asm.tree.ClassNode

edu.umd.cs.findbugs.asm.ClassNodeDetector

edu.umd.cs.findbugs.detect.CheckRelaxingNullnessAnnotation

All Implemented Interfaces:

Detector2, Priorities

public class CheckRelaxingNullnessAnnotation
extends ClassNodeDetector

Checks that overriding methods do not relax Nonnull (made CheckForNull) on return values or CheckForNull (made Nonnull) on parameters. The code accepts also old (deprecated) nullness annotations from edu.umd.cs.findbugs.annotations package.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	CheckRelaxingNullnessAnnotation.DetectorNode
private class	CheckRelaxingNullnessAnnotation.HierarchyIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) XClass	xclass

Fields inherited from class edu.umd.cs.findbugs.asm.ClassNodeDetector

bugReporter

Fields inherited from class org.objectweb.asm.tree.ClassNode

access, attrs, fields, innerClasses, interfaces, invisibleAnnotations, invisibleTypeAnnotations, methods, module, name, nestHostClass, nestMembers, outerClass, outerMethod, outerMethodDesc, permittedSubclasses, recordComponents, signature, sourceDebug, sourceFile, superName, version, visibleAnnotations, visibleTypeAnnotations

Fields inherited from class org.objectweb.asm.ClassVisitor

api, cv

Fields inherited from interface edu.umd.cs.findbugs.Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
CheckRelaxingNullnessAnnotation(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
(package private) static boolean	areRelated(String sig, String superSig)
(package private) static boolean	compatibleParameters(String signature, String superSignature)
(package private) static boolean	containsNullness(Collection<AnnotationValue> annotations, NullnessAnnotation nullness)
(package private) static boolean	containsRelaxedNonNull(List<org.objectweb.asm.tree.AnnotationNode> methodAnnotations)
(package private) XClass	getClassInfo(ClassDescriptor classDescr)
(package private) static Map<Integer,NullnessAnnotation>	getNonnullOrNullableParams(List<org.objectweb.asm.tree.AnnotationNode>[] parameterAnnotations)
(package private) static NullnessAnnotation	getNullness(String annotationDesc)
void	visitClass(ClassDescriptor classDescriptor)	Visit a class.
org.objectweb.asm.MethodVisitor	visitMethod(int methodAccess, String methodName, String desc, String methodSignature, String[] exceptions)

Methods inherited from class edu.umd.cs.findbugs.asm.ClassNodeDetector

finishPass, getDetectorClassName

Methods inherited from class org.objectweb.asm.tree.ClassNode

accept, check, visit, visitAnnotation, visitAttribute, visitEnd, visitField, visitInnerClass, visitModule, visitNestHost, visitNestMember, visitOuterClass, visitPermittedSubclass, visitRecordComponent, visitSource, visitTypeAnnotation

Methods inherited from class org.objectweb.asm.ClassVisitor

getDelegate

Methods inherited from class java.lang.Object

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

Field Details

xclass

XClass xclass

Constructor Details

CheckRelaxingNullnessAnnotation

public CheckRelaxingNullnessAnnotation(BugReporter bugReporter)

Method Details

visitClass

public void visitClass(ClassDescriptor classDescriptor)
                throws CheckedAnalysisException

Description copied from interface: Detector2

Visit a class.

Specified by:

visitClass in interface Detector2

Overrides:

visitClass in class ClassNodeDetector

Parameters:

classDescriptor - descriptor naming the class to visit

Throws:

CheckedAnalysisException - if an exception occurs during analysis

getClassInfo

@CheckForNull
XClass getClassInfo(ClassDescriptor classDescr)

visitMethod

public org.objectweb.asm.MethodVisitor visitMethod(int methodAccess,
 String methodName,
 String desc,
 String methodSignature,
 String[] exceptions)

Overrides:

visitMethod in class org.objectweb.asm.tree.ClassNode

containsRelaxedNonNull

static boolean containsRelaxedNonNull(@CheckForNull
 List<org.objectweb.asm.tree.AnnotationNode> methodAnnotations)

getNonnullOrNullableParams

@CheckForNull
static Map<Integer,NullnessAnnotation> getNonnullOrNullableParams(@CheckForNull
 List<org.objectweb.asm.tree.AnnotationNode>[] parameterAnnotations)

getNullness

@CheckForNull
static NullnessAnnotation getNullness(@SlashedClassName
 String annotationDesc)

containsNullness

static boolean containsNullness(Collection<AnnotationValue> annotations,
 NullnessAnnotation nullness)

compatibleParameters

static boolean compatibleParameters(String signature,
 String superSignature)

areRelated

static boolean areRelated(String sig,
 String superSig)