Package com.google.errorprone.bugpatterns

Class CheckReturnValue

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.AbstractReturnValueIgnored

com.google.errorprone.bugpatterns.CheckReturnValue

All Implemented Interfaces:

BugChecker.ClassTreeMatcher, BugChecker.MemberReferenceTreeMatcher, BugChecker.MethodInvocationTreeMatcher, BugChecker.MethodTreeMatcher, BugChecker.NewClassTreeMatcher, BugChecker.ReturnTreeMatcher, Suppressible, Serializable

public class CheckReturnValue
extends AbstractReturnValueIgnored
implements BugChecker.MethodTreeMatcher, BugChecker.ClassTreeMatcher

Author:

[email protected] (Eddie Aftandilian)

See Also:

Serialized Form

Nested Class Summary

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<A extends Object,B extends Object>, BugChecker.SwitchTreeMatcher, BugChecker.SynchronizedTreeMatcher, BugChecker.ThrowTreeMatcher, BugChecker.TryTreeMatcher, BugChecker.TypeCastTreeMatcher, BugChecker.TypeParameterTreeMatcher, BugChecker.UnaryTreeMatcher, BugChecker.UnionTypeTreeMatcher, BugChecker.VariableTreeMatcher, BugChecker.WhileLoopTreeMatcher, BugChecker.WildcardTreeMatcher

Constructor Summary

Constructors

Constructor	Description
CheckReturnValue(ErrorProneFlags flags)

Method Summary

Modifier and Type	Method	Description
protected Description	describeReturnValueIgnored(com.sun.source.tree.NewClassTree newClassTree, VisitorState state)	Uses the default description for results ignored via a constructor call.
com.google.common.collect.ImmutableMap<String,?>	getMatchMetadata(com.sun.source.tree.ExpressionTree tree, VisitorState state)	Returns a map of optional metadata about why this check matched the given tree.
protected String	getMessage(Name name)	Returns the diagnostic message.
boolean	isCovered(com.sun.source.tree.ExpressionTree tree, VisitorState state)	Returns whether this checker makes any determination about whether the given tree's return value should be used or not.
Description	matchClass(com.sun.source.tree.ClassTree tree, VisitorState state)	Validate that at most one of CheckReturnValue and CanIgnoreReturnValue are applied to a class (or interface or enum).
Description	matchMethod(com.sun.source.tree.MethodTree tree, VisitorState state)	Validate @CheckReturnValue and CanIgnoreReturnValue usage on methods.
Matcher<com.sun.source.tree.ExpressionTree>	specializedMatcher()	Return a matcher for method invocations in which the method being called should be considered must-be-used.

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

allowInExceptionThrowers, describeReturnValueIgnored, describeReturnValueIgnored, isCheckReturnValue, lostType, lostTypeMessage, matchMemberReference, matchMethodInvocation, matchNewClass, matchReturn

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 Detail

CheckReturnValue

public CheckReturnValue(ErrorProneFlags flags)

Method Detail

specializedMatcher

public Matcher<com.sun.source.tree.ExpressionTree> specializedMatcher()

Return a matcher for method invocations in which the method being called should be considered must-be-used.

Specified by:

specializedMatcher in class AbstractReturnValueIgnored

isCovered

public boolean isCovered(com.sun.source.tree.ExpressionTree tree,
                         VisitorState state)

Description copied from class: AbstractReturnValueIgnored

Returns whether this checker makes any determination about whether the given tree's return value should be used or not. Most checkers either determine that an expression is CRV or make no determination.

Overrides:

isCovered in class AbstractReturnValueIgnored

getMatchMetadata

public com.google.common.collect.ImmutableMap<String,?> getMatchMetadata(com.sun.source.tree.ExpressionTree tree,
                                                                               VisitorState state)

Description copied from class: AbstractReturnValueIgnored

Returns a map of optional metadata about why this check matched the given tree.

Overrides:

getMatchMetadata in class AbstractReturnValueIgnored

matchMethod

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

Validate @CheckReturnValue and CanIgnoreReturnValue usage on methods.

The annotations should not both be applied to the same method.

The annotations should not be applied to void-returning methods. Doing so makes no sense, because there is no return value to check.

Specified by:

matchMethod in interface BugChecker.MethodTreeMatcher

matchClass

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

Validate that at most one of CheckReturnValue and CanIgnoreReturnValue are applied to a class (or interface or enum).

Specified by:

matchClass in interface BugChecker.ClassTreeMatcher

getMessage

protected String getMessage(Name name)

Description copied from class: AbstractReturnValueIgnored

Returns the diagnostic message. Can be overridden by subclasses to provide a customized diagnostic that includes the name of the invoked method.

Overrides:

getMessage in class AbstractReturnValueIgnored

describeReturnValueIgnored

protected Description describeReturnValueIgnored(com.sun.source.tree.NewClassTree newClassTree,
                                                 VisitorState state)

Description copied from class: AbstractReturnValueIgnored

Uses the default description for results ignored via a constructor call. Subclasses may override if they prefer a different description.

Overrides:

describeReturnValueIgnored in class AbstractReturnValueIgnored