com.google.errorprone.scanner

Class Scanner

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<Void,VisitorState>

com.google.errorprone.scanner.Scanner

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<Void,VisitorState>

Direct Known Subclasses:

ErrorProneScanner

public class Scanner
extends com.sun.source.util.TreePathScanner<Void,VisitorState>

TODO(eaftan): I'm worried about this performance of this code, specifically the part that handles SuppressWarnings. We should profile it and see where the hotspots are.

Author:

[email protected] (Alex Eagle), [email protected] (Eddie Aftandilian)

Constructor Summary

Constructors

Constructor and Description
Scanner()

Method Summary

Modifier and Type	Method and Description
protected Set<Class<? extends Annotation>>	getCustomSuppressionAnnotations() Returns a set of all the custom suppression annotation types used by the BugCheckers in thisScanner.
protected void	handleError(Suppressible s, Throwable t) Handles an exception thrown by an individual check.
protected boolean	isSuppressed(Suppressible suppressible, VisitorState state) Returns true if this checker should be suppressed on the current tree path.
protected <T extends com.sun.source.tree.Tree> void	reportMatch(Description description, T match, VisitorState state)
Void	scan(com.sun.source.util.TreePath path, VisitorState state) Scan a tree from a position identified by a TreePath.
Void	scan(com.sun.source.tree.Tree tree, VisitorState state) Scan a single node.
Map<String,BugPattern.SeverityLevel>	severityMap() Returns a mapping between the canonical names of checks and their BugPattern.SeverityLevel.

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnnotatedType, visitAnnotation, visitArrayAccess, visitArrayType, visitAssert, visitAssignment, visitBinary, visitBlock, visitBreak, visitCase, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitEnhancedForLoop, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIdentifier, visitIf, visitImport, visitInstanceOf, visitIntersectionType, visitLabeledStatement, visitLambdaExpression, visitLiteral, visitMemberReference, visitMemberSelect, visitMethod, visitMethodInvocation, visitModifiers, visitModule, visitNewArray, visitNewClass, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitReturn, visitSwitch, visitSynchronized, visitThrow, visitTry, visitTypeCast, visitTypeParameter, visitUnary, visitUnionType, visitUses, visitVariable, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

Scanner

public Scanner()

Method Detail

scan

public Void scan(com.sun.source.util.TreePath path,
                 VisitorState state)

Scan a tree from a position identified by a TreePath.

Overrides:

scan in class com.sun.source.util.TreePathScanner<Void,VisitorState>

scan

public Void scan(com.sun.source.tree.Tree tree,
                 VisitorState state)

Scan a single node. The current path is updated for the duration of the scan.

Overrides:

scan in class com.sun.source.util.TreePathScanner<Void,VisitorState>

isSuppressed

protected boolean isSuppressed(Suppressible suppressible,
                               VisitorState state)

Returns true if this checker should be suppressed on the current tree path.

Parameters:

suppressible - holds information about the suppressibilty of a checker

getCustomSuppressionAnnotations

protected Set<Class<? extends Annotation>> getCustomSuppressionAnnotations()

Returns a set of all the custom suppression annotation types used by the BugCheckers in thisScanner.

reportMatch

protected <T extends com.sun.source.tree.Tree> void reportMatch(Description description,
                                                                T match,
                                                                VisitorState state)

handleError

protected void handleError(Suppressible s,
                           Throwable t)

Handles an exception thrown by an individual check.

severityMap

public Map<String,BugPattern.SeverityLevel> severityMap()

Returns a mapping between the canonical names of checks and their BugPattern.SeverityLevel.