Package com.google.javascript.jscomp.lint

Class CheckEnums

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.lint.CheckEnums

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

public final class CheckEnums
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

Checks the following:

1. Whether there are duplicate values in enums.
2. Whether enum type (and its initializer values) are string/number or not.
3. Whether string enum values are statically initialized or not.

Field Summary

Fields

Modifier and Type	Field	Description
static final DiagnosticType	COMPUTED_PROP_NAME_IN_ENUM
static final DiagnosticType	DUPLICATE_ENUM_VALUE
static final DiagnosticType	ENUM_PROP_NOT_CONSTANT
static final DiagnosticType	ENUM_TYPE_NOT_STRING_OR_NUMBER
static final DiagnosticType	NON_STATIC_INITIALIZER_STRING_VALUE_IN_ENUM
static final DiagnosticType	SHORTHAND_ASSIGNMENT_IN_ENUM

Constructor Summary

Constructors

Constructor	Description
CheckEnums(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method	Description
void	process(Node externs, Node root)	Process the JS with root node root.
void	visit(NodeTraversal t, Node n, Node parent)	Visits a node in postorder (after its children).

Methods inherited from class com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

shouldTraverse

Methods inherited from class java.lang.Object

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

Field Details

DUPLICATE_ENUM_VALUE

public static final DiagnosticType DUPLICATE_ENUM_VALUE

COMPUTED_PROP_NAME_IN_ENUM

public static final DiagnosticType COMPUTED_PROP_NAME_IN_ENUM

SHORTHAND_ASSIGNMENT_IN_ENUM

public static final DiagnosticType SHORTHAND_ASSIGNMENT_IN_ENUM

ENUM_PROP_NOT_CONSTANT

public static final DiagnosticType ENUM_PROP_NOT_CONSTANT

ENUM_TYPE_NOT_STRING_OR_NUMBER

public static final DiagnosticType ENUM_TYPE_NOT_STRING_OR_NUMBER

NON_STATIC_INITIALIZER_STRING_VALUE_IN_ENUM

public static final DiagnosticType NON_STATIC_INITIALIZER_STRING_VALUE_IN_ENUM

Constructor Details

CheckEnums

public CheckEnums(AbstractCompiler compiler)

Method Details

process

public void process(Node externs,
 Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

visit

public void visit(NodeTraversal t,
 Node n,
 Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children). A node is visited in postorder iff NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) returned true for its parent and itself. In particular, the root node is never visited in postorder.

Siblings are always visited left-to-right.

Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.