Package com.google.errorprone.bugpatterns

Class AbstractMustBeClosedChecker

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.AbstractMustBeClosedChecker

All Implemented Interfaces:

Suppressible, Serializable

Direct Known Subclasses:

MustBeClosedChecker, StreamResourceLeak

public abstract class AbstractMustBeClosedChecker
extends BugChecker

An abstract check for resources that must be closed; used by StreamResourceLeak and MustBeClosedChecker.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractMustBeClosedChecker.Change	Error Prone's fix application logic doesn't like it when a fix suggests multiple identical insertions at the same position.

Nested classes/interfaces inherited from class com.google.errorprone.bugpatterns.BugChecker

BugChecker.AnnotatedTypeTreeMatcher, BugChecker.AnnotationTreeMatcher, BugChecker.ArrayAccessTreeMatcher, BugChecker.ArrayTypeTreeMatcher, BugChecker.AssertTreeMatcher, BugChecker.AssignmentTreeMatcher, BugChecker.BinaryTreeMatcher, BugChecker.BlockTreeMatcher, BugChecker.BreakTreeMatcher, BugChecker.CaseTreeMatcher, BugChecker.CatchTreeMatcher, BugChecker.ClassTreeMatcher, BugChecker.CompilationUnitTreeMatcher, BugChecker.CompoundAssignmentTreeMatcher, BugChecker.ConditionalExpressionTreeMatcher, BugChecker.ContinueTreeMatcher, BugChecker.DoWhileLoopTreeMatcher, BugChecker.EmptyStatementTreeMatcher, BugChecker.EnhancedForLoopTreeMatcher, BugChecker.ExpressionStatementTreeMatcher, BugChecker.ForLoopTreeMatcher, BugChecker.IdentifierTreeMatcher, BugChecker.IfTreeMatcher, BugChecker.ImportTreeMatcher, BugChecker.InstanceOfTreeMatcher, BugChecker.IntersectionTypeTreeMatcher, BugChecker.LabeledStatementTreeMatcher, BugChecker.LambdaExpressionTreeMatcher, BugChecker.LiteralTreeMatcher, BugChecker.MemberReferenceTreeMatcher, BugChecker.MemberSelectTreeMatcher, BugChecker.MethodInvocationTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.ModifiersTreeMatcher, BugChecker.NewArrayTreeMatcher, BugChecker.NewClassTreeMatcher, BugChecker.ParameterizedTypeTreeMatcher, BugChecker.ParenthesizedTreeMatcher, BugChecker.PrimitiveTypeTreeMatcher, BugChecker.ReturnTreeMatcher, BugChecker.SuppressibleTreePathScanner<R extends Object,P extends Object>, BugChecker.SwitchTreeMatcher, BugChecker.SynchronizedTreeMatcher, BugChecker.ThrowTreeMatcher, BugChecker.TryTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.TypeParameterTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.UnionTypeTreeMatcher, BugChecker.VariableTreeMatcher, BugChecker.WhileLoopTreeMatcher, BugChecker.WildcardTreeMatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Matcher<com.sun.source.tree.Tree>	HAS_MUST_BE_CLOSED_ANNOTATION	Matches trees annotated with MustBeClosed.

Constructor Summary

Constructors

Constructor	Description
AbstractMustBeClosedChecker()

Method Summary

Modifier and Type	Method	Description
protected boolean	exemptChange(com.sun.source.tree.ExpressionTree tree, VisitorState state)
protected Optional<AbstractMustBeClosedChecker.Change>	fix(com.sun.source.tree.ExpressionTree tree, VisitorState state, com.google.errorprone.bugpatterns.AbstractMustBeClosedChecker.NameSuggester suggester)
protected Description	scanEntireMethodFor(Matcher<? super com.sun.source.tree.ExpressionTree> matcher, com.sun.source.tree.MethodTree tree, VisitorState state)	Scans a method body for invocations matching matcher, emitting them as a single fix.

Methods inherited from class com.google.errorprone.bugpatterns.BugChecker

allNames, buildDescription, buildDescription, buildDescription, canonicalName, customSuppressionAnnotations, defaultSeverity, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, describeMatch, disableable, equals, hashCode, isSuppressed, isSuppressed, isSuppressed, isSuppressed, linkUrl, message, supportsSuppressWarnings, suppressedByAnyOf, suppressedRegions

Methods inherited from class java.lang.Object

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

Field Details

HAS_MUST_BE_CLOSED_ANNOTATION

protected static final Matcher<com.sun.source.tree.Tree> HAS_MUST_BE_CLOSED_ANNOTATION

Matches trees annotated with MustBeClosed.

Constructor Details

AbstractMustBeClosedChecker

public AbstractMustBeClosedChecker()

Method Details

scanEntireMethodFor

protected Description scanEntireMethodFor(Matcher<? super com.sun.source.tree.ExpressionTree> matcher,
 com.sun.source.tree.MethodTree tree,
 VisitorState state)

Scans a method body for invocations matching matcher, emitting them as a single fix.

exemptChange

@ForOverride
protected boolean exemptChange(com.sun.source.tree.ExpressionTree tree,
 VisitorState state)

fix

protected Optional<AbstractMustBeClosedChecker.Change> fix(com.sun.source.tree.ExpressionTree tree,
 VisitorState state,
 com.google.errorprone.bugpatterns.AbstractMustBeClosedChecker.NameSuggester suggester)