com.google.errorprone.bugpatterns

Class BugChecker

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

All Implemented Interfaces:

Suppressible, Serializable

public abstract class BugChecker
extends Object
implements Suppressible, Serializable

A base class for implementing bug checkers. The BugChecker supplies a Scanner implementation for this checker, making it easy to use a single checker. Subclasses should also implement one or more of the *Matcher interfaces in this class to declare which tree node types to match against.

Author:

Colin Decker, Eddie Aftandilian ([email protected])

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BugChecker.AnnotatedTypeTreeMatcher
static interface	BugChecker.AnnotationTreeMatcher
static interface	BugChecker.ArrayAccessTreeMatcher
static interface	BugChecker.ArrayTypeTreeMatcher
static interface	BugChecker.AssertTreeMatcher
static interface	BugChecker.AssignmentTreeMatcher
static interface	BugChecker.BinaryTreeMatcher
static interface	BugChecker.BlockTreeMatcher
static interface	BugChecker.BreakTreeMatcher
static interface	BugChecker.CaseTreeMatcher
static interface	BugChecker.CatchTreeMatcher
static interface	BugChecker.ClassTreeMatcher
static interface	BugChecker.CompilationUnitTreeMatcher
static interface	BugChecker.CompoundAssignmentTreeMatcher
static interface	BugChecker.ConditionalExpressionTreeMatcher
static interface	BugChecker.ContinueTreeMatcher
static interface	BugChecker.DoWhileLoopTreeMatcher
static interface	BugChecker.EmptyStatementTreeMatcher
static interface	BugChecker.EnhancedForLoopTreeMatcher
static interface	BugChecker.ExpressionStatementTreeMatcher
static interface	BugChecker.ForLoopTreeMatcher
static interface	BugChecker.IdentifierTreeMatcher
static interface	BugChecker.IfTreeMatcher
static interface	BugChecker.ImportTreeMatcher
static interface	BugChecker.InstanceOfTreeMatcher
static interface	BugChecker.IntersectionTypeTreeMatcher
static interface	BugChecker.LabeledStatementTreeMatcher
static interface	BugChecker.LambdaExpressionTreeMatcher
static interface	BugChecker.LiteralTreeMatcher
static interface	BugChecker.MemberReferenceTreeMatcher
static interface	BugChecker.MemberSelectTreeMatcher
static interface	BugChecker.MethodInvocationTreeMatcher
static interface	BugChecker.MethodTreeMatcher
static interface	BugChecker.ModifiersTreeMatcher
static interface	BugChecker.NewArrayTreeMatcher
static interface	BugChecker.NewClassTreeMatcher
static interface	BugChecker.ParameterizedTypeTreeMatcher
static interface	BugChecker.ParenthesizedTreeMatcher
static interface	BugChecker.PrimitiveTypeTreeMatcher
static interface	BugChecker.ReturnTreeMatcher
static interface	BugChecker.SwitchTreeMatcher
static interface	BugChecker.SynchronizedTreeMatcher
static interface	BugChecker.ThrowTreeMatcher
static interface	BugChecker.TryTreeMatcher
static interface	BugChecker.TypeCastTreeMatcher
static interface	BugChecker.TypeParameterTreeMatcher
static interface	BugChecker.UnaryTreeMatcher
static interface	BugChecker.UnionTypeTreeMatcher
static interface	BugChecker.VariableTreeMatcher
static interface	BugChecker.WhileLoopTreeMatcher
static interface	BugChecker.WildcardTreeMatcher

Constructor Summary

Constructors

Constructor and Description
BugChecker()

Method Summary

Modifier and Type	Method and Description
Set<String>	allNames() Returns all of the name strings that this checker should respect as part of a @SuppressWarnings annotation.
protected Description.Builder	buildDescription(com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition position) Returns a Description builder, which allows you to customize the diagnostic with a custom message or multiple fixes.
protected Description.Builder	buildDescription(com.sun.tools.javac.tree.JCTree tree) Returns a Description builder, which allows you to customize the diagnostic with a custom message or multiple fixes.
protected Description.Builder	buildDescription(com.sun.source.tree.Tree node) Returns a Description builder, which allows you to customize the diagnostic with a custom message or multiple fixes.
static Description.Builder	buildDescriptionFromChecker(com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition position, BugChecker checker) Returns a new builder for Descriptions.
static Description.Builder	buildDescriptionFromChecker(com.sun.tools.javac.tree.JCTree tree, BugChecker checker) Returns a new builder for Descriptions.
static Description.Builder	buildDescriptionFromChecker(com.sun.source.tree.Tree node, BugChecker checker) Returns a new builder for Descriptions.
String	canonicalName() The canonical name of the check.
Set<Class<? extends Annotation>>	customSuppressionAnnotations() Returns the custom suppression annotations for this checker, if custom suppression is used.
BugPattern.SeverityLevel	defaultSeverity()
protected Description	describeMatch(com.sun.source.tree.Tree node) Helper to create a Description for the common case where there is no fix.
protected Description	describeMatch(com.sun.source.tree.Tree node, Fix fix) Helper to create a Description for the common case where there is a fix.
protected Description	describeMatch(com.sun.source.tree.Tree node, Optional<? extends Fix> fix) Helper to create a Description for the common case where there is an Optional fix.
boolean	equals(Object obj)
int	hashCode()
boolean	isSuppressed(com.sun.tools.javac.code.Symbol symbol) Returns true if the given symbol is annotated with a @SuppressWarnings that disables this bug checker.
boolean	isSuppressed(com.sun.source.tree.Tree tree) Returns true if the given tree is annotated with a @SuppressWarnings that disables this bug checker.
String	linkUrl()
String	message()
BugPattern.SeverityLevel	severity(Map<String,BugPattern.SeverityLevel> severities)
boolean	supportsSuppressWarnings() Returns true if this checker can be suppressed using @SuppressWarnings.

Methods inherited from class java.lang.Object

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

Constructor Detail

BugChecker

public BugChecker()

Method Detail

describeMatch

@CheckReturnValue
protected Description describeMatch(com.sun.source.tree.Tree node,
                                                      Fix fix)

Helper to create a Description for the common case where there is a fix.

describeMatch

@CheckReturnValue
protected Description describeMatch(com.sun.source.tree.Tree node)

Helper to create a Description for the common case where there is no fix.

describeMatch

@CheckReturnValue
protected Description describeMatch(com.sun.source.tree.Tree node,
                                                      Optional<? extends Fix> fix)

Helper to create a Description for the common case where there is an Optional fix.

buildDescription

@CheckReturnValue
protected Description.Builder buildDescription(com.sun.source.tree.Tree node)

Returns a Description builder, which allows you to customize the diagnostic with a custom message or multiple fixes.

buildDescription

@CheckReturnValue
protected Description.Builder buildDescription(com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition position)

Returns a Description builder, which allows you to customize the diagnostic with a custom message or multiple fixes.

buildDescription

@CheckReturnValue
protected Description.Builder buildDescription(com.sun.tools.javac.tree.JCTree tree)

Returns a Description builder, which allows you to customize the diagnostic with a custom message or multiple fixes.

buildDescriptionFromChecker

@CheckReturnValue
public static Description.Builder buildDescriptionFromChecker(com.sun.source.tree.Tree node,
                                                                                BugChecker checker)

Returns a new builder for Descriptions.

Parameters:

node - the node where the error is

checker - the BugChecker instance that is producing this Description

buildDescriptionFromChecker

@CheckReturnValue
public static Description.Builder buildDescriptionFromChecker(com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition position,
                                                                                BugChecker checker)

Returns a new builder for Descriptions.

Parameters:

position - the position of the error

checker - the BugChecker instance that is producing this Description

buildDescriptionFromChecker

@CheckReturnValue
public static Description.Builder buildDescriptionFromChecker(com.sun.tools.javac.tree.JCTree tree,
                                                                                BugChecker checker)

Returns a new builder for Descriptions.

Parameters:

tree - the tree where the error is

checker - the BugChecker instance that is producing this Description

canonicalName

public String canonicalName()

Description copied from interface: Suppressible

The canonical name of the check.

Specified by:

canonicalName in interface Suppressible

allNames

public Set<String> allNames()

Description copied from interface: Suppressible

Returns all of the name strings that this checker should respect as part of a @SuppressWarnings annotation.

Specified by:

allNames in interface Suppressible

message

public String message()

defaultSeverity

public BugPattern.SeverityLevel defaultSeverity()

severity

public BugPattern.SeverityLevel severity(Map<String,BugPattern.SeverityLevel> severities)

linkUrl

public String linkUrl()

supportsSuppressWarnings

public boolean supportsSuppressWarnings()

Description copied from interface: Suppressible

Returns true if this checker can be suppressed using @SuppressWarnings.

Specified by:

supportsSuppressWarnings in interface Suppressible

customSuppressionAnnotations

public Set<Class<? extends Annotation>> customSuppressionAnnotations()

Description copied from interface: Suppressible

Returns the custom suppression annotations for this checker, if custom suppression is used.

Specified by:

customSuppressionAnnotations in interface Suppressible

isSuppressed

public boolean isSuppressed(com.sun.source.tree.Tree tree)

Returns true if the given tree is annotated with a @SuppressWarnings that disables this bug checker.

isSuppressed

public boolean isSuppressed(com.sun.tools.javac.code.Symbol symbol)

Returns true if the given symbol is annotated with a @SuppressWarnings that disables this bug checker.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object