Class ErrorProneScanner

java.lang.Object

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

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

com.google.errorprone.scanner.Scanner

com.google.errorprone.scanner.ErrorProneScanner

All Implemented Interfaces:

TreeVisitor<Void, VisitorState>

public class ErrorProneScanner
extends Scanner

Scans the parsed AST, looking for violations of any of the enabled checks.

Author:

Alex Eagle (alexeagle@google.com)

Constructor Summary

Constructors

Constructor	Description
ErrorProneScanner(BugChecker... checkers)	Create an error-prone scanner for the given checkers.
ErrorProneScanner(Iterable<BugChecker> checkers)	Create an error-prone scanner for a non-hardcoded set of checkers.
ErrorProneScanner(Iterable<BugChecker> checkers, Map<String, BugPattern.SeverityLevel> severities)	Create an error-prone scanner for a non-hardcoded set of checkers.

Method Summary

Modifier and Type	Method	Description
com.google.common.collect.ImmutableSet<BugChecker>	getBugCheckers()
protected Set<? extends com.sun.tools.javac.util.Name>	getCustomSuppressionAnnotations(VisitorState state)	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 BugPattern.
Map<String, BugPattern.SeverityLevel>	severityMap()	Returns a mapping between the canonical names of checks and their BugPattern.SeverityLevel.
Void	visitAnnotatedType(AnnotatedTypeTree tree, VisitorState visitorState)
Void	visitAnnotation(AnnotationTree tree, VisitorState visitorState)
Void	visitArrayAccess(ArrayAccessTree tree, VisitorState visitorState)
Void	visitArrayType(ArrayTypeTree tree, VisitorState visitorState)
Void	visitAssert(AssertTree tree, VisitorState visitorState)
Void	visitAssignment(AssignmentTree tree, VisitorState visitorState)
Void	visitBinary(BinaryTree tree, VisitorState visitorState)
Void	visitBindingPattern(BindingPatternTree tree, VisitorState visitorState)
Void	visitBlock(BlockTree tree, VisitorState visitorState)
Void	visitBreak(BreakTree tree, VisitorState visitorState)
Void	visitCase(CaseTree tree, VisitorState visitorState)
Void	visitCatch(CatchTree tree, VisitorState visitorState)
Void	visitClass(ClassTree tree, VisitorState visitorState)
Void	visitCompilationUnit(CompilationUnitTree tree, VisitorState visitorState)
Void	visitCompoundAssignment(CompoundAssignmentTree tree, VisitorState visitorState)
Void	visitConditionalExpression(ConditionalExpressionTree tree, VisitorState visitorState)
Void	visitContinue(ContinueTree tree, VisitorState visitorState)
Void	visitDoWhileLoop(DoWhileLoopTree tree, VisitorState visitorState)
Void	visitEmptyStatement(EmptyStatementTree tree, VisitorState visitorState)
Void	visitEnhancedForLoop(EnhancedForLoopTree tree, VisitorState visitorState)
Void	visitExports(ExportsTree tree, VisitorState visitorState)
Void	visitExpressionStatement(ExpressionStatementTree tree, VisitorState visitorState)
Void	visitForLoop(ForLoopTree tree, VisitorState visitorState)
Void	visitIdentifier(IdentifierTree tree, VisitorState visitorState)
Void	visitIf(IfTree tree, VisitorState visitorState)
Void	visitImport(ImportTree tree, VisitorState visitorState)
Void	visitInstanceOf(InstanceOfTree tree, VisitorState visitorState)
Void	visitIntersectionType(IntersectionTypeTree tree, VisitorState visitorState)
Void	visitLabeledStatement(LabeledStatementTree tree, VisitorState visitorState)
Void	visitLambdaExpression(LambdaExpressionTree tree, VisitorState visitorState)
Void	visitLiteral(LiteralTree tree, VisitorState visitorState)
Void	visitMemberReference(MemberReferenceTree tree, VisitorState visitorState)
Void	visitMemberSelect(MemberSelectTree tree, VisitorState visitorState)
Void	visitMethod(MethodTree tree, VisitorState visitorState)
Void	visitMethodInvocation(MethodInvocationTree tree, VisitorState visitorState)
Void	visitModifiers(ModifiersTree tree, VisitorState visitorState)
Void	visitModule(ModuleTree tree, VisitorState visitorState)
Void	visitNewArray(NewArrayTree tree, VisitorState visitorState)
Void	visitNewClass(NewClassTree tree, VisitorState visitorState)
Void	visitOpens(OpensTree tree, VisitorState visitorState)
Void	visitPackage(PackageTree tree, VisitorState visitorState)
Void	visitParameterizedType(ParameterizedTypeTree tree, VisitorState visitorState)
Void	visitParenthesized(ParenthesizedTree tree, VisitorState visitorState)
Void	visitPrimitiveType(PrimitiveTypeTree tree, VisitorState visitorState)
Void	visitProvides(ProvidesTree tree, VisitorState visitorState)
Void	visitRequires(RequiresTree tree, VisitorState visitorState)
Void	visitReturn(ReturnTree tree, VisitorState visitorState)
Void	visitSwitch(SwitchTree tree, VisitorState visitorState)
Void	visitSwitchExpression(SwitchExpressionTree tree, VisitorState visitorState)
Void	visitSynchronized(SynchronizedTree tree, VisitorState visitorState)
Void	visitThrow(ThrowTree tree, VisitorState visitorState)
Void	visitTry(TryTree tree, VisitorState visitorState)
Void	visitTypeCast(TypeCastTree tree, VisitorState visitorState)
Void	visitTypeParameter(TypeParameterTree tree, VisitorState visitorState)
Void	visitUnary(UnaryTree tree, VisitorState visitorState)
Void	visitUnionType(UnionTypeTree tree, VisitorState visitorState)
Void	visitUses(UsesTree tree, VisitorState visitorState)
Void	visitVariable(VariableTree tree, VisitorState visitorState)
Void	visitWhileLoop(WhileLoopTree tree, VisitorState visitorState)
Void	visitWildcard(WildcardTree tree, VisitorState visitorState)
Void	visitYield(YieldTree tree, VisitorState visitorState)

Methods inherited from class Scanner

isSuppressed, reportMatch, scan, scan

Methods inherited from class TreePathScanner

getCurrentPath

Methods inherited from class TreeScanner

reduce, scan, visitAnyPattern, visitConstantCaseLabel, visitDeconstructionPattern, visitDefaultCaseLabel, visitErroneous, visitOther, visitPatternCaseLabel

Methods inherited from class Object

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

Constructor Details

ErrorProneScanner

public ErrorProneScanner(BugChecker... checkers)

Create an error-prone scanner for the given checkers.

Parameters:

checkers - The checkers that this scanner should use.

ErrorProneScanner

public ErrorProneScanner(Iterable<BugChecker> checkers)

Create an error-prone scanner for a non-hardcoded set of checkers.

Parameters:

checkers - The checkers that this scanner should use.

ErrorProneScanner

public ErrorProneScanner(Iterable<BugChecker> checkers,
 Map<String, BugPattern.SeverityLevel> severities)

Create an error-prone scanner for a non-hardcoded set of checkers.

Parameters:

checkers - The checkers that this scanner should use.

severities - The default check severities.

Method Details

getCustomSuppressionAnnotations

protected Set<? extends com.sun.tools.javac.util.Name> getCustomSuppressionAnnotations(VisitorState state)

Description copied from class: Scanner

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

Overrides:

getCustomSuppressionAnnotations in class Scanner

visitAnnotation

public Void visitAnnotation(AnnotationTree tree,
 VisitorState visitorState)

Specified by:

visitAnnotation in interface TreeVisitor<Void, VisitorState>

Overrides:

visitAnnotation in class TreeScanner<Void, VisitorState>

visitAnnotatedType

public Void visitAnnotatedType(AnnotatedTypeTree tree,
 VisitorState visitorState)

Specified by:

visitAnnotatedType in interface TreeVisitor<Void, VisitorState>

Overrides:

visitAnnotatedType in class TreeScanner<Void, VisitorState>

visitArrayAccess

public Void visitArrayAccess(ArrayAccessTree tree,
 VisitorState visitorState)

Specified by:

visitArrayAccess in interface TreeVisitor<Void, VisitorState>

Overrides:

visitArrayAccess in class TreeScanner<Void, VisitorState>

visitArrayType

public Void visitArrayType(ArrayTypeTree tree,
 VisitorState visitorState)

Specified by:

visitArrayType in interface TreeVisitor<Void, VisitorState>

Overrides:

visitArrayType in class TreeScanner<Void, VisitorState>

visitAssert

public Void visitAssert(AssertTree tree,
 VisitorState visitorState)

Specified by:

visitAssert in interface TreeVisitor<Void, VisitorState>

Overrides:

visitAssert in class TreeScanner<Void, VisitorState>

visitAssignment

public Void visitAssignment(AssignmentTree tree,
 VisitorState visitorState)

Specified by:

visitAssignment in interface TreeVisitor<Void, VisitorState>

Overrides:

visitAssignment in class TreeScanner<Void, VisitorState>

visitBinary

public Void visitBinary(BinaryTree tree,
 VisitorState visitorState)

Specified by:

visitBinary in interface TreeVisitor<Void, VisitorState>

Overrides:

visitBinary in class TreeScanner<Void, VisitorState>

visitBindingPattern

public Void visitBindingPattern(BindingPatternTree tree,
 VisitorState visitorState)

Specified by:

visitBindingPattern in interface TreeVisitor<Void, VisitorState>

Overrides:

visitBindingPattern in class TreeScanner<Void, VisitorState>

visitBlock

public Void visitBlock(BlockTree tree,
 VisitorState visitorState)

Specified by:

visitBlock in interface TreeVisitor<Void, VisitorState>

Overrides:

visitBlock in class TreeScanner<Void, VisitorState>

visitBreak

public Void visitBreak(BreakTree tree,
 VisitorState visitorState)

Specified by:

visitBreak in interface TreeVisitor<Void, VisitorState>

Overrides:

visitBreak in class TreeScanner<Void, VisitorState>

visitCase

public Void visitCase(CaseTree tree,
 VisitorState visitorState)

Specified by:

visitCase in interface TreeVisitor<Void, VisitorState>

Overrides:

visitCase in class TreeScanner<Void, VisitorState>

visitCatch

public Void visitCatch(CatchTree tree,
 VisitorState visitorState)

Specified by:

visitCatch in interface TreeVisitor<Void, VisitorState>

Overrides:

visitCatch in class TreeScanner<Void, VisitorState>

visitClass

public Void visitClass(ClassTree tree,
 VisitorState visitorState)

Specified by:

visitClass in interface TreeVisitor<Void, VisitorState>

Overrides:

visitClass in class TreeScanner<Void, VisitorState>

visitCompilationUnit

public Void visitCompilationUnit(CompilationUnitTree tree,
 VisitorState visitorState)

Specified by:

visitCompilationUnit in interface TreeVisitor<Void, VisitorState>

Overrides:

visitCompilationUnit in class TreeScanner<Void, VisitorState>

visitCompoundAssignment

public Void visitCompoundAssignment(CompoundAssignmentTree tree,
 VisitorState visitorState)

Specified by:

visitCompoundAssignment in interface TreeVisitor<Void, VisitorState>

Overrides:

visitCompoundAssignment in class TreeScanner<Void, VisitorState>

visitConditionalExpression

public Void visitConditionalExpression(ConditionalExpressionTree tree,
 VisitorState visitorState)

Specified by:

visitConditionalExpression in interface TreeVisitor<Void, VisitorState>

Overrides:

visitConditionalExpression in class TreeScanner<Void, VisitorState>

visitContinue

public Void visitContinue(ContinueTree tree,
 VisitorState visitorState)

Specified by:

visitContinue in interface TreeVisitor<Void, VisitorState>

Overrides:

visitContinue in class TreeScanner<Void, VisitorState>

visitDoWhileLoop

public Void visitDoWhileLoop(DoWhileLoopTree tree,
 VisitorState visitorState)

Specified by:

visitDoWhileLoop in interface TreeVisitor<Void, VisitorState>

Overrides:

visitDoWhileLoop in class TreeScanner<Void, VisitorState>

visitEmptyStatement

public Void visitEmptyStatement(EmptyStatementTree tree,
 VisitorState visitorState)

Specified by:

visitEmptyStatement in interface TreeVisitor<Void, VisitorState>

Overrides:

visitEmptyStatement in class TreeScanner<Void, VisitorState>

visitEnhancedForLoop

public Void visitEnhancedForLoop(EnhancedForLoopTree tree,
 VisitorState visitorState)

Specified by:

visitEnhancedForLoop in interface TreeVisitor<Void, VisitorState>

Overrides:

visitEnhancedForLoop in class TreeScanner<Void, VisitorState>

visitExports

public Void visitExports(ExportsTree tree,
 VisitorState visitorState)

Specified by:

visitExports in interface TreeVisitor<Void, VisitorState>

Overrides:

visitExports in class TreeScanner<Void, VisitorState>

visitExpressionStatement

public Void visitExpressionStatement(ExpressionStatementTree tree,
 VisitorState visitorState)

Specified by:

visitExpressionStatement in interface TreeVisitor<Void, VisitorState>

Overrides:

visitExpressionStatement in class TreeScanner<Void, VisitorState>

visitForLoop

public Void visitForLoop(ForLoopTree tree,
 VisitorState visitorState)

Specified by:

visitForLoop in interface TreeVisitor<Void, VisitorState>

Overrides:

visitForLoop in class TreeScanner<Void, VisitorState>

visitIdentifier

public Void visitIdentifier(IdentifierTree tree,
 VisitorState visitorState)

Specified by:

visitIdentifier in interface TreeVisitor<Void, VisitorState>

Overrides:

visitIdentifier in class TreeScanner<Void, VisitorState>

visitIf

public Void visitIf(IfTree tree,
 VisitorState visitorState)

Specified by:

visitIf in interface TreeVisitor<Void, VisitorState>

Overrides:

visitIf in class TreeScanner<Void, VisitorState>

visitImport

public Void visitImport(ImportTree tree,
 VisitorState visitorState)

Specified by:

visitImport in interface TreeVisitor<Void, VisitorState>

Overrides:

visitImport in class TreeScanner<Void, VisitorState>

visitInstanceOf

public Void visitInstanceOf(InstanceOfTree tree,
 VisitorState visitorState)

Specified by:

visitInstanceOf in interface TreeVisitor<Void, VisitorState>

Overrides:

visitInstanceOf in class TreeScanner<Void, VisitorState>

visitIntersectionType

public Void visitIntersectionType(IntersectionTypeTree tree,
 VisitorState visitorState)

Specified by:

visitIntersectionType in interface TreeVisitor<Void, VisitorState>

Overrides:

visitIntersectionType in class TreeScanner<Void, VisitorState>

visitLabeledStatement

public Void visitLabeledStatement(LabeledStatementTree tree,
 VisitorState visitorState)

Specified by:

visitLabeledStatement in interface TreeVisitor<Void, VisitorState>

Overrides:

visitLabeledStatement in class TreeScanner<Void, VisitorState>

visitLambdaExpression

public Void visitLambdaExpression(LambdaExpressionTree tree,
 VisitorState visitorState)

Specified by:

visitLambdaExpression in interface TreeVisitor<Void, VisitorState>

Overrides:

visitLambdaExpression in class TreeScanner<Void, VisitorState>

visitLiteral

public Void visitLiteral(LiteralTree tree,
 VisitorState visitorState)

Specified by:

visitLiteral in interface TreeVisitor<Void, VisitorState>

Overrides:

visitLiteral in class TreeScanner<Void, VisitorState>

visitMemberReference

public Void visitMemberReference(MemberReferenceTree tree,
 VisitorState visitorState)

Specified by:

visitMemberReference in interface TreeVisitor<Void, VisitorState>

Overrides:

visitMemberReference in class TreeScanner<Void, VisitorState>

visitMemberSelect

public Void visitMemberSelect(MemberSelectTree tree,
 VisitorState visitorState)

Specified by:

visitMemberSelect in interface TreeVisitor<Void, VisitorState>

Overrides:

visitMemberSelect in class TreeScanner<Void, VisitorState>

visitMethod

public Void visitMethod(MethodTree tree,
 VisitorState visitorState)

Specified by:

visitMethod in interface TreeVisitor<Void, VisitorState>

Overrides:

visitMethod in class TreeScanner<Void, VisitorState>

visitMethodInvocation

public Void visitMethodInvocation(MethodInvocationTree tree,
 VisitorState visitorState)

Specified by:

visitMethodInvocation in interface TreeVisitor<Void, VisitorState>

Overrides:

visitMethodInvocation in class TreeScanner<Void, VisitorState>

visitModifiers

public Void visitModifiers(ModifiersTree tree,
 VisitorState visitorState)

Specified by:

visitModifiers in interface TreeVisitor<Void, VisitorState>

Overrides:

visitModifiers in class TreeScanner<Void, VisitorState>

visitModule

public Void visitModule(ModuleTree tree,
 VisitorState visitorState)

Specified by:

visitModule in interface TreeVisitor<Void, VisitorState>

Overrides:

visitModule in class TreeScanner<Void, VisitorState>

visitNewArray

public Void visitNewArray(NewArrayTree tree,
 VisitorState visitorState)

Specified by:

visitNewArray in interface TreeVisitor<Void, VisitorState>

Overrides:

visitNewArray in class TreeScanner<Void, VisitorState>

visitNewClass

public Void visitNewClass(NewClassTree tree,
 VisitorState visitorState)

Specified by:

visitNewClass in interface TreeVisitor<Void, VisitorState>

Overrides:

visitNewClass in class TreeScanner<Void, VisitorState>

visitOpens

public Void visitOpens(OpensTree tree,
 VisitorState visitorState)

Specified by:

visitOpens in interface TreeVisitor<Void, VisitorState>

Overrides:

visitOpens in class TreeScanner<Void, VisitorState>

visitPackage

public Void visitPackage(PackageTree tree,
 VisitorState visitorState)

Specified by:

visitPackage in interface TreeVisitor<Void, VisitorState>

Overrides:

visitPackage in class TreeScanner<Void, VisitorState>

visitParameterizedType

public Void visitParameterizedType(ParameterizedTypeTree tree,
 VisitorState visitorState)

Specified by:

visitParameterizedType in interface TreeVisitor<Void, VisitorState>

Overrides:

visitParameterizedType in class TreeScanner<Void, VisitorState>

visitParenthesized

public Void visitParenthesized(ParenthesizedTree tree,
 VisitorState visitorState)

Specified by:

visitParenthesized in interface TreeVisitor<Void, VisitorState>

Overrides:

visitParenthesized in class TreeScanner<Void, VisitorState>

visitPrimitiveType

public Void visitPrimitiveType(PrimitiveTypeTree tree,
 VisitorState visitorState)

Specified by:

visitPrimitiveType in interface TreeVisitor<Void, VisitorState>

Overrides:

visitPrimitiveType in class TreeScanner<Void, VisitorState>

visitProvides

public Void visitProvides(ProvidesTree tree,
 VisitorState visitorState)

Specified by:

visitProvides in interface TreeVisitor<Void, VisitorState>

Overrides:

visitProvides in class TreeScanner<Void, VisitorState>

visitRequires

public Void visitRequires(RequiresTree tree,
 VisitorState visitorState)

Specified by:

visitRequires in interface TreeVisitor<Void, VisitorState>

Overrides:

visitRequires in class TreeScanner<Void, VisitorState>

visitReturn

public Void visitReturn(ReturnTree tree,
 VisitorState visitorState)

Specified by:

visitReturn in interface TreeVisitor<Void, VisitorState>

Overrides:

visitReturn in class TreeScanner<Void, VisitorState>

visitSwitchExpression

public Void visitSwitchExpression(SwitchExpressionTree tree,
 VisitorState visitorState)

Specified by:

visitSwitchExpression in interface TreeVisitor<Void, VisitorState>

Overrides:

visitSwitchExpression in class TreeScanner<Void, VisitorState>

visitSwitch

public Void visitSwitch(SwitchTree tree,
 VisitorState visitorState)

Specified by:

visitSwitch in interface TreeVisitor<Void, VisitorState>

Overrides:

visitSwitch in class TreeScanner<Void, VisitorState>

visitSynchronized

public Void visitSynchronized(SynchronizedTree tree,
 VisitorState visitorState)

Specified by:

visitSynchronized in interface TreeVisitor<Void, VisitorState>

Overrides:

visitSynchronized in class TreeScanner<Void, VisitorState>

visitThrow

public Void visitThrow(ThrowTree tree,
 VisitorState visitorState)

Specified by:

visitThrow in interface TreeVisitor<Void, VisitorState>

Overrides:

visitThrow in class TreeScanner<Void, VisitorState>

visitTry

public Void visitTry(TryTree tree,
 VisitorState visitorState)

Specified by:

visitTry in interface TreeVisitor<Void, VisitorState>

Overrides:

visitTry in class TreeScanner<Void, VisitorState>

visitTypeCast

public Void visitTypeCast(TypeCastTree tree,
 VisitorState visitorState)

Specified by:

visitTypeCast in interface TreeVisitor<Void, VisitorState>

Overrides:

visitTypeCast in class TreeScanner<Void, VisitorState>

visitTypeParameter

public Void visitTypeParameter(TypeParameterTree tree,
 VisitorState visitorState)

Specified by:

visitTypeParameter in interface TreeVisitor<Void, VisitorState>

Overrides:

visitTypeParameter in class TreeScanner<Void, VisitorState>

visitUnary

public Void visitUnary(UnaryTree tree,
 VisitorState visitorState)

Specified by:

visitUnary in interface TreeVisitor<Void, VisitorState>

Overrides:

visitUnary in class TreeScanner<Void, VisitorState>

visitUnionType

public Void visitUnionType(UnionTypeTree tree,
 VisitorState visitorState)

Specified by:

visitUnionType in interface TreeVisitor<Void, VisitorState>

Overrides:

visitUnionType in class TreeScanner<Void, VisitorState>

visitUses

public Void visitUses(UsesTree tree,
 VisitorState visitorState)

Specified by:

visitUses in interface TreeVisitor<Void, VisitorState>

Overrides:

visitUses in class TreeScanner<Void, VisitorState>

visitVariable

public Void visitVariable(VariableTree tree,
 VisitorState visitorState)

Specified by:

visitVariable in interface TreeVisitor<Void, VisitorState>

Overrides:

visitVariable in class TreeScanner<Void, VisitorState>

visitWhileLoop

public Void visitWhileLoop(WhileLoopTree tree,
 VisitorState visitorState)

Specified by:

visitWhileLoop in interface TreeVisitor<Void, VisitorState>

Overrides:

visitWhileLoop in class TreeScanner<Void, VisitorState>

visitWildcard

public Void visitWildcard(WildcardTree tree,
 VisitorState visitorState)

Specified by:

visitWildcard in interface TreeVisitor<Void, VisitorState>

Overrides:

visitWildcard in class TreeScanner<Void, VisitorState>

visitYield

public Void visitYield(YieldTree tree,
 VisitorState visitorState)

Specified by:

visitYield in interface TreeVisitor<Void, VisitorState>

Overrides:

visitYield in class TreeScanner<Void, VisitorState>

handleError

protected void handleError(Suppressible s,
 Throwable t)

Handles an exception thrown by an individual BugPattern. By default, wraps the exception in an ErrorProneError and rethrows. May be overridden by subclasses, for example to log the error and continue.

Overrides:

handleError in class Scanner

severityMap

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

Description copied from class: Scanner

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

Overrides:

severityMap in class Scanner

getBugCheckers

public com.google.common.collect.ImmutableSet<BugChecker> getBugCheckers()