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 java.lang.Object
implements DetailNode

Implementation of DetailNode interface that is mutable.

Field Summary

Fields

Modifier and Type	Field and Description
private DetailNode[]	children Array of child nodes.
private int	columnNumber Column number.
static JavadocNodeImpl[]	EMPTY_DETAIL_NODE_ARRAY Empty array of DetailNode type.
private int	index Node index among parent's children.
private int	lineNumber Line number.
private DetailNode	parent Parent node.
private java.lang.String	text Node's text content.
private int	type Node type.

Constructor Summary

Constructors

Constructor and Description
JavadocNodeImpl()

Method Summary

Modifier and Type	Method and Description
DetailNode[]	getChildren() Array of children.
int	getColumnNumber() Node column number.
int	getIndex() Node index among parent's children.
int	getLineNumber() Node line number.
DetailNode	getParent() Parent node.
java.lang.String	getText() Node text.
int	getType() Node type.
void	setChildren(DetailNode... children) Sets array of child nodes.
void	setColumnNumber(int columnNumber) Sets column number.
void	setIndex(int index) Sets node's index among parent's children.
void	setLineNumber(int lineNumber) Sets line number.
void	setParent(DetailNode parent) Sets parent node.
void	setText(java.lang.String text) Sets node's text content.
void	setType(int type) Sets node's type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_DETAIL_NODE_ARRAY

public static final JavadocNodeImpl[] EMPTY_DETAIL_NODE_ARRAY

Empty array of DetailNode type.

index

private int index

Node index among parent's children.

type

private int type

Node type.

text

private java.lang.String text

Node's text content.

lineNumber

private int lineNumber

Line number.

columnNumber

private int columnNumber

Column number.

children

private DetailNode[] children

Array of child nodes.

parent

private DetailNode parent

Parent node.

Constructor Detail

JavadocNodeImpl

public JavadocNodeImpl()

Method Detail

getType

public int getType()

Description copied from interface: DetailNode

Node type.

Specified by:

getType in interface DetailNode

Returns:

node type.

See Also:

JavadocTokenTypes

getText

public java.lang.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.

getChildren

public DetailNode[] getChildren()

Description copied from interface: DetailNode

Array of children.

Specified by:

getChildren in interface DetailNode

Returns:

array of children

getParent

public DetailNode getParent()

Description copied from interface: DetailNode

Parent node.

Specified by:

getParent in interface DetailNode

Returns:

parent node.

getIndex

public int getIndex()

Description copied from interface: DetailNode

Node index among parent's children.

Specified by:

getIndex in interface DetailNode

Returns:

index

setType

public void setType(int type)

Sets node's type.

Parameters:

type - Node's type.

setText

public void setText(java.lang.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.

setChildren

public void setChildren(DetailNode... children)

Sets array of child nodes.

Parameters:

children - Array of child nodes.

setParent

public void setParent(DetailNode parent)

Sets parent node.

Parameters:

parent - Parent node.

setIndex

public void setIndex(int index)

Sets node's index among parent's children.

Parameters:

index - Node's index among parent's children.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object