Package net.sourceforge.pmd.lang.ast.impl.antlr4

Class BaseAntlrInnerNode<N extends AntlrNode<N>>

java.lang.Object

net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode<BaseAntlrInnerNode.PmdAsAntlrInnerNode<N>,N>

net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrInnerNode<N>

All Implemented Interfaces:

AntlrNode<N>, GenericNode<N>, Node, Reportable

public abstract class BaseAntlrInnerNode<N extends AntlrNode<N>>
extends BaseAntlrNode<BaseAntlrInnerNode.PmdAsAntlrInnerNode<N>,N>

Base class for the inner nodes (corresponds to ParserRuleContext). Use the contextSuperClass option to set this in the antlr g4 file, eg options { contextSuperClass = SwiftInnerNode; }.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>>

Nested classes/interfaces inherited from class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode

BaseAntlrNode.AntlrToPmdParseTreeAdapter<N extends AntlrNode<N>>

Field Summary

Fields

Modifier and Type	Field	Description
org.antlr.v4.runtime.RecognitionException	exception

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

COORDS_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseAntlrInnerNode()
protected	BaseAntlrInnerNode(org.antlr.v4.runtime.ParserRuleContext parent, int invokingStateNumber)

Method Summary

Modifier and Type	Method	Description
protected BaseAntlrInnerNode.PmdAsAntlrInnerNode<N>	asAntlrNode()
protected void	copyFrom(BaseAntlrInnerNode<N> other)
void	enterRule(org.antlr.v4.runtime.tree.ParseTreeListener listener)
void	exitRule(org.antlr.v4.runtime.tree.ParseTreeListener listener)
N	getChild(int index)	Returns the child of this node at the given index.
org.antlr.v4.runtime.Token	getFirstAntlrToken()
org.antlr.v4.runtime.Token	getLastAntlrToken()
int	getNumChildren()	Returns the number of children of this node.
protected <T extends BaseAntlrInnerNode<N>> T	getRuleContext(Class<T> klass, int idx)
protected <T extends BaseAntlrInnerNode<N>> List<T>	getRuleContexts(Class<T> klass)
protected abstract int	getRuleIndex()
protected org.antlr.v4.runtime.tree.TerminalNode	getToken(int kind, int idx)
protected List<org.antlr.v4.runtime.tree.TerminalNode>	getTokens(int kind)

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.antlr4.BaseAntlrNode

getBeginColumn, getBeginLine, getEndColumn, getEndLine, getIndexInParent, getParent, getTextRegion, getUserMap, joinTokenText

Methods inherited from class java.lang.Object

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

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

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getFirstChild, getLastChild, getNextSibling, getNthParent, getPreviousSibling

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

acceptVisitor, ancestors, children, compareLocation, descendants, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, firstChild, getAstInfo, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfType, getImage, getLanguageVersion, getParentsOfType, getReportLocation, getRoot, getTextDocument, getXPathAttributesIterator, getXPathNodeName, hasDescendantOfType, hasImageEqualTo, isFindBoundary

Field Detail

exception

public org.antlr.v4.runtime.RecognitionException exception

Constructor Detail

BaseAntlrInnerNode

protected BaseAntlrInnerNode()

BaseAntlrInnerNode

protected BaseAntlrInnerNode(org.antlr.v4.runtime.ParserRuleContext parent,
                             int invokingStateNumber)

Method Detail

getChild

public N getChild(int index)

Description copied from interface: Node

Returns the child of this node at the given index.

getNumChildren

public int getNumChildren()

Description copied from interface: Node

Returns the number of children of this node.

asAntlrNode

protected BaseAntlrInnerNode.PmdAsAntlrInnerNode<N> asAntlrNode()

Specified by:

asAntlrNode in class BaseAntlrNode<BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>>,N extends AntlrNode<N>>

getRuleIndex

protected abstract int getRuleIndex()

getFirstAntlrToken

public org.antlr.v4.runtime.Token getFirstAntlrToken()

Specified by:

getFirstAntlrToken in class BaseAntlrNode<BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>>,N extends AntlrNode<N>>

getLastAntlrToken

public org.antlr.v4.runtime.Token getLastAntlrToken()

Specified by:

getLastAntlrToken in class BaseAntlrNode<BaseAntlrInnerNode.PmdAsAntlrInnerNode<N extends AntlrNode<N>>,N extends AntlrNode<N>>

getRuleContext

protected <T extends BaseAntlrInnerNode<N>> T getRuleContext(Class<T> klass,
                                                             int idx)

getRuleContexts

protected <T extends BaseAntlrInnerNode<N>> List<T> getRuleContexts(Class<T> klass)

getToken

protected org.antlr.v4.runtime.tree.TerminalNode getToken(int kind,
                                                          int idx)

getTokens

protected List<org.antlr.v4.runtime.tree.TerminalNode> getTokens(int kind)

copyFrom

protected void copyFrom(BaseAntlrInnerNode<N> other)

enterRule

public void enterRule(org.antlr.v4.runtime.tree.ParseTreeListener listener)

exitRule

public void exitRule(org.antlr.v4.runtime.tree.ParseTreeListener listener)