com.google.javascript.jscomp

Class SymbolTable.Symbol

java.lang.Object

com.google.javascript.rhino.jstype.SimpleSlot

com.google.javascript.jscomp.SymbolTable.Symbol

All Implemented Interfaces:

StaticTypedSlot<JSType>, StaticSlot, java.io.Serializable

Enclosing class:

SymbolTable

public static final class SymbolTable.Symbol
extends SimpleSlot

A symbol-table entry

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private SymbolTable.Reference	declaration
private JSDocInfo	docInfo
private SymbolTable.SymbolScope	docScope
private SymbolTable.SymbolScope	propertyScope
private java.util.Map<Node,SymbolTable.Reference>	references
private SymbolTable.SymbolScope	scope
private JSDocInfo.Visibility	visibility Stored separately from docInfo, because the visibility stored in JSDocInfo is not necessarily authoritative.

Constructor Summary

Constructors

Constructor and Description
Symbol(java.lang.String name, JSType type, boolean inferred, SymbolTable.SymbolScope scope)

Method Summary

Modifier and Type	Method and Description
SymbolTable.Reference	defineReferenceAt(Node n)
SymbolTable.Reference	getDeclaration() Gets the declaration of this symbol.
Node	getDeclarationNode()
FunctionType	getFunctionType()
JSDocInfo	getJSDocInfo() Gets the JSDoc for this slot.
SymbolTable.SymbolScope	getPropertyScope()
java.lang.String	getSourceFileName()
JSDocInfo.Visibility	getVisibility()
boolean	isDocOnlyParameter() Whether this is a variable that's only in JSDoc.
boolean	isLexicalVariable() Whether this is a variable in a lexical scope.
boolean	isProperty() Whether this is a property of another variable.
(package private) void	setDeclaration(SymbolTable.Reference ref) Sets the declaration node.
(package private) void	setJSDocInfo(JSDocInfo info)
(package private) void	setPropertyScope(SymbolTable.SymbolScope scope)
(package private) void	setVisibility(JSDocInfo.Visibility v)
java.lang.String	toString()

Methods inherited from class com.google.javascript.rhino.jstype.SimpleSlot

getName, getType, isTypeInferred

Methods inherited from class java.lang.Object

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

Field Detail

references

private final java.util.Map<Node,SymbolTable.Reference> references

scope

private final SymbolTable.SymbolScope scope

propertyScope

private SymbolTable.SymbolScope propertyScope

declaration

private SymbolTable.Reference declaration

docInfo

private JSDocInfo docInfo

visibility

@Nullable
private JSDocInfo.Visibility visibility

Stored separately from docInfo, because the visibility stored in JSDocInfo is not necessarily authoritative.

docScope

private SymbolTable.SymbolScope docScope

Constructor Detail

Symbol

Symbol(java.lang.String name,
       JSType type,
       boolean inferred,
       SymbolTable.SymbolScope scope)

Method Detail

getDeclaration

public SymbolTable.Reference getDeclaration()

Description copied from interface: StaticTypedSlot

Gets the declaration of this symbol. May not exist.

Specified by:

getDeclaration in interface StaticTypedSlot<JSType>

Specified by:

getDeclaration in interface StaticSlot

Overrides:

getDeclaration in class SimpleSlot

getFunctionType

public FunctionType getFunctionType()

defineReferenceAt

public SymbolTable.Reference defineReferenceAt(Node n)

setDeclaration

void setDeclaration(SymbolTable.Reference ref)

Sets the declaration node. May only be called once.

getDeclarationNode

public Node getDeclarationNode()

getSourceFileName

public java.lang.String getSourceFileName()

getPropertyScope

public SymbolTable.SymbolScope getPropertyScope()

setPropertyScope

void setPropertyScope(SymbolTable.SymbolScope scope)

getJSDocInfo

public JSDocInfo getJSDocInfo()

Description copied from interface: StaticSlot

Gets the JSDoc for this slot.

Specified by:

getJSDocInfo in interface StaticSlot

Overrides:

getJSDocInfo in class SimpleSlot

setJSDocInfo

void setJSDocInfo(JSDocInfo info)

getVisibility

@Nullable
public JSDocInfo.Visibility getVisibility()

setVisibility

void setVisibility(JSDocInfo.Visibility v)

isProperty

public boolean isProperty()

Whether this is a property of another variable.

isLexicalVariable

public boolean isLexicalVariable()

Whether this is a variable in a lexical scope.

isDocOnlyParameter

public boolean isDocOnlyParameter()

Whether this is a variable that's only in JSDoc.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object