com.google.javascript.jscomp

Class ConformanceRules.AbstractRule

java.lang.Object

com.google.javascript.jscomp.ConformanceRules.AbstractRule

Direct Known Subclasses:

ConformanceRules.BanExpose, ConformanceRules.BanGlobalVars, ConformanceRules.BanNullDeref, ConformanceRules.BanThrowOfNonErrorTypes, ConformanceRules.BanUnknownDirectThisPropsReferences, ConformanceRules.BanUnknownThis, ConformanceRules.BanUnknownTypedClassPropsReferences, ConformanceRules.BanUnresolvedType, ConformanceRules.NoImplicitlyPublicDecls, ConformanceRules.RequireFileoverviewVisibility, ConformanceRules.RequireUseStrict

Enclosing class:

ConformanceRules

public abstract static class ConformanceRules.AbstractRule
extends Object

A conformance rule implementation to support things common to all rules such as whitelisting and reporting.

Constructor Summary

Constructors

Constructor and Description
AbstractRule(AbstractCompiler compiler, Requirement requirement)

Method Summary

Modifier and Type	Method and Description
void	check(NodeTraversal t, Node n)
protected abstract ConformanceRules.ConformanceResult	checkConformance(NodeTraversal t, Node n)
protected void	report(NodeTraversal t, Node n, ConformanceRules.ConformanceResult result) Report a conformance warning for the given node.
protected boolean	shouldCheckConformance(Node n)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRule

public AbstractRule(AbstractCompiler compiler,
                    Requirement requirement)
             throws InvalidRequirementSpec

Throws:

InvalidRequirementSpec

Method Detail

checkConformance

protected abstract ConformanceRules.ConformanceResult checkConformance(NodeTraversal t,
                                                                       Node n)

Returns:

Whether the code represented by the Node conforms to the rule.

shouldCheckConformance

protected final boolean shouldCheckConformance(Node n)

Returns:

Whether the specified Node should be checked for conformance, according to this rule's whitelist configuration.

check

public final void check(NodeTraversal t,
                        Node n)

report

protected void report(NodeTraversal t,
                      Node n,
                      ConformanceRules.ConformanceResult result)

Report a conformance warning for the given node.

Parameters:

n - The node representing the violating code.

result - The result representing the confidence of the violation.