Package com.google.errorprone.bugpatterns

Class MustBeClosedChecker

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.AbstractMustBeClosedChecker

com.google.errorprone.bugpatterns.MustBeClosedChecker

All Implemented Interfaces:

BugChecker.ClassTreeMatcher, BugChecker.MethodTreeMatcher, Suppressible, Serializable

public class MustBeClosedChecker
extends AbstractMustBeClosedChecker
implements BugChecker.MethodTreeMatcher, BugChecker.ClassTreeMatcher

Checks if a constructor or method annotated with MustBeClosed is called within the resource variable initializer of a try-with-resources statement.

See Also:

• Serialized Form

Nested Class Summary

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

AbstractMustBeClosedChecker.Change

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,P>, 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 inherited from class com.google.errorprone.bugpatterns.AbstractMustBeClosedChecker

HAS_MUST_BE_CLOSED_ANNOTATION

Constructor Summary

Constructors

Constructor	Description
MustBeClosedChecker()

Method Summary

Modifier and Type	Method	Description
Description	matchClass(com.sun.source.tree.ClassTree tree, VisitorState state)
Description	matchMethod(com.sun.source.tree.MethodTree tree, VisitorState state)	Check that the MustBeClosed annotation is only used for constructors of AutoCloseables and methods that return an AutoCloseable.

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

exemptChange, fix, scanEntireMethodFor

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

Methods inherited from interface com.google.errorprone.matchers.Suppressible

allNames, canonicalName, customSuppressionAnnotations, supportsSuppressWarnings, suppressedByAnyOf

Constructor Details

MustBeClosedChecker

public MustBeClosedChecker()

Method Details

matchMethod

public Description matchMethod(com.sun.source.tree.MethodTree tree,
 VisitorState state)

Check that the MustBeClosed annotation is only used for constructors of AutoCloseables and methods that return an AutoCloseable.

Specified by:

matchMethod in interface BugChecker.MethodTreeMatcher

matchClass

public Description matchClass(com.sun.source.tree.ClassTree tree,
 VisitorState state)

Specified by:

matchClass in interface BugChecker.ClassTreeMatcher