Package com.google.errorprone.bugpatterns.checkreturnvalue

Class ResultUseRule.MethodRule<C,S,M extends S>

java.lang.Object

com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule<C,S>

com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule.MethodRule<C,S,M>

Type Parameters:

C - the type of the context object used during evaluation

S - the type of symbols

M - the type of method symbols

Direct Known Subclasses:

ExternalCanIgnoreReturnValue

Enclosing class:

ResultUseRule<C,S>

public abstract static class ResultUseRule.MethodRule<C,S,M extends S>
extends ResultUseRule<C,S>

A rule that evaluates methods and constructors to determine a ResultUsePolicy for them.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MethodRule(Class<M> methodSymbolClass)

Method Summary

Modifier and Type	Method	Description
Optional<ResultUsePolicy>	evaluate(S symbol, C context)	Evaluates the given symbol and optionally returns a ResultUsePolicy for it.
abstract Optional<ResultUsePolicy>	evaluateMethod(M method, C context)	Evaluates the given method and optionally returns a ResultUsePolicy for it.
com.google.common.collect.ImmutableSet<ResultUseRule.RuleScope>	scopes()	The scopes this rule applies to.

Methods inherited from class com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule

evaluate, id, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodRule

protected MethodRule(Class<M> methodSymbolClass)

Method Detail

scopes

public final com.google.common.collect.ImmutableSet<ResultUseRule.RuleScope> scopes()

Description copied from class: ResultUseRule

The scopes this rule applies to.

Specified by:

scopes in class ResultUseRule<C,S>

evaluateMethod

public abstract Optional<ResultUsePolicy> evaluateMethod(M method,
                                                         C context)

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

evaluate

public final Optional<ResultUsePolicy> evaluate(S symbol,
                                                C context)

Description copied from class: ResultUseRule

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

Specified by:

evaluate in class ResultUseRule<C,S>