TypedScope (Closure Compiler v20180506 API)

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

All Implemented Interfaces:

StaticTypedScope<JSType>, StaticScope, TypeIEnv<JSType>, java.io.Serializable
```
public class TypedScope
extends java.lang.Object
implements StaticTypedScope<JSType>, TypeIEnv<JSType>
```
TypedScope contains information about variables and their types. Scopes can be nested, a scope points back to its parent scope.
TypedScope is also used as a lattice element for flow-sensitive type inference. As a lattice element, a scope is viewed as a map from names to types. A name not in the map is considered to have the bottom type. The join of two maps m1 and m2 is the map of the union of names with JSType.getLeastSupertype(com.google.javascript.rhino.jstype.JSType) to meet the m1 type and m2 type.

See Also:

NodeTraversal, Several methods in this class, such as {@code isBlockScope} throw an exception when called. The reason for this is that we want to shadow methods from the parent class, to avoid calling them accidentally., Serialized Form

Method Summary

All Methods Instance 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`	`getClosestContainerScope()` Returns the closest container scope.
`java.lang.Iterable<TypedVar>`	`getDeclarativelyUnboundVarsWithoutTypes()` Returns the variables in this scope that have been declared with 'var' and not declared with a known type.
`int`	`getDepth()` The depth of the scope.
`JSDocInfo`	`getJsdocOfTypeDeclaration(java.lang.String typeName)` Returns the jsdoc at the definition site of the type represented by typeName.
`JSType`	`getNamespaceOrTypedefType(java.lang.String typeName)` Given the name of a namespace, returns its type.
`V`	`getOwnSlot(java.lang.String name)` Like `getSlot` but does not recurse into parent scopes.
`TypedScope`	`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.
`JSType`	`getTypeOfThis()` Gets the type of `this` in the current scope.
`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`	`hasOwnSlot(java.lang.String name)` Returns true if a variable is declared in this scope, with no recursion.
`boolean`	`hasSlot(java.lang.String name)` Returns true if a variable is declared in this or any parent scope.
`boolean`	`isBlockScope()`
`boolean`	`isCatchScope()`
`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

Methods inherited from interface com.google.javascript.rhino.jstype.StaticTypedScope
getOwnSlot, getParentScope, getSlot

Methods inherited from interface com.google.javascript.rhino.StaticScope
getRootNode

- Method Detail
  - typed
```
public TypedScope typed()
```
  - getDepth
```
public int getDepth()
```
    The depth of the scope. The global scope has depth 0.
  - getParent
```
public TypedScope getParent()
```
    Returns the parent scope, or null if this is the global scope.
  - getTypeOfThis
```
public JSType getTypeOfThis()
```
    Gets the type of this in the current scope.
    
    Specified by:
    
    getTypeOfThis in interface StaticTypedScope<JSType>
  - getDeclarativelyUnboundVarsWithoutTypes
```
public java.lang.Iterable<TypedVar> getDeclarativelyUnboundVarsWithoutTypes()
```
    Returns the variables in this scope that have been declared with 'var' and not declared with a known type. These variables can safely be set to undefined (rather than unknown) at the start of type inference, and will be reset to the correct type when analyzing the first assignment to them. Parameters and externs are excluded because they are not initialized in the function body, and lexically-bound variables (let and const) are excluded because they are initialized when inferring the LET/CONST node, which is guaranteed to occur before any use, since they are not hoisted.
  - getNamespaceOrTypedefType
```
public JSType getNamespaceOrTypedefType(java.lang.String typeName)
```
    Description copied from interface: TypeIEnv
    
    Given the name of a namespace, returns its type. For example, if you pass Foo to this method, you get the Foo constructor. This is in contrast to TypeIRegistry#getType, where you would get the Foo instance.
    
    Specified by:
    
    getNamespaceOrTypedefType in interface TypeIEnv<JSType>
  - getJsdocOfTypeDeclaration
```
public JSDocInfo getJsdocOfTypeDeclaration(java.lang.String typeName)
```
    Description copied from interface: TypeIEnv
    
    Returns the jsdoc at the definition site of the type represented by typeName.
    
    Specified by:
    
    getJsdocOfTypeDeclaration in interface TypeIEnv<JSType>
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - untyped
```
public Scope untyped()
```
  - 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
  - hasOwnSlot
```
public final boolean hasOwnSlot(java.lang.String name)
```
    Returns true if a variable is declared in this scope, with no recursion.
  - hasSlot
```
public final boolean hasSlot(java.lang.String name)
```
    Returns true if a variable is declared in this or any parent scope.
  - 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()
```
  - getClosestContainerScope
```
public final S getClosestContainerScope()
```
    Returns the closest container scope. This is equivalent to what the current scope would have been for non-ES6 scope creators, and is thus useful for migrating code to use block scopes.

Class TypedScope

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.javascript.rhino.jstype.StaticTypedScope

Methods inherited from interface com.google.javascript.rhino.StaticScope

Method Detail

typed

getDepth

getParent

getTypeOfThis

getDeclarativelyUnboundVarsWithoutTypes

getNamespaceOrTypedefType

getJsdocOfTypeDeclaration

toString

untyped

getRootNode

getParentScope

getSlot

getOwnSlot

getVar

getArgumentsVar

hasOwnSlot

hasSlot

getVarIterable

getAllAccessibleVariables

getAllSymbols

getVarCount

isGlobal

isLocal

isBlockScope

isFunctionBlockScope

isFunctionScope

isModuleScope

isCatchScope

getClosestContainerScope