com.google.javascript.jscomp

Class Var

java.lang.Object

com.google.javascript.jscomp.Var

All Implemented Interfaces:

StaticRef, StaticSlot

Direct Known Subclasses:

TypedVar, Var.Arguments

public class Var
extends java.lang.Object
implements StaticSlot, StaticRef

Used by Scope to store information about variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	Var.Arguments A special subclass of Var used to distinguish "arguments" in the current scope.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	index The index at which the var is declared.
(package private) CompilerInput	input Input source
(package private) java.lang.String	name
(package private) Node	nameNode Var node
(package private) Scope	scope The enclosing scope

Constructor Summary

Constructors

Constructor and Description
Var(java.lang.String name, Node nameNode, Scope scope, int index, CompilerInput input)

Method Summary

Modifier and Type	Method and Description
protected int	declarationType()
boolean	equals(java.lang.Object other)
Var	getDeclaration() Gets the declaration of this symbol.
Node	getInitialValue()
(package private) CompilerInput	getInput()
JSDocInfo	getJSDocInfo() Gets the JSDoc for this slot.
java.lang.String	getName() Gets the name of the slot.
Node	getNameNode()
Node	getNode() The node where the reference lives.
Node	getParentNode()
Scope	getScope()
StaticSourceFile	getSourceFile() The source file where the reference lives.
Var	getSymbol() The variable that this reference points to.
int	hashCode()
boolean	isArguments()
boolean	isBleedingFunction() Whether this is a bleeding function (an anonymous named function that bleeds into the inner scope).
(package private) boolean	isCatch()
(package private) boolean	isClass()
(package private) boolean	isConst()
(package private) boolean	isDefaultParam()
boolean	isDefine() Returns true if the variable is declared as a define.
(package private) boolean	isExtern()
boolean	isGlobal()
boolean	isInferredConst() Returns true if the variable is declared as a constant, based on the value reported by NodeUtil.
(package private) boolean	isLet()
boolean	isLocal()
(package private) boolean	isParam()
(package private) boolean	isVar()
(package private) static Var	makeArgumentsVar(Scope scope)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

final java.lang.String name

nameNode

final Node nameNode

Var node

input

final CompilerInput input

Input source

index

final int index

The index at which the var is declared. e.g. if it's 0, it's the first declared variable in that scope

scope

final Scope scope

The enclosing scope

Constructor Detail

Var

Var(java.lang.String name,
    Node nameNode,
    Scope scope,
    int index,
    CompilerInput input)

Method Detail

makeArgumentsVar

static Var makeArgumentsVar(Scope scope)

getName

public java.lang.String getName()

Description copied from interface: StaticSlot

Gets the name of the slot.

Specified by:

getName in interface StaticSlot

getNode

public Node getNode()

Description copied from interface: StaticRef

The node where the reference lives.

Specified by:

getNode in interface StaticRef

getInput

CompilerInput getInput()

getSourceFile

public StaticSourceFile getSourceFile()

Description copied from interface: StaticRef

The source file where the reference lives.

Specified by:

getSourceFile in interface StaticRef

getSymbol

public Var getSymbol()

Description copied from interface: StaticRef

The variable that this reference points to.

Specified by:

getSymbol in interface StaticRef

getDeclaration

public Var getDeclaration()

Description copied from interface: StaticSlot

Gets the declaration of this symbol. May not exist.

Specified by:

getDeclaration in interface StaticSlot

getParentNode

public Node getParentNode()

isBleedingFunction

public boolean isBleedingFunction()

Whether this is a bleeding function (an anonymous named function that bleeds into the inner scope).

getScope

public Scope getScope()

isGlobal

public boolean isGlobal()

isLocal

public boolean isLocal()

isExtern

boolean isExtern()

isInferredConst

public boolean isInferredConst()

Returns true if the variable is declared as a constant, based on the value reported by NodeUtil.

isDefine

public boolean isDefine()

Returns true if the variable is declared as a define. A variable is a define if it is annotated by @define.

getInitialValue

public Node getInitialValue()

getNameNode

public Node getNameNode()

getJSDocInfo

public JSDocInfo getJSDocInfo()

Description copied from interface: StaticSlot

Gets the JSDoc for this slot.

Specified by:

getJSDocInfo in interface StaticSlot

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isVar

boolean isVar()

isCatch

boolean isCatch()

isLet

boolean isLet()

isConst

boolean isConst()

isClass

boolean isClass()

isParam

boolean isParam()

isDefaultParam

boolean isDefaultParam()

isArguments

public boolean isArguments()

declarationType

protected int declarationType()