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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
getMessage(Name name)
Returns the diagnostic message.Description
matchClass(ClassTree tree, VisitorState state)
Validate that at most one ofCheckReturnValue
andCanIgnoreReturnValue
are applied to a class (or interface or enum).Description
matchMethod(MethodTree tree, VisitorState state)
Validate@CheckReturnValue
andCanIgnoreReturnValue
usage on methods.Matcher<ExpressionTree>
specializedMatcher()
Return a matcher for method invocations in which the method being called has the@CheckReturnValue
annotation.-
Methods inherited from class com.google.errorprone.bugpatterns.AbstractReturnValueIgnored
allowInExceptionThrowers, describeReturnValueIgnored, describeReturnValueIgnored, describeReturnValueIgnored, 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, 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<ExpressionTree> specializedMatcher()
Return a matcher for method invocations in which the method being called has the@CheckReturnValue
annotation.- Specified by:
specializedMatcher
in classAbstractReturnValueIgnored
-
matchMethod
public Description matchMethod(MethodTree tree, VisitorState state)
Validate@CheckReturnValue
andCanIgnoreReturnValue
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 interfaceBugChecker.MethodTreeMatcher
-
matchClass
public Description matchClass(ClassTree tree, VisitorState state)
Validate that at most one ofCheckReturnValue
andCanIgnoreReturnValue
are applied to a class (or interface or enum).- Specified by:
matchClass
in interfaceBugChecker.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 classAbstractReturnValueIgnored
-
-