Class ParseTreeTablePresentation
java.lang.Object
com.puppycrawl.tools.checkstyle.gui.ParseTreeTablePresentation
The model that backs the parse tree in the GUI.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Map<DetailAST,
DetailNode> Cache to store already parsed Javadoc comments.private static final String[]
Column names.private MainFrameModel.ParseMode
Parsing mode.private DetailAST
The root node of the tree table model.private static final String
Exception message. -
Constructor Summary
ConstructorsConstructorDescriptionParseTreeTablePresentation
(DetailAST parseTree) Constructor initialise root node. -
Method Summary
Modifier and TypeMethodDescriptionReturns the child of parent at index.private Object
getChildAtDetailAst
(DetailAST parent, int index) Gets child of DetailAST node at specified index.int
getChildCount
(Object parent) Returns the number of children of parent.Class<?>
getColumnClass
(int column) Returns type of specified column number.int
Returns number of available columns.getColumnName
(int column) Returns name for specified column number.int
getIndexOfChild
(Object parent, Object child) Return the index of child in parent.private DetailNode
getJavadocTree
(DetailAST blockComment) Gets Javadoc (DetailNode) tree of specified block comments.getRoot()
Returns value of root.getValueAt
(Object node, int column) Returns the value to be displayed for node at column number.private static Object
getValueAtDetailAST
(DetailAST ast, int column) Gets a value for DetailAST object.private static Object
getValueAtDetailNode
(DetailNode node, int column) Gets a value for DetailNode object.boolean
isCellEditable
(int column) Indicates whether the value for nodenode
, at column numbercolumn
is editable.boolean
Whether the node is a leaf.private static DetailNode
parseJavadocTree
(DetailAST blockComment) Parses Javadoc (DetailNode) tree of specified block comments.protected void
Set parse mode.protected final void
Set parse tree.
-
Field Details
-
UNKNOWN_COLUMN_MSG
Exception message.- See Also:
-
COLUMN_NAMES
Column names. -
blockCommentToJavadocTree
Cache to store already parsed Javadoc comments. Used for optimisation purposes. -
root
The root node of the tree table model. -
parseMode
Parsing mode.
-
-
Constructor Details
-
ParseTreeTablePresentation
Constructor initialise root node.- Parameters:
parseTree
- DetailAST parse tree.
-
-
Method Details
-
setRoot
Set parse tree.- Parameters:
parseTree
- DetailAST parse tree.
-
setParseMode
Set parse mode.- Parameters:
mode
- ParseMode enum
-
getColumnCount
Returns number of available columns.- Returns:
- the number of available columns.
-
getColumnName
Returns name for specified column number.- Parameters:
column
- the column number- Returns:
- the name for column number
column
.
-
getColumnClass
Returns type of specified column number.- Parameters:
column
- the column number- Returns:
- the type for column number
column
. - Throws:
IllegalStateException
- if an unknown column index was specified.
-
getValueAt
Returns the value to be displayed for node at column number.- Parameters:
node
- the nodecolumn
- the column number- Returns:
- the value to be displayed for node
node
, at column numbercolumn
.
-
getChild
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
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
Returns value of root.- Returns:
- the root.
-
isLeaf
Whether the node is a leaf.- Parameters:
node
- the node to check.- Returns:
- true if the node is a leaf.
-
getIndexOfChild
Return the index of child in parent. If eitherparent
orchild
isnull
, returns -1. If eitherparent
orchild
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
orparent
arenull
or don't belong to this tree model.
-
isCellEditable
Indicates whether the value for nodenode
, at column numbercolumn
is editable.- Parameters:
column
- the column number- Returns:
- true if editable
-
getChildAtDetailAst
Gets child of DetailAST node at specified index.- Parameters:
parent
- DetailAST nodeindex
- child index- Returns:
- child DetailsAST or DetailNode if child is Javadoc node and parseMode is JAVA_WITH_JAVADOC_AND_COMMENTS.
-
getValueAtDetailNode
Gets a value for DetailNode object.- Parameters:
node
- DetailNode(Javadoc) node.column
- column index.- Returns:
- value at specified column.
- Throws:
IllegalStateException
- if an unknown column index was specified.
-
getValueAtDetailAST
Gets a value for DetailAST object.- Parameters:
ast
- DetailAST node.column
- column index.- Returns:
- value at specified column.
- Throws:
IllegalStateException
- if an unknown column index was specified.
-
getJavadocTree
Gets Javadoc (DetailNode) tree of specified block comments.- Parameters:
blockComment
- Javadoc comment as a block comment- Returns:
- root of DetailNode tree
-
parseJavadocTree
Parses Javadoc (DetailNode) tree of specified block comments.- Parameters:
blockComment
- Javadoc comment as a block comment- Returns:
- root of DetailNode tree
-