Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocNodeImpl

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocNodeImpl

All Implemented Interfaces:

DetailNode

public class JavadocNodeImpl
extends Object
implements DetailNode

Implementation of DetailNode interface that is mutable.

Field Summary

Fields

Modifier and Type	Field	Description
private int	columnNumber	Column number.
private JavadocNodeImpl	firstChild	First child of this DetailAST.
private int	lineNumber	Line number.
private JavadocNodeImpl	nextSibling	Next sibling node.
private JavadocNodeImpl	parent	Parent node.
private JavadocNodeImpl	previousSibling	Previous sibling.
private String	text	Node's text content.
private int	type	Node type.

Constructor Summary

Constructors

Constructor	Description
JavadocNodeImpl()

Method Summary

Modifier and Type	Method	Description
void	addChild(DetailNode newChild)	Adds a child node to this node.
int	getColumnNumber()	Node column number.
JavadocNodeImpl	getFirstChild()	First child node.
int	getLineNumber()	Node line number.
DetailNode	getNextSibling()	Sibling node.
DetailNode	getParent()	Parent node.
DetailNode	getPreviousSibling()	Previous sibling node.
String	getText()	Node text.
int	getType()	Node type.
void	initialize(org.antlr.v4.runtime.Token token)	Initializes the node from the given token.
void	setColumnNumber(int columnNumber)	Sets column number.
void	setLineNumber(int lineNumber)	Sets line number.
void	setNextSibling(DetailNode nextSibling)	Sets next sibling node.
void	setParent(DetailNode node)	Sets parent node.
void	setText(String text)	Sets node's text content.
void	setType(int type)	Sets node's type.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

type

private int type

Node type.

text

private String text

Node's text content.

lineNumber

private int lineNumber

Line number.

columnNumber

private int columnNumber

Column number.

parent

private JavadocNodeImpl parent

Parent node.

nextSibling

private JavadocNodeImpl nextSibling

Next sibling node.

previousSibling

private JavadocNodeImpl previousSibling

Previous sibling.

firstChild

private JavadocNodeImpl firstChild

First child of this DetailAST.

Constructor Details

JavadocNodeImpl

public JavadocNodeImpl()

Method Details

initialize

public void initialize(org.antlr.v4.runtime.Token token)

Initializes the node from the given token.

Parameters:

token - the token to initialize from.

getType

public int getType()

Description copied from interface: DetailNode

Node type.

Specified by:

getType in interface DetailNode

Returns:

node type.

See Also:

• JavadocCommentsTokenTypes

getText

public String getText()

Description copied from interface: DetailNode

Node text.

Specified by:

getText in interface DetailNode

Returns:

node text

getLineNumber

public int getLineNumber()

Description copied from interface: DetailNode

Node line number.

Specified by:

getLineNumber in interface DetailNode

Returns:

node line number

getColumnNumber

public int getColumnNumber()

Description copied from interface: DetailNode

Node column number.

Specified by:

getColumnNumber in interface DetailNode

Returns:

node column number.

getParent

public DetailNode getParent()

Description copied from interface: DetailNode

Parent node.

Specified by:

getParent in interface DetailNode

Returns:

parent node.

getNextSibling

public DetailNode getNextSibling()

Description copied from interface: DetailNode

Sibling node.

Specified by:

getNextSibling in interface DetailNode

Returns:

sibling node

getPreviousSibling

public DetailNode getPreviousSibling()

Description copied from interface: DetailNode

Previous sibling node.

Specified by:

getPreviousSibling in interface DetailNode

Returns:

sibling node

getFirstChild

public JavadocNodeImpl getFirstChild()

Description copied from interface: DetailNode

First child node.

Specified by:

getFirstChild in interface DetailNode

Returns:

first child node

setType

public void setType(int type)

Sets node's type.

Parameters:

type - Node's type.

setText

public void setText(String text)

Sets node's text content.

Parameters:

text - Node's text content.

setLineNumber

public void setLineNumber(int lineNumber)

Sets line number.

Parameters:

lineNumber - Line number.

setColumnNumber

public void setColumnNumber(int columnNumber)

Sets column number.

Parameters:

columnNumber - Column number.

setParent

public void setParent(DetailNode node)

Sets parent node.

Parameters:

node - Parent node.

setNextSibling

public void setNextSibling(DetailNode nextSibling)

Sets next sibling node.

Parameters:

nextSibling - Next sibling node.

addChild

public void addChild(DetailNode newChild)

Adds a child node to this node.

Parameters:

newChild - Child node to be added.

toString

public String toString()

Overrides:

toString in class Object