Class ExternalCanIgnoreReturnValue

java.lang.Object

com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule<VisitorState, com.sun.tools.javac.code.Symbol>

com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule.MethodRule<VisitorState, com.sun.tools.javac.code.Symbol, com.sun.tools.javac.code.Symbol.MethodSymbol>

com.google.errorprone.bugpatterns.checkreturnvalue.ExternalCanIgnoreReturnValue

public final class ExternalCanIgnoreReturnValue
extends ResultUseRule.MethodRule<VisitorState, com.sun.tools.javac.code.Symbol, com.sun.tools.javac.code.Symbol.MethodSymbol>

External source of information about @CanIgnoreReturnValue-equivalent API's.

Nested Class Summary

Nested classes/interfaces inherited from class ResultUseRule

ResultUseRule.Evaluation<S>, ResultUseRule.GlobalRule<C,S>, ResultUseRule.MethodRule<C,S,M>, ResultUseRule.RuleScope, ResultUseRule.SymbolRule<C,S>

Method Summary

Modifier and Type	Method	Description
Optional<ResultUsePolicy>	evaluateMethod(com.sun.tools.javac.code.Symbol.MethodSymbol method, VisitorState state)	Evaluates the given method and optionally returns a ResultUsePolicy for it.
static ResultUseRule<VisitorState, com.sun.tools.javac.code.Symbol>	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 ResultUseRule.MethodRule

evaluate, scopes

Methods inherited from class ResultUseRule

evaluate, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

externalIgnoreList

public static ResultUseRule<VisitorState, com.sun.tools.javac.code.Symbol> 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 class ResultUseRule<VisitorState, com.sun.tools.javac.code.Symbol>

evaluateMethod

public Optional<ResultUsePolicy> evaluateMethod(com.sun.tools.javac.code.Symbol.MethodSymbol method,
 VisitorState state)

Description copied from class: ResultUseRule.MethodRule

Evaluates the given method and optionally returns a ResultUsePolicy for it.

Specified by:

evaluateMethod in class ResultUseRule.MethodRule<VisitorState, com.sun.tools.javac.code.Symbol, com.sun.tools.javac.code.Symbol.MethodSymbol>

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)