Package com.google.errorprone.bugpatterns.checkreturnvalue

Class ResultUseRule<C,S>

java.lang.Object

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

Type Parameters:

C - the type of the context object used during evaluation

S - the type of symbols

Direct Known Subclasses:

ResultUseRule.GlobalRule, ResultUseRule.MethodRule, ResultUseRule.SymbolRule

public abstract class ResultUseRule<C,S>
extends Object

A rule for determining ResultUsePolicy for methods and/or constructors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResultUseRule.Evaluation<S>	An evaluation that a rule makes.
static class	ResultUseRule.GlobalRule<C,S>	A global rule that is evaluated when none of the more specific rules determine a ResultUsePolicy for a method.
static class	ResultUseRule.MethodRule<C,S,M extends S>	A rule that evaluates methods and constructors to determine a ResultUsePolicy for them.
static class	ResultUseRule.RuleScope	Scope to which a rule may apply.
static class	ResultUseRule.SymbolRule<C,S>	A rule that evaluates symbols of any kind to determine a ResultUsePolicy to associate with them.

Constructor Summary

Constructors

Constructor	Description
ResultUseRule()

Method Summary

Modifier and Type	Method	Description
Optional<ResultUseRule.Evaluation<S>>	evaluate(ResultUseRule.RuleScope scope, S symbol, C context)	Evaluates the given symbol and optionally returns an ResultUseRule.Evaluation of it.
abstract Optional<ResultUsePolicy>	evaluate(S symbol, C context)	Evaluates the given symbol and optionally returns a ResultUsePolicy for it.
abstract String	id()	An ID for uniquely identifying this rule.
abstract com.google.common.collect.ImmutableSet<ResultUseRule.RuleScope>	scopes()	The scopes this rule applies to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultUseRule

public ResultUseRule()

Method Detail

id

public abstract String id()

An ID for uniquely identifying this rule.

scopes

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

The scopes this rule applies to.

evaluate

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

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

evaluate

public final Optional<ResultUseRule.Evaluation<S>> evaluate(ResultUseRule.RuleScope scope,
                                                            S symbol,
                                                            C context)

Evaluates the given symbol and optionally returns an ResultUseRule.Evaluation of it.

toString

public final String toString()

Overrides:

toString in class Object