Package com.google.errorprone.bugpatterns.checkreturnvalue

Class ResultUseRule.GlobalRule

java.lang.Object

com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule

com.google.errorprone.bugpatterns.checkreturnvalue.ResultUseRule.GlobalRule

Enclosing class:

ResultUseRule

public abstract static class ResultUseRule.GlobalRule
extends ResultUseRule

A global rule that is evaluated when none of the more specific rules determine a ResultUsePolicy for a method.

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

Constructor Summary

Constructors

Constructor	Description
GlobalRule()

Method Summary

Modifier and Type	Method	Description
abstract Optional<ResultUsePolicy>	evaluate(boolean constructor, VisitorState state)	Optionally returns a global policy for methods or constructors.
Optional<ResultUsePolicy>	evaluate(com.sun.tools.javac.code.Symbol symbol, VisitorState state)	Evaluates the given symbol 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

GlobalRule

public GlobalRule()

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

evaluate

public abstract Optional<ResultUsePolicy> evaluate(boolean constructor,
                                                   VisitorState state)

Optionally returns a global policy for methods or constructors.

evaluate

public final Optional<ResultUsePolicy> evaluate(com.sun.tools.javac.code.Symbol symbol,
                                                VisitorState state)

Description copied from class: ResultUseRule

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

Specified by:

evaluate in class ResultUseRule