com.puppycrawl.tools.checkstyle.gui

Class ParseTreeTablePresentation

java.lang.Object

com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation

public class ParseTreeTablePresentation
extends java.lang.Object

The model that backs the parse tree in the GUI.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<DetailAST,DetailNode>	blockCommentToJavadocTree Cache to store already parsed Javadoc comments.
private static java.lang.String[]	COLUMN_NAMES Column names.
private MainFrameModel.ParseMode	parseMode Parsing mode.
private DetailAST	root The root node of the tree table model.
private static java.lang.String	UNKNOWN_COLUMN_MSG Exception message.

Constructor Summary

Constructors

Constructor and Description
ParseTreeTablePresentation(DetailAST parseTree) Constructor initialise root node.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getChild(java.lang.Object parent, int index) Returns the child of parent at index.
private java.lang.Object	getChildAtDetailAst(DetailAST parent, int index) Gets child of DetailAST node at specified index.
int	getChildCount(java.lang.Object parent) Returns the number of children of parent.
java.lang.Class<?>	getColumnClass(int column) Returns type of specified column number.
int	getColumnCount() Returns number of available columns.
java.lang.String	getColumnName(int column) Returns name for specified column number.
int	getIndexOfChild(java.lang.Object parent, java.lang.Object child) Return the index of child in parent.
private DetailNode	getJavadocTree(DetailAST blockComment) Gets Javadoc (DetailNode) tree of specified block comments.
java.lang.Object	getRoot() Returns value of root.
java.lang.Object	getValueAt(java.lang.Object node, int column) Returns the value to be displayed for node at column number.
private static java.lang.Object	getValueAtDetailAST(DetailAST ast, int column) Gets a value for DetailAST object.
private static java.lang.Object	getValueAtDetailNode(DetailNode node, int column) Gets a value for DetailNode object.
boolean	isCellEditable(int column) Indicates whether the the value for node node, at column number column is editable.
boolean	isLeaf(java.lang.Object node) Whether the node is a leaf.
private static DetailNode	parseJavadocTree(DetailAST blockComment) Parses Javadoc (DetailNode) tree of specified block comments.
protected void	setParseMode(MainFrameModel.ParseMode mode) Set parse mode.
protected void	setRoot(DetailAST parseTree) Set parse tree.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_COLUMN_MSG

private static final java.lang.String UNKNOWN_COLUMN_MSG

Exception message.

See Also:

Constant Field Values

COLUMN_NAMES

private static final java.lang.String[] COLUMN_NAMES

Column names.

blockCommentToJavadocTree

private final java.util.Map<DetailAST,DetailNode> blockCommentToJavadocTree

Cache to store already parsed Javadoc comments. Used for optimisation purposes.

root

private DetailAST root

The root node of the tree table model.

parseMode

private MainFrameModel.ParseMode parseMode

Parsing mode.

Constructor Detail

ParseTreeTablePresentation

public ParseTreeTablePresentation(DetailAST parseTree)

Constructor initialise root node.

Parameters:

parseTree - DetailAST parse tree.

Method Detail

setRoot

protected final void setRoot(DetailAST parseTree)

Set parse tree.

Parameters:

parseTree - DetailAST parse tree.

setParseMode

protected void setParseMode(MainFrameModel.ParseMode mode)

Set parse mode.

Parameters:

mode - ParseMode enum

getColumnCount

public int getColumnCount()

Returns number of available columns.

Returns:

the number of available columns.

getColumnName

public java.lang.String getColumnName(int column)

Returns name for specified column number.

Parameters:

column - the column number

Returns:

the name for column number column.

getColumnClass

public java.lang.Class<?> getColumnClass(int column)

Returns type of specified column number.

Parameters:

column - the column number

Returns:

the type for column number column.

Throws:

java.lang.IllegalStateException - if an unknown column index was specified.

getValueAt

public java.lang.Object getValueAt(java.lang.Object node,
                                   int column)

Returns the value to be displayed for node at column number.

Parameters:

node - the node

column - the column number

Returns:

the value to be displayed for node node, at column number column.

getChild

public java.lang.Object getChild(java.lang.Object parent,
                                 int index)

Returns the child of parent at index.

Parameters:

parent - the node to get a child from.

index - the index of a child.

Returns:

the child of parent at index.

getChildCount

public int getChildCount(java.lang.Object parent)

Returns the number of children of parent.

Parameters:

parent - the node to count children for.

Returns:

the number of children of the node parent.

getRoot

public java.lang.Object getRoot()

Returns value of root.

Returns:

the root.

isLeaf

public boolean isLeaf(java.lang.Object node)

Whether the node is a leaf.

Parameters:

node - the node to check.

Returns:

true if the node is a leaf.

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)

Return the index of child in parent. If either parent or child is null, returns -1. If either parent or child don't belong to this tree model, returns -1.

Parameters:

parent - a node in the tree, obtained from this data source.

child - the node we are interested in.

Returns:

the index of the child in the parent, or -1 if either child or parent are null or don't belong to this tree model.

isCellEditable

public boolean isCellEditable(int column)

Indicates whether the the value for node node, at column number column is editable.

Parameters:

column - the column number

Returns:

true if editable

getChildAtDetailAst

private java.lang.Object getChildAtDetailAst(DetailAST parent,
                                             int index)

Gets child of DetailAST node at specified index.

Parameters:

parent - DetailAST node

index - child index

Returns:

child DetailsAST or DetailNode if child is Javadoc node and parseMode is JAVA_WITH_JAVADOC_AND_COMMENTS.

getValueAtDetailNode

private static java.lang.Object getValueAtDetailNode(DetailNode node,
                                                     int column)

Gets a value for DetailNode object.

Parameters:

node - DetailNode(Javadoc) node.

column - column index.

Returns:

value at specified column.

Throws:

java.lang.IllegalStateException - if an unknown column index was specified.

getValueAtDetailAST

private static java.lang.Object getValueAtDetailAST(DetailAST ast,
                                                    int column)

Gets a value for DetailAST object.

Parameters:

ast - DetailAST node.

column - column index.

Returns:

value at specified column.

Throws:

java.lang.IllegalStateException - if an unknown column index was specified.

getJavadocTree

private DetailNode getJavadocTree(DetailAST blockComment)

Gets Javadoc (DetailNode) tree of specified block comments.

Parameters:

blockComment - Javadoc comment as a block comment

Returns:

root of DetailNode tree

parseJavadocTree

private static DetailNode parseJavadocTree(DetailAST blockComment)

Parses Javadoc (DetailNode) tree of specified block comments.

Parameters:

blockComment - Javadoc comment as a block comment

Returns:

root of DetailNode tree