Package net.sourceforge.pmd.lang.ecmascript.ast

Class ASTObjectLiteral

java.lang.Object

net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?>,EcmascriptNode<?>>

net.sourceforge.pmd.lang.ecmascript.ast.ASTObjectLiteral

All Implemented Interfaces:

GenericNode<EcmascriptNode<?>>, Node, DestructuringNode, EcmascriptNode<org.mozilla.javascript.ast.ObjectLiteral>, TrailingCommaNode, Reportable

public final class ASTObjectLiteral
extends AbstractNode<net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?>,EcmascriptNode<?>>
implements DestructuringNode, TrailingCommaNode

Field Summary

Fields

Modifier and Type	Field	Description
protected T	node

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
protected <P,R> R	acceptJsVisitor(EcmascriptVisitor<? super P,? extends R> visitor, P data)
<P,R> R	acceptVisitor(AstVisitor<? super P,? extends R> visitor, P data)
protected void	addChild(net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?> child, int index)
String	getJsDoc()	Get the JsDoc associated with the given node.
ASTObjectProperty	getObjectProperty(int index)
TextRegion	getTextRegion()
String	getXPathNodeName()
boolean	hasSideEffects()
boolean	isDestructuring()
boolean	isTrailingComma()
protected void	setTrailingCommaExists(boolean b)

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode

children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, insertChild, remove, removeChildAtIndex, setChild, setParent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getRoot, getTextDocument, getUserMap, getXPathAttributesIterator, hasImageEqualTo, isFindBoundary

Field Detail

node

protected final T extends org.mozilla.javascript.ast.AstNode node

Method Detail

acceptJsVisitor

protected <P,R> R acceptJsVisitor(EcmascriptVisitor<? super P,? extends R> visitor,
                                        P data)

getObjectProperty

public ASTObjectProperty getObjectProperty(int index)

isDestructuring

public boolean isDestructuring()

Specified by:

isDestructuring in interface DestructuringNode

isTrailingComma

public boolean isTrailingComma()

Specified by:

isTrailingComma in interface TrailingCommaNode

setTrailingCommaExists

protected void setTrailingCommaExists(boolean b)

addChild

protected void addChild(net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?> child,
                        int index)

Overrides:

addChild in class AbstractNode<net.sourceforge.pmd.lang.ecmascript.ast.AbstractEcmascriptNode<?>,EcmascriptNode<?>>

getTextRegion

public TextRegion getTextRegion()

Specified by:

getTextRegion in interface Node

acceptVisitor

public final <P,R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor,
                                         P data)

Specified by:

acceptVisitor in interface Node

getJsDoc

public String getJsDoc()

Description copied from interface: EcmascriptNode

Get the JsDoc associated with the given node. If there is no JsDoc on this node, it may be associated with a parent node, on more representative of the entire expression containing this node.

Specified by:

getJsDoc in interface EcmascriptNode<T extends org.mozilla.javascript.ast.AstNode>

Returns:

The JsDoc comment for the node, may be null.

hasSideEffects

public boolean hasSideEffects()

Specified by:

hasSideEffects in interface EcmascriptNode<T extends org.mozilla.javascript.ast.AstNode>

getXPathNodeName

public String getXPathNodeName()

Specified by:

getXPathNodeName in interface Node