Scope (Closure Compiler v20180204 API)

java.lang.Object
- com.google.javascript.jscomp.Scope

All Implemented Interfaces:

StaticScope, java.io.Serializable
```
public abstract class Scope
extends java.lang.Object
```
Scope contains information about a variable scope in JavaScript. Scopes can be nested, a scope points back to its parent scope. A Scope contains information about variables defined in that scope.

See Also:

NodeTraversal, Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Iterable<V>`	`getAllAccessibleVariables()` Return an iterable over all of the variables accessible to this scope (i.e.
`java.lang.Iterable<V>`	`getAllSymbols()`
`V`	`getArgumentsVar()` Get a unique VAR object to represent "arguments" within this scope
`S`	`getClosestHoistScope()` If a var were declared in this scope, return the scope it would be hoisted to.
`abstract int`	`getDepth()` The depth of the scope.
`V`	`getOwnSlot(java.lang.String name)` Like `getSlot` but does not recurse into parent scopes.
`abstract S`	`getParent()` Returns the parent scope, or null if this is the global scope.
`S`	`getParentScope()` Returns the scope enclosing this one or null if none.
`Node`	`getRootNode()` Gets the container node of the scope.
`V`	`getSlot(java.lang.String name)` Returns any defined slot within this scope for this name.
`V`	`getVar(java.lang.String name)` Returns the variable, may be null
`int`	`getVarCount()` Returns number of variables in this scope (excluding the special 'arguments' variable)
`java.lang.Iterable<V>`	`getVarIterable()` Return an iterable over all of the variables declared in this scope (except the special 'arguments' variable).
`boolean`	`isBlockScope()`
`boolean`	`isCatchScope()`
`boolean`	`isDeclared(java.lang.String name, boolean recurse)` Returns true if a variable is declared.
`boolean`	`isDeclaredInFunctionBlockOrParameter(java.lang.String name)` Use only when in a function block scope and want to tell if a name is either at the top of the function block scope or the function parameter scope.
`boolean`	`isFunctionBlockScope()`
`boolean`	`isFunctionScope()`
`boolean`	`isGlobal()` Returns whether this is the global scope.
`boolean`	`isLocal()` Returns whether this is a local scope (i.e.
`boolean`	`isModuleScope()`
`java.lang.String`	`toString()`
`TypedScope`	`typed()`
`Scope`	`untyped()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - untyped
```
public Scope untyped()
```
  - getDepth
```
public abstract int getDepth()
```
    The depth of the scope. The global scope has depth 0.
  - getParent
```
public abstract S getParent()
```
    Returns the parent scope, or null if this is the global scope.
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - typed
```
public TypedScope typed()
```
  - getRootNode
```
public Node getRootNode()
```
    Gets the container node of the scope. This is typically the FUNCTION node or the global BLOCK/SCRIPT node.
    
    Specified by:
    
    getRootNode in interface StaticScope
  - getParentScope
```
public final S getParentScope()
```
    Description copied from interface: StaticScope
    
    Returns the scope enclosing this one or null if none.
    
    Specified by:
    
    getParentScope in interface StaticScope
  - getSlot
```
public final V getSlot(java.lang.String name)
```
    Description copied from interface: StaticScope
    
    Returns any defined slot within this scope for this name. This call continues searching through parent scopes if a slot with this name is not found in the current scope.
    
    Specified by:
    
    getSlot in interface StaticScope
    
    Parameters:
    
    name - The name of the variable slot to look up.
    
    Returns:
    
    The defined slot for the variable, or null if no definition exists.
  - getOwnSlot
```
public final V getOwnSlot(java.lang.String name)
```
    Description copied from interface: StaticScope
    
    Like getSlot but does not recurse into parent scopes.
    
    Specified by:
    
    getOwnSlot in interface StaticScope
  - getVar
```
public V getVar(java.lang.String name)
```
    Returns the variable, may be null
  - getArgumentsVar
```
public final V getArgumentsVar()
```
    Get a unique VAR object to represent "arguments" within this scope
  - isDeclaredInFunctionBlockOrParameter
```
public final boolean isDeclaredInFunctionBlockOrParameter(java.lang.String name)
```
    Use only when in a function block scope and want to tell if a name is either at the top of the function block scope or the function parameter scope. This obviously only applies to ES6 block scopes.
  - isDeclared
```
public final boolean isDeclared(java.lang.String name,
                                boolean recurse)
```
    Returns true if a variable is declared.
  - getVarIterable
```
public java.lang.Iterable<V> getVarIterable()
```
    Return an iterable over all of the variables declared in this scope (except the special 'arguments' variable).
  - getAllAccessibleVariables
```
public final java.lang.Iterable<V> getAllAccessibleVariables()
```
    Return an iterable over all of the variables accessible to this scope (i.e. the variables in this scope and its parent scopes). Any variables declared in the local scope with the same name as a variable declared in a parent scope gain precedence - if let x exists in the block scope, a declaration let x from the parent scope would not be included because the parent scope's variable gets shadowed.
    The iterable contains variables from inner scopes before adding variables from outer parent scopes.
    We do not include the special 'arguments' variable.
  - getAllSymbols
```
public java.lang.Iterable<V> getAllSymbols()
```
  - getVarCount
```
public int getVarCount()
```
    Returns number of variables in this scope (excluding the special 'arguments' variable)
  - isGlobal
```
public boolean isGlobal()
```
    Returns whether this is the global scope.
  - isLocal
```
public boolean isLocal()
```
    Returns whether this is a local scope (i.e. not the global scope).
  - isBlockScope
```
public final boolean isBlockScope()
```
  - isFunctionBlockScope
```
public final boolean isFunctionBlockScope()
```
  - isFunctionScope
```
public final boolean isFunctionScope()
```
  - isModuleScope
```
public final boolean isModuleScope()
```
  - isCatchScope
```
public final boolean isCatchScope()
```
  - getClosestHoistScope
```
public final S getClosestHoistScope()
```
    If a var were declared in this scope, return the scope it would be hoisted to. For function scopes, we return back the scope itself, since even though there is no way to declare a var inside function parameters, it would make even less sense to say that such declarations would be "hoisted" somewhere else.

Class Scope

Method Summary

Methods inherited from class java.lang.Object

Method Detail

untyped

getDepth

getParent

toString

typed

getRootNode

getParentScope

getSlot

getOwnSlot

getVar

getArgumentsVar

isDeclaredInFunctionBlockOrParameter

isDeclared

getVarIterable

getAllAccessibleVariables

getAllSymbols

getVarCount

isGlobal

isLocal

isBlockScope

isFunctionBlockScope

isFunctionScope

isModuleScope

isCatchScope

getClosestHoistScope