TypedScope (Closure Compiler v20170910 API)

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

All Implemented Interfaces:

StaticTypedScope<JSType>, StaticScope, TypeIEnv<JSType>, Serializable
```
public class TypedScope
extends Scope
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

Field Summary
- Fields inherited from class com.google.javascript.jscomp.Scope
  depth, rootNode

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterable<TypedVar>`	`getAllSymbols()`
`Var`	`getArgumentsVar()` Get a unique VAR object to represents "arguments" within this scope
`Scope`	`getClosestHoistScope()` If a var were declared in this scope, return the scope it would be hoisted to.
`Iterable<TypedVar>`	`getDeclarativelyUnboundVarsWithoutTypes()`
`int`	`getDepth()` The depth of the scope.
`JSDocInfo`	`getJsdocOfTypeDeclaration(String typeName)` Returns the jsdoc at the definition site of the type represented by typeName.
`JSType`	`getNamespaceOrTypedefType(String typeName)` Given the name of a namespace, returns its type.
`TypedVar`	`getOwnSlot(String name)` Like `getSlot` but does not recurse into parent scopes.
`TypedScope`	`getParent()`
`StaticTypedScope<JSType>`	`getParentScope()` Returns the scope enclosing this one or null if none.
`Node`	`getRootNode()` Gets the container node of the scope.
`TypedVar`	`getSlot(String name)` Returns any defined slot within this scope for this name.
`TypeI`	`getTypeIOfThis()` Returns the expected type of `this` in the current scope as a `TypeI`.
`JSType`	`getTypeOfThis()` Gets the type of `this` in the current scope.
`TypedVar`	`getVar(String name)` Returns the variable, may be null
`int`	`getVarCount()` Returns number of variables in this scope (excluding the special 'arguments' variable)
`Iterable<TypedVar>`	`getVarIterable()` Return an iterable over all of the variables declared in this scope (except the special 'arguments' variable).
`boolean`	`isBlockScope()`
`boolean`	`isDeclared(String name, boolean recurse)` Returns true if a variable is declared.
`boolean`	`isDeclaredInFunctionBlockOrParameter(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`	`isGlobal()` Returns whether this is the global scope.
`boolean`	`isLocal()` Returns whether this is a local scope (i.e.

Methods inherited from class com.google.javascript.jscomp.Scope
getAllAccessibleVariables, isCatchScope, isFunctionScope, isHoistScopeRootNode, isModuleScope, toString

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

- Method Detail
  - getDepth
```
public int getDepth()
```
    Description copied from class: Scope
    
    The depth of the scope. The global scope has depth 0.
    
    Overrides:
    
    getDepth in class Scope
  - getRootNode
```
public Node getRootNode()
```
    Description copied from class: Scope
    
    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
    
    Overrides:
    
    getRootNode in class Scope
  - getParent
```
public TypedScope getParent()
```
    Overrides:
    
    getParent in class Scope
  - getParentScope
```
public StaticTypedScope<JSType> getParentScope()
```
    Description copied from interface: StaticScope
    
    Returns the scope enclosing this one or null if none.
    
    Specified by:
    
    getParentScope in interface StaticTypedScope<JSType>
    
    Specified by:
    
    getParentScope in interface StaticScope
    
    Overrides:
    
    getParentScope in class Scope
  - getTypeOfThis
```
public JSType getTypeOfThis()
```
    Gets the type of this in the current scope.
    
    Specified by:
    
    getTypeOfThis in interface StaticTypedScope<JSType>
  - getTypeIOfThis
```
public final TypeI getTypeIOfThis()
```
    Description copied from interface: StaticTypedScope
    
    Returns the expected type of this in the current scope as a TypeI.
    
    Specified by:
    
    getTypeIOfThis in interface StaticTypedScope<JSType>
  - getSlot
```
public TypedVar getSlot(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 StaticTypedScope<JSType>
    
    Specified by:
    
    getSlot in interface StaticScope
    
    Overrides:
    
    getSlot in class Scope
    
    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 TypedVar getOwnSlot(String name)
```
    Description copied from interface: StaticScope
    
    Like getSlot but does not recurse into parent scopes.
    
    Specified by:
    
    getOwnSlot in interface StaticTypedScope<JSType>
    
    Specified by:
    
    getOwnSlot in interface StaticScope
    
    Overrides:
    
    getOwnSlot in class Scope
  - getVar
```
public TypedVar getVar(String name)
```
    Description copied from class: Scope
    
    Returns the variable, may be null
    
    Overrides:
    
    getVar in class Scope
  - getArgumentsVar
```
public Var getArgumentsVar()
```
    Description copied from class: Scope
    
    Get a unique VAR object to represents "arguments" within this scope
    
    Overrides:
    
    getArgumentsVar in class Scope
  - isDeclaredInFunctionBlockOrParameter
```
public boolean isDeclaredInFunctionBlockOrParameter(String name)
```
    Description copied from class: Scope
    
    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
    
    Overrides:
    
    isDeclaredInFunctionBlockOrParameter in class Scope
  - isDeclared
```
public boolean isDeclared(String name,
                          boolean recurse)
```
    Description copied from class: Scope
    
    Returns true if a variable is declared.
    
    Overrides:
    
    isDeclared in class Scope
  - getVarIterable
```
public Iterable<TypedVar> getVarIterable()
```
    Description copied from class: Scope
    
    Return an iterable over all of the variables declared in this scope (except the special 'arguments' variable).
    
    Overrides:
    
    getVarIterable in class Scope
  - getAllSymbols
```
public Iterable<TypedVar> getAllSymbols()
```
    Overrides:
    
    getAllSymbols in class Scope
  - getVarCount
```
public int getVarCount()
```
    Description copied from class: Scope
    
    Returns number of variables in this scope (excluding the special 'arguments' variable)
    
    Overrides:
    
    getVarCount in class Scope
  - isGlobal
```
public boolean isGlobal()
```
    Description copied from class: Scope
    
    Returns whether this is the global scope.
    
    Overrides:
    
    isGlobal in class Scope
  - isLocal
```
public boolean isLocal()
```
    Description copied from class: Scope
    
    Returns whether this is a local scope (i.e. not the global scope).
    
    Overrides:
    
    isLocal in class Scope
  - getDeclarativelyUnboundVarsWithoutTypes
```
public Iterable<TypedVar> getDeclarativelyUnboundVarsWithoutTypes()
```
  - isBlockScope
```
public boolean isBlockScope()
```
    Overrides:
    
    isBlockScope in class Scope
  - isFunctionBlockScope
```
public boolean isFunctionBlockScope()
```
    Overrides:
    
    isFunctionBlockScope in class Scope
  - getClosestHoistScope
```
public Scope getClosestHoistScope()
```
    Description copied from class: Scope
    
    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.
    
    Overrides:
    
    getClosestHoistScope in class Scope
  - getNamespaceOrTypedefType
```
public JSType getNamespaceOrTypedefType(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(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>

Class TypedScope

Field Summary

Fields inherited from class com.google.javascript.jscomp.Scope

Method Summary

Methods inherited from class com.google.javascript.jscomp.Scope

Methods inherited from class java.lang.Object

Method Detail

getDepth

getRootNode

getParent

getParentScope

getTypeOfThis

getTypeIOfThis

getSlot

getOwnSlot

getVar

getArgumentsVar

isDeclaredInFunctionBlockOrParameter

isDeclared

getVarIterable

getAllSymbols

getVarCount

isGlobal

isLocal

getDeclarativelyUnboundVarsWithoutTypes

isBlockScope

isFunctionBlockScope

getClosestHoistScope

getNamespaceOrTypedefType

getJsdocOfTypeDeclaration