Package com.puppycrawl.tools.checkstyle.api

Interface DetailNode

All Known Implementing Classes:

JavadocNodeImpl

public interface DetailNode

DetailNode is used to construct tree during parsing Javadoc comments. Contains array of children, parent node and other useful fields.

See Also:

• JavadocNodeImpl
• AbstractJavadocCheck

Method Summary

Modifier and Type	Method	Description
int	getColumnNumber()	Node column number.
DetailNode	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.

Method Details

getType

int getType()

Node type.

Returns:

node type.

See Also:

• JavadocCommentsTokenTypes

getText

String getText()

Node text.

Returns:

node text

getLineNumber

int getLineNumber()

Node line number.

Returns:

node line number

getColumnNumber

int getColumnNumber()

Node column number.

Returns:

node column number.

getParent

DetailNode getParent()

Parent node.

Returns:

parent node.

getNextSibling

DetailNode getNextSibling()

Sibling node.

Returns:

sibling node

getFirstChild

DetailNode getFirstChild()

First child node.

Returns:

first child node

getPreviousSibling

DetailNode getPreviousSibling()

Previous sibling node.

Returns:

sibling node