Package org.mozilla.javascript.ast

Class TemplateLiteral

java.lang.Object

org.mozilla.javascript.Node

org.mozilla.javascript.ast.AstNode

org.mozilla.javascript.ast.TemplateLiteral

All Implemented Interfaces:

Comparable<AstNode>, Iterable<Node>

public class TemplateLiteral
extends AstNode

AST node for a Template literal.

Node type is Token.TEMPLATE_LITERAL.

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ast.AstNode

AstNode.DebugPrintVisitor, AstNode.PositionComparator

Nested classes/interfaces inherited from class org.mozilla.javascript.Node

Node.NodeIterator

Field Summary

Fields inherited from class org.mozilla.javascript.ast.AstNode

inlineComment, length, parent, position

Fields inherited from class org.mozilla.javascript.Node

ARROW_FUNCTION_PROP, ATTRIBUTE_FLAG, BOTH, CASEARRAY_PROP, CATCH_SCOPE_PROP, CONTROL_BLOCK_PROP, DECR_FLAG, DESCENDANTS_FLAG, DESTRUCTURING_ARRAY_LENGTH, DESTRUCTURING_NAMES, DESTRUCTURING_PARAMS, DIRECTCALL_PROP, END_DROPS_OFF, END_RETURNS, END_RETURNS_VALUE, END_UNREACHED, END_YIELDS, EXPRESSION_CLOSURE_PROP, first, FUNCTION_PROP, GENERATOR_END_PROP, INCRDECR_PROP, ISNUMBER_PROP, JSDOC_PROP, LABEL_ID_PROP, last, LAST_PROP, LEFT, lineno, LOCAL_BLOCK_PROP, LOCAL_PROP, MEMBER_TYPE_PROP, NAME_PROP, next, NON_SPECIALCALL, OBJECT_IDS_PROP, OBJECT_LITERAL_DESTRUCTURING, OPTIONAL_CHAINING, PARENTHESIZED_PROP, POST_FLAG, PROPERTY_FLAG, propListHead, REGEXP_PROP, RIGHT, SKIP_INDEXES_PROP, SPECIALCALL_EVAL, SPECIALCALL_PROP, SPECIALCALL_WITH, TARGETBLOCK_PROP, TEMPLATE_LITERAL_PROP, TRAILING_COMMA, type, VARIABLE_PROP

Constructor Summary

Constructors

Constructor	Description
TemplateLiteral()
TemplateLiteral(int pos)
TemplateLiteral(int pos, int len)

Method Summary

Modifier and Type	Method	Description
void	addElement(AstNode element)	Adds an element to the list, and sets its parent to this node.
AstNode	getElement(int index)	Returns element at specified index.
List<AstNode>	getElements()	Returns the element list
int	getSize()	Returns the number of elements in this TemplateLiteral literal.
List<AstNode>	getSubstitutions()	Returns a list of all substitutions of this template literal
List<TemplateCharacters>	getTemplateStrings()	Returns a list of all literal sections of this template literal
void	setElements(List<AstNode> elements)	Sets the element list, and sets each element's parent to this node.
String	toSource(int depth)	Emits source code for this node.
void	visit(NodeVisitor v)	Visits this node.

Methods inherited from class org.mozilla.javascript.ast.AstNode

addChild, assertNotNull, codeBug, compareTo, debugPrint, depth, getAbsolutePosition, getAstRoot, getEnclosingFunction, getEnclosingScope, getInlineComment, getLength, getLineno, getParent, getPosition, hasSideEffects, makeIndent, operatorToString, printList, setBounds, setInlineComment, setLength, setParent, setPosition, setRelative, shortName, toSource

Methods inherited from class org.mozilla.javascript.Node

addChildAfter, addChildBefore, addChildrenToBack, addChildrenToFront, addChildToBack, addChildToFront, getBigInt, getChildBefore, getColumn, getDouble, getExistingIntProp, getFirstChild, getIntProp, getJsDoc, getJsDocNode, getLastChild, getLastSibling, getNext, getProp, getScope, getString, getType, hasChildren, hasConsistentReturnUsage, iterator, labelId, labelId, newNumber, newString, newString, newTarget, putIntProp, putProp, removeChild, removeChildren, removeProp, replaceChild, replaceChildAfter, resetTargets, setBigInt, setDouble, setJsDocNode, setLineColumnNumber, setScope, setString, setType, toString, toStringTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

TemplateLiteral

public TemplateLiteral()

TemplateLiteral

public TemplateLiteral(int pos)

TemplateLiteral

public TemplateLiteral(int pos,
 int len)

Method Details

getTemplateStrings

public List<TemplateCharacters> getTemplateStrings()

Returns a list of all literal sections of this template literal

getSubstitutions

public List<AstNode> getSubstitutions()

Returns a list of all substitutions of this template literal

getElements

public List<AstNode> getElements()

Returns the element list

Returns:

the element list. If there are no elements, returns an immutable empty list.

setElements

public void setElements(List<AstNode> elements)

Sets the element list, and sets each element's parent to this node.

Parameters:

elements - the element list. Can be null.

addElement

public void addElement(AstNode element)

Adds an element to the list, and sets its parent to this node.

Parameters:

element - the element to add

Throws:

IllegalArgumentException - if element is null.

getSize

public int getSize()

Returns the number of elements in this TemplateLiteral literal.

getElement

public AstNode getElement(int index)

Returns element at specified index.

Parameters:

index - the index of the element to retrieve

Returns:

the element

Throws:

IndexOutOfBoundsException - if the index is invalid

toSource

public String toSource(int depth)

Description copied from class: AstNode

Emits source code for this node. Callee is responsible for calling this function recursively on children, incrementing indent as appropriate.

Note: if the parser was in error-recovery mode, some AST nodes may have null children that are expected to be non-null when no errors are present. In this situation, the behavior of the toSource method is undefined: toSource implementations may assume that the AST node is error-free, since it is intended to be invoked only at runtime after a successful parse.

Specified by:

toSource in class AstNode

Parameters:

depth - the current recursion depth, typically beginning at 0 when called on the root node.

visit

public void visit(NodeVisitor v)

Visits this node.

Specified by:

visit in class AstNode

Parameters:

v - the object to call with this node and its children