Class ExternalCanIgnoreReturnValue
- java.lang.Object
-
- com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule
-
- com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule.MethodRule
-
- com.google.errorprone.bugpatterns.checkreturnvalue.ExternalCanIgnoreReturnValue
-
public final class ExternalCanIgnoreReturnValue extends ResultUseRule.MethodRule
External source of information about @CanIgnoreReturnValue-equivalent API's.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule
ResultUseRule.Evaluation, ResultUseRule.GlobalRule, ResultUseRule.MethodRule, ResultUseRule.RuleScope, ResultUseRule.SymbolRule
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<ResultUsePolicy>
evaluateMethod(com.sun.tools.javac.code.Symbol.MethodSymbol method, VisitorState state)
Evaluates the givenmethod
and optionally returns aResultUsePolicy
for it.static ResultUseRule
externalIgnoreList()
Returns a rule using an external list of APIs to ignore.String
id()
An ID for uniquely identifying this rule.static String
methodNameAndParams(com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbol, com.sun.tools.javac.code.Types types)
static String
surroundingClass(com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbol)
-
Methods inherited from class com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule.MethodRule
evaluate, scopes
-
Methods inherited from class com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule
evaluate, toString
-
-
-
-
Method Detail
-
externalIgnoreList
public static ResultUseRule externalIgnoreList()
Returns a rule using an external list of APIs to ignore.
-
id
public String id()
Description copied from class:ResultUseRule
An ID for uniquely identifying this rule.- Specified by:
id
in classResultUseRule
-
evaluateMethod
public Optional<ResultUsePolicy> evaluateMethod(com.sun.tools.javac.code.Symbol.MethodSymbol method, VisitorState state)
Description copied from class:ResultUseRule.MethodRule
Evaluates the givenmethod
and optionally returns aResultUsePolicy
for it.- Specified by:
evaluateMethod
in classResultUseRule.MethodRule
-
surroundingClass
public static String surroundingClass(com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbol)
-
methodNameAndParams
public static String methodNameAndParams(com.sun.tools.javac.code.Symbol.MethodSymbol methodSymbol, com.sun.tools.javac.code.Types types)
-
-