Package com.google.errorprone.bugpatterns

Class ReturnValueIgnored

java.lang.Object

com.google.errorprone.bugpatterns.BugChecker

com.google.errorprone.bugpatterns.AbstractReturnValueIgnored

com.google.errorprone.bugpatterns.ReturnValueIgnored

All Implemented Interfaces:

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

public class ReturnValueIgnored
extends AbstractReturnValueIgnored

A checker which produces an error when a return value is accidentally discarded.

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
ReturnValueIgnored()
ReturnValueIgnored(ErrorProneFlags flags)

Method Summary

Modifier and Type	Method	Description
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.
Matcher<? super com.sun.source.tree.ExpressionTree>	specializedMatcher()	Match whatever additional conditions concrete subclasses want to match (a list of known side-effect-free methods, has a @CheckReturnValue annotation, etc.).

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

allowInExceptionThrowers, describeReturnValueIgnored, describeReturnValueIgnored, describeReturnValueIgnored, isCheckReturnValue, isCovered, 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

ReturnValueIgnored

public ReturnValueIgnored()

ReturnValueIgnored

public ReturnValueIgnored(ErrorProneFlags flags)

Method Detail

specializedMatcher

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

Description copied from class: AbstractReturnValueIgnored

Match whatever additional conditions concrete subclasses want to match (a list of known side-effect-free methods, has a @CheckReturnValue annotation, etc.).

Specified by:

specializedMatcher 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

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