8042089: Fix doclint warnings from javax.swing.tree and javax.swing.undo packages
Reviewed-by: alexsch
Contributed-by: Dmitriy Ermashov <dmitriy.ermashov@oracle.com>
--- a/jdk/src/share/classes/javax/swing/tree/AbstractLayoutCache.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/AbstractLayoutCache.java Fri May 16 17:45:35 2014 +0400
@@ -149,6 +149,8 @@
* Returns the height of each row. If the returned value is less than
* or equal to 0 the height for each row is determined by the
* renderer.
+ *
+ * @return the height of each row
*/
public int getRowHeight() {
return rowHeight;
@@ -263,6 +265,9 @@
/**
* Returns true if the value identified by row is currently expanded.
+ *
+ * @param path TreePath to check
+ * @return whether TreePath is expanded
*/
public abstract boolean isExpanded(TreePath path);
@@ -496,6 +501,8 @@
/**
* Returns true if the height of each row is a fixed size.
+ *
+ * @return whether the height of each row is a fixed size
*/
protected boolean isFixedRowHeight() {
return (rowHeight > 0);
--- a/jdk/src/share/classes/javax/swing/tree/DefaultMutableTreeNode.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/DefaultMutableTreeNode.java Fri May 16 17:45:35 2014 +0400
@@ -534,6 +534,7 @@
* Returns true if and only if <code>aNode</code> is in the same tree
* as this node. Returns false if <code>aNode</code> is null.
*
+ * @param aNode node to find common ancestor with
* @see #getSharedAncestor
* @see #getRoot
* @return true if <code>aNode</code> is in the same tree as this node;
@@ -638,6 +639,8 @@
* Returns the user object path, from the root, to get to this node.
* If some of the TreeNodes in the path have null user objects, the
* returned path will contain nulls.
+ *
+ * @return the user object path, from the root, to get to this node
*/
public Object[] getUserObjectPath() {
TreeNode[] realPath = getPath();
@@ -828,6 +831,7 @@
* Modifying the tree by inserting, removing, or moving a node invalidates
* any enumerations created before the modification.
*
+ * @param ancestor the node to start enumeration from
* @see #isNodeAncestor
* @see #isNodeDescendant
* @exception IllegalArgumentException if <code>ancestor</code> is
@@ -848,6 +852,7 @@
* Returns true if <code>aNode</code> is a child of this node. If
* <code>aNode</code> is null, this method returns false.
*
+ * @param aNode the node to determinate whether it is a child
* @return true if <code>aNode</code> is a child of this node; false if
* <code>aNode</code> is null
*/
@@ -906,6 +911,7 @@
* <code>aChild</code> and is O(n) where n is the number of children; to
* traverse the entire array of children, use an enumeration instead.
*
+ * @param aChild the child node to look for next child after it
* @see #children
* @exception IllegalArgumentException if <code>aChild</code> is
* null or is not a child of this node
@@ -938,6 +944,7 @@
* performs a linear search of this node's children for <code>aChild</code>
* and is O(n) where n is the number of children.
*
+ * @param aChild the child node to look for previous child before it
* @exception IllegalArgumentException if <code>aChild</code> is null
* or is not a child of this node
* @return the child of this node that immediately precedes
--- a/jdk/src/share/classes/javax/swing/tree/DefaultTreeCellEditor.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/DefaultTreeCellEditor.java Fri May 16 17:45:35 2014 +0400
@@ -405,7 +405,9 @@
/**
* Returns true if <code>event</code> is a <code>MouseEvent</code>
* and the click count is 1.
- * @param event the event being studied
+ *
+ * @param event the event being studied
+ * @return whether {@code event} should starts the editing timer
*/
protected boolean shouldStartEditingTimer(EventObject event) {
if((event instanceof MouseEvent) &&
@@ -433,7 +435,9 @@
* Returns true if <code>event</code> is <code>null</code>,
* or it is a <code>MouseEvent</code> with a click count > 2
* and <code>inHitRegion</code> returns true.
+ *
* @param event the event being studied
+ * @return whether editing can be started for the given {@code event}
*/
protected boolean canEditImmediately(EventObject event) {
if((event instanceof MouseEvent) &&
@@ -513,6 +517,8 @@
/**
* Creates the container to manage placement of
* <code>editingComponent</code>.
+ *
+ * @return new Container object
*/
protected Container createContainer() {
return new EditorContainer();
--- a/jdk/src/share/classes/javax/swing/tree/DefaultTreeCellRenderer.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/DefaultTreeCellRenderer.java Fri May 16 17:45:35 2014 +0400
@@ -234,6 +234,9 @@
/**
* Returns the default icon, for the current laf, that is used to
* represent non-leaf nodes that are expanded.
+ *
+ * @return the default icon, for the current laf, that is used to
+ * represent non-leaf nodes that are expanded.
*/
public Icon getDefaultOpenIcon() {
return DefaultLookup.getIcon(this, ui, "Tree.openIcon");
@@ -242,6 +245,9 @@
/**
* Returns the default icon, for the current laf, that is used to
* represent non-leaf nodes that are not expanded.
+ *
+ * @return the default icon, for the current laf, that is used to
+ * represent non-leaf nodes that are not expanded.
*/
public Icon getDefaultClosedIcon() {
return DefaultLookup.getIcon(this, ui, "Tree.closedIcon");
@@ -250,6 +256,9 @@
/**
* Returns the default icon, for the current laf, that is used to
* represent leaf nodes.
+ *
+ * @return the default icon, for the current laf, that is used to
+ * represent leaf nodes.
*/
public Icon getDefaultLeafIcon() {
return DefaultLookup.getIcon(this, ui, "Tree.leafIcon");
@@ -257,6 +266,8 @@
/**
* Sets the icon used to represent non-leaf nodes that are expanded.
+ *
+ * @param newIcon the icon to be used for expanded non-leaf nodes
*/
public void setOpenIcon(Icon newIcon) {
openIcon = newIcon;
@@ -264,6 +275,8 @@
/**
* Returns the icon used to represent non-leaf nodes that are expanded.
+ *
+ * @return the icon used to represent non-leaf nodes that are expanded
*/
public Icon getOpenIcon() {
return openIcon;
@@ -271,6 +284,8 @@
/**
* Sets the icon used to represent non-leaf nodes that are not expanded.
+ *
+ * @param newIcon the icon to be used for not expanded non-leaf nodes
*/
public void setClosedIcon(Icon newIcon) {
closedIcon = newIcon;
@@ -279,6 +294,9 @@
/**
* Returns the icon used to represent non-leaf nodes that are not
* expanded.
+ *
+ * @return the icon used to represent non-leaf nodes that are not
+ * expanded
*/
public Icon getClosedIcon() {
return closedIcon;
@@ -286,6 +304,8 @@
/**
* Sets the icon used to represent leaf nodes.
+ *
+ * @param newIcon icon to be used for leaf nodes
*/
public void setLeafIcon(Icon newIcon) {
leafIcon = newIcon;
@@ -293,6 +313,8 @@
/**
* Returns the icon used to represent leaf nodes.
+ *
+ * @return the icon used to represent leaf nodes
*/
public Icon getLeafIcon() {
return leafIcon;
@@ -300,6 +322,8 @@
/**
* Sets the color the text is drawn with when the node is selected.
+ *
+ * @param newColor color to be used for text when the node is selected
*/
public void setTextSelectionColor(Color newColor) {
textSelectionColor = newColor;
@@ -307,6 +331,8 @@
/**
* Returns the color the text is drawn with when the node is selected.
+ *
+ * @return the color the text is drawn with when the node is selected
*/
public Color getTextSelectionColor() {
return textSelectionColor;
@@ -314,6 +340,8 @@
/**
* Sets the color the text is drawn with when the node isn't selected.
+ *
+ * @param newColor color to be used for text when the node isn't selected
*/
public void setTextNonSelectionColor(Color newColor) {
textNonSelectionColor = newColor;
@@ -321,6 +349,8 @@
/**
* Returns the color the text is drawn with when the node isn't selected.
+ *
+ * @return the color the text is drawn with when the node isn't selected.
*/
public Color getTextNonSelectionColor() {
return textNonSelectionColor;
@@ -328,6 +358,8 @@
/**
* Sets the color to use for the background if node is selected.
+ *
+ * @param newColor to be used for the background if the node is selected
*/
public void setBackgroundSelectionColor(Color newColor) {
backgroundSelectionColor = newColor;
@@ -336,6 +368,8 @@
/**
* Returns the color to use for the background if node is selected.
+ *
+ * @return the color to use for the background if node is selected
*/
public Color getBackgroundSelectionColor() {
return backgroundSelectionColor;
@@ -343,6 +377,8 @@
/**
* Sets the background color to be used for non selected nodes.
+ *
+ * @param newColor color to be used for the background for non selected nodes
*/
public void setBackgroundNonSelectionColor(Color newColor) {
backgroundNonSelectionColor = newColor;
@@ -350,6 +386,8 @@
/**
* Returns the background color to be used for non selected nodes.
+ *
+ * @return the background color to be used for non selected nodes.
*/
public Color getBackgroundNonSelectionColor() {
return backgroundNonSelectionColor;
@@ -357,6 +395,8 @@
/**
* Sets the color to use for the border.
+ *
+ * @param newColor color to be used for the border
*/
public void setBorderSelectionColor(Color newColor) {
borderSelectionColor = newColor;
@@ -364,6 +404,8 @@
/**
* Returns the color the border is drawn.
+ *
+ * @return the color the border is drawn
*/
public Color getBorderSelectionColor() {
return borderSelectionColor;
--- a/jdk/src/share/classes/javax/swing/tree/DefaultTreeModel.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/DefaultTreeModel.java Fri May 16 17:45:35 2014 +0400
@@ -105,6 +105,9 @@
* Sets whether or not to test leafness by asking getAllowsChildren()
* or isLeaf() to the TreeNodes. If newvalue is true, getAllowsChildren()
* is messaged, otherwise isLeaf() is messaged.
+ *
+ * @param newValue if true, getAllowsChildren() is messaged, otherwise
+ * isLeaf() is messaged
*/
public void setAsksAllowsChildren(boolean newValue) {
asksAllowsChildren = newValue;
@@ -125,6 +128,8 @@
/**
* Sets the root to <code>root</code>. A null <code>root</code> implies
* the tree is to display nothing, and is legal.
+ *
+ * @param root new value of tree root
*/
public void setRoot(TreeNode root) {
Object oldRoot = this.root;
@@ -231,6 +236,10 @@
* This will then message nodesWereInserted to create the appropriate
* event. This is the preferred way to add children as it will create
* the appropriate event.
+ *
+ * @param newChild child node to be inserted
+ * @param parent node to which children new node will be added
+ * @param index index of parent's children
*/
public void insertNodeInto(MutableTreeNode newChild,
MutableTreeNode parent, int index){
@@ -247,6 +256,8 @@
* nodesWereRemoved to create the appropriate event. This is the
* preferred way to remove a node as it handles the event creation
* for you.
+ *
+ * @param node the node to be removed from it's parrent
*/
public void removeNodeFromParent(MutableTreeNode node) {
MutableTreeNode parent = (MutableTreeNode)node.getParent();
@@ -266,6 +277,8 @@
/**
* Invoke this method after you've changed how node is to be
* represented in the tree.
+ *
+ * @param node the changed node
*/
public void nodeChanged(TreeNode node) {
if(listenerList != null && node != null) {
@@ -303,6 +316,9 @@
* Invoke this method after you've inserted some TreeNodes into
* node. childIndices should be the index of the new elements and
* must be sorted in ascending order.
+ *
+ * @param node parent node which children count been incremented
+ * @param childIndices indexes of inserted children
*/
public void nodesWereInserted(TreeNode node, int[] childIndices) {
if(listenerList != null && node != null && childIndices != null
@@ -322,6 +338,10 @@
* node. childIndices should be the index of the removed elements and
* must be sorted in ascending order. And removedChildren should be
* the array of the children objects that were removed.
+ *
+ * @param node parent node which childred were removed
+ * @param childIndices indexes of removed childs
+ * @param removedChildren array of the children objects that were removed
*/
public void nodesWereRemoved(TreeNode node, int[] childIndices,
Object[] removedChildren) {
@@ -334,6 +354,9 @@
/**
* Invoke this method after you've changed how the children identified by
* childIndicies are to be represented in the tree.
+ *
+ * @param node changed node
+ * @param childIndices indexes of changed children
*/
public void nodesChanged(TreeNode node, int[] childIndices) {
if(node != null) {
@@ -360,6 +383,8 @@
* Invoke this method if you've totally changed the children of
* node and its children's children... This will post a
* treeStructureChanged event.
+ *
+ * @param node changed node
*/
public void nodeStructureChanged(TreeNode node) {
if(node != null) {
@@ -374,6 +399,7 @@
* tree.
*
* @param aNode the TreeNode to get the path for
+ * @return an array of TreeNodes giving the path from the root
*/
public TreeNode[] getPathToRoot(TreeNode aNode) {
return getPathToRoot(aNode, 0);
--- a/jdk/src/share/classes/javax/swing/tree/DefaultTreeSelectionModel.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/DefaultTreeSelectionModel.java Fri May 16 17:45:35 2014 +0400
@@ -618,6 +618,9 @@
/**
* Notifies all listeners that are registered for
* tree selection events on this object.
+ *
+ * @param e the event that characterizes the change
+ *
* @see #addTreeSelectionListener
* @see EventListenerList
*/
@@ -920,6 +923,9 @@
/**
* Returns true if the paths are contiguous,
* or this object has no RowMapper.
+ *
+ * @param paths array of paths to check
+ * @return whether the paths are contiguous, or this object has no RowMapper
*/
protected boolean arePathsContiguous(TreePath[] paths) {
if(rowMapper == null || paths.length < 2)
@@ -968,6 +974,9 @@
* or the selection mode is <code>DISCONTIGUOUS_TREE_SELECTION</code>, or
* adding the paths to the current selection still results in a
* contiguous set of <code>TreePath</code>s.
+ *
+ * @param paths array of {@code TreePaths} to check
+ * @return whether the particular set of {@code TreePaths} can be added
*/
protected boolean canPathsBeAdded(TreePath[] paths) {
if(paths == null || paths.length == 0 || rowMapper == null ||
@@ -1019,6 +1028,10 @@
* Returns true if the paths can be removed without breaking the
* continuity of the model.
* This is rather expensive.
+ *
+ * @param paths array of {@code TreePath} to check
+ * @return whether the paths can be removed without breaking the
+ * continuity of the model
*/
protected boolean canPathsBeRemoved(TreePath[] paths) {
if(rowMapper == null || selection == null ||
@@ -1072,6 +1085,9 @@
* instances of PathPlaceHolder.
*
* @deprecated As of JDK version 1.7
+ *
+ * @param changedPaths the vector of the changed paths
+ * @param oldLeadSelection the old selection path
*/
@Deprecated
protected void notifyPathChange(Vector<?> changedPaths,
--- a/jdk/src/share/classes/javax/swing/tree/MutableTreeNode.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/MutableTreeNode.java Fri May 16 17:45:35 2014 +0400
@@ -42,22 +42,31 @@
/**
* Adds <code>child</code> to the receiver at <code>index</code>.
* <code>child</code> will be messaged with <code>setParent</code>.
+ *
+ * @param child node to be added
+ * @param index index of the receiver
*/
void insert(MutableTreeNode child, int index);
/**
* Removes the child at <code>index</code> from the receiver.
+ *
+ * @param index index of child to be removed
*/
void remove(int index);
/**
* Removes <code>node</code> from the receiver. <code>setParent</code>
* will be messaged on <code>node</code>.
+ *
+ * @param node node to be removed from the receiver
*/
void remove(MutableTreeNode node);
/**
* Resets the user object of the receiver to <code>object</code>.
+ *
+ * @param object object to be set as a receiver
*/
void setUserObject(Object object);
@@ -68,6 +77,8 @@
/**
* Sets the parent of the receiver to <code>newParent</code>.
+ *
+ * @param newParent node to be set as parent of the receiver
*/
void setParent(MutableTreeNode newParent);
}
--- a/jdk/src/share/classes/javax/swing/tree/RowMapper.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/RowMapper.java Fri May 16 17:45:35 2014 +0400
@@ -41,6 +41,10 @@
* the same length as that passed in, and if one of the TreePaths
* in <code>path</code> is not valid its entry in the array should
* be set to -1.
+ *
+ * @param path array of TreePath to parse
+ * @return the rows that the TreePath instances in {@code path} are
+ * being displayed at
*/
int[] getRowsForPaths(TreePath[] path);
}
--- a/jdk/src/share/classes/javax/swing/tree/TreeCellRenderer.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/TreeCellRenderer.java Fri May 16 17:45:35 2014 +0400
@@ -67,7 +67,14 @@
* }
* </pre>
*
- * @return the <code>Component</code> that the renderer uses to draw the value
+ * @param tree the receiver is being configured for
+ * @param value the value to render
+ * @param selected whether node is selected
+ * @param expanded whether node is expanded
+ * @param leaf whether node is a lead node
+ * @param row row index
+ * @param hasFocus whether node has focus
+ * @return the {@code Component} that the renderer uses to draw the value
*/
Component getTreeCellRendererComponent(JTree tree, Object value,
boolean selected, boolean expanded,
--- a/jdk/src/share/classes/javax/swing/tree/TreeModel.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/TreeModel.java Fri May 16 17:45:35 2014 +0400
@@ -79,8 +79,9 @@
* is a valid index for <code>parent</code> (that is <code>index >= 0 &&
* index < getChildCount(parent</code>)).
*
- * @param parent a node in the tree, obtained from this data source
- * @return the child of <code>parent</code> at index <code>index</code>
+ * @param parent a node in the tree, obtained from this data source
+ * @param index index of child to be returned
+ * @return the child of {@code parent} at index {@code index}
*/
public Object getChild(Object parent, int index);
--- a/jdk/src/share/classes/javax/swing/tree/TreeNode.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/TreeNode.java Fri May 16 17:45:35 2014 +0400
@@ -49,17 +49,24 @@
/**
* Returns the child <code>TreeNode</code> at index
* <code>childIndex</code>.
+ *
+ * @param childIndex index of child
+ * @return the child node at given index
*/
TreeNode getChildAt(int childIndex);
/**
* Returns the number of children <code>TreeNode</code>s the receiver
* contains.
+ *
+ * @return the number of children the receiver contains
*/
int getChildCount();
/**
* Returns the parent <code>TreeNode</code> of the receiver.
+ *
+ * @return the parent of the receiver
*/
TreeNode getParent();
@@ -67,21 +74,30 @@
* Returns the index of <code>node</code> in the receivers children.
* If the receiver does not contain <code>node</code>, -1 will be
* returned.
+ *
+ * @param node node to be loked for
+ * @return index of specified node
*/
int getIndex(TreeNode node);
/**
* Returns true if the receiver allows children.
+ *
+ * @return whether the receiver allows children
*/
boolean getAllowsChildren();
/**
* Returns true if the receiver is a leaf.
+ *
+ * @return whether the receiver is a leaf
*/
boolean isLeaf();
/**
* Returns the children of the receiver as an <code>Enumeration</code>.
+ *
+ * @return the children of the receiver as an {@code Enumeration}
*/
Enumeration children();
}
--- a/jdk/src/share/classes/javax/swing/tree/TreePath.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/TreePath.java Fri May 16 17:45:35 2014 +0400
@@ -320,8 +320,10 @@
* plus <code>child</code>. <code>child</code> is the last element
* of the newly created {@code TreePath}.
*
- * @param child the path element to add
- * @throws NullPointerException if {@code child} is {@code null}
+ * @param child the path element to add
+ * @throws NullPointerException if {@code child} is {@code null}
+ * @return a new path containing all the elements of this path
+ * plus {@code child}
*/
public TreePath pathByAddingChild(Object child) {
if(child == null)
--- a/jdk/src/share/classes/javax/swing/tree/TreeSelectionModel.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/tree/TreeSelectionModel.java Fri May 16 17:45:35 2014 +0400
@@ -109,6 +109,8 @@
* selected when the mode is changed to <code>SINGLE_TREE_SELECTION</code>,
* only one TreePath will remain selected. It is up to the particular
* implementation to decide what TreePath remains selected.
+ *
+ * @param mode selection mode to be set
*/
void setSelectionMode(int mode);
@@ -117,6 +119,8 @@
* <code>SINGLE_TREE_SELECTION</code>,
* <code>CONTIGUOUS_TREE_SELECTION</code> or
* <code>DISCONTIGUOUS_TREE_SELECTION</code>.
+ *
+ * @return the current selection mode
*/
int getSelectionMode();
@@ -125,7 +129,7 @@
* the TreeSelectionListeners are notified. If <code>path</code> is
* null, this has the same effect as invoking <code>clearSelection</code>.
*
- * @param path new path to select
+ * @param path new path to select
*/
void setSelectionPath(TreePath path);
@@ -134,7 +138,7 @@
* the TreeSelectionListeners are notified. If <code>paths</code> is
* null, this has the same effect as invoking <code>clearSelection</code>.
*
- * @param paths new selection
+ * @param paths new selection
*/
void setSelectionPaths(TreePath[] paths);
@@ -143,7 +147,7 @@
* in the selection the TreeSelectionListeners are notified. This has
* no effect if <code>path</code> is null.
*
- * @param path the new path to add to the current selection
+ * @param path the new path to add to the current selection
*/
void addSelectionPath(TreePath path);
@@ -153,7 +157,7 @@
* are notified. This has
* no effect if <code>paths</code> is null.
*
- * @param paths the new paths to add to the current selection
+ * @param paths the new paths to add to the current selection
*/
void addSelectionPaths(TreePath[] paths);
@@ -162,7 +166,7 @@
* The TreeSelectionListeners are notified. This has no effect if
* <code>path</code> is null.
*
- * @param path the path to remove from the selection
+ * @param path the path to remove from the selection
*/
void removeSelectionPath(TreePath path);
@@ -172,7 +176,7 @@
* are in the selection, the TreeSelectionListeners are notified.
* This method has no effect if <code>paths</code> is null.
*
- * @param paths the path to remove from the selection
+ * @param paths the path to remove from the selection
*/
void removeSelectionPaths(TreePath[] paths);
@@ -181,28 +185,39 @@
* up to implementors, and may not necessarily be the TreePath with
* the smallest integer value as determined from the
* <code>RowMapper</code>.
+ *
+ * @return the first path in the selection
*/
TreePath getSelectionPath();
/**
* Returns the paths in the selection. This will return null (or an
* empty array) if nothing is currently selected.
+ *
+ * @return the paths in the selection
*/
TreePath[] getSelectionPaths();
/**
* Returns the number of paths that are selected.
+ *
+ * @return the number of paths that are selected
*/
int getSelectionCount();
/**
* Returns true if the path, <code>path</code>, is in the current
* selection.
+ *
+ * @param path the path to be loked for
+ * @return whether the {@code path} is in the current selection
*/
boolean isPathSelected(TreePath path);
/**
* Returns true if the selection is currently empty.
+ *
+ * @return whether the selection is currently empty
*/
boolean isSelectionEmpty();
@@ -215,12 +230,17 @@
/**
* Sets the RowMapper instance. This instance is used to determine
* the row for a particular TreePath.
+ *
+ * @param newMapper RowMapper to be set
*/
void setRowMapper(RowMapper newMapper);
/**
* Returns the RowMapper instance that is able to map a TreePath to a
* row.
+ *
+ * @return the RowMapper instance that is able to map a TreePath
+ * to a row
*/
RowMapper getRowMapper();
@@ -228,6 +248,8 @@
* Returns all of the currently selected rows. This will return
* null (or an empty array) if there are no selected TreePaths or
* a RowMapper has not been set.
+ *
+ * @return all of the currently selected rows
*/
int[] getSelectionRows();
@@ -235,6 +257,9 @@
* Returns the smallest value obtained from the RowMapper for the
* current set of selected TreePaths. If nothing is selected,
* or there is no RowMapper, this will return -1.
+ *
+ * @return the smallest value obtained from the RowMapper
+ * for the current set of selected TreePaths
*/
int getMinSelectionRow();
@@ -242,11 +267,17 @@
* Returns the largest value obtained from the RowMapper for the
* current set of selected TreePaths. If nothing is selected,
* or there is no RowMapper, this will return -1.
+ *
+ * @return the largest value obtained from the RowMapper
+ * for the current set of selected TreePaths
*/
int getMaxSelectionRow();
/**
* Returns true if the row identified by <code>row</code> is selected.
+ *
+ * @param row row to check
+ * @return whether the row is selected
*/
boolean isRowSelected(int row);
@@ -264,12 +295,16 @@
/**
* Returns the lead selection index. That is the last index that was
* added.
+ *
+ * @return the lead selection index
*/
int getLeadSelectionRow();
/**
* Returns the last path that was added. This may differ from the
* leadSelectionPath property maintained by the JTree.
+ *
+ * @return the last path that was added
*/
TreePath getLeadSelectionPath();
@@ -280,7 +315,7 @@
* A PropertyChangeEvent will get fired when the selection mode
* changes.
*
- * @param listener the PropertyChangeListener to be added
+ * @param listener the PropertyChangeListener to be added
*/
void addPropertyChangeListener(PropertyChangeListener listener);
@@ -289,7 +324,7 @@
* This removes a PropertyChangeListener that was registered
* for all properties.
*
- * @param listener the PropertyChangeListener to be removed
+ * @param listener the PropertyChangeListener to be removed
*/
void removePropertyChangeListener(PropertyChangeListener listener);
@@ -297,7 +332,7 @@
* Adds x to the list of listeners that are notified each time the
* set of selected TreePaths changes.
*
- * @param x the new listener to be added
+ * @param x the new listener to be added
*/
void addTreeSelectionListener(TreeSelectionListener x);
@@ -305,7 +340,7 @@
* Removes x from the list of listeners that are notified each time
* the set of selected TreePaths changes.
*
- * @param x the listener to remove
+ * @param x the listener to remove
*/
void removeTreeSelectionListener(TreeSelectionListener x);
}
--- a/jdk/src/share/classes/javax/swing/undo/CompoundEdit.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/undo/CompoundEdit.java Fri May 16 17:45:35 2014 +0400
@@ -82,6 +82,9 @@
* Returns the last <code>UndoableEdit</code> in
* <code>edits</code>, or <code>null</code>
* if <code>edits</code> is empty.
+ *
+ * @return the last {@code UndoableEdit} in {@code edits},
+ * or {@code null} if {@code edits} is empty.
*/
protected UndoableEdit lastEdit() {
int count = edits.size();
@@ -182,6 +185,7 @@
* received end. This generally means that edits are still being
* added to it.
*
+ * @return whether this edit is in progress
* @see #end
*/
public boolean isInProgress() {
--- a/jdk/src/share/classes/javax/swing/undo/StateEditable.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/undo/StateEditable.java Fri May 16 17:45:35 2014 +0400
@@ -43,12 +43,16 @@
/**
* Upon receiving this message the receiver should place any relevant
* state into <EM>state</EM>.
+ *
+ * @param state Hashtable object to store the state
*/
public void storeState(Hashtable<Object,Object> state);
/**
* Upon receiving this message the receiver should extract any relevant
* state out of <EM>state</EM>.
+ *
+ * @param state Hashtable object to restore the state from it
*/
public void restoreState(Hashtable<?,?> state);
} // End of interface StateEditable
--- a/jdk/src/share/classes/javax/swing/undo/UndoManager.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/undo/UndoManager.java Fri May 16 17:45:35 2014 +0400
@@ -326,6 +326,7 @@
* Undoes all changes from the index of the next edit to
* <code>edit</code>, updating the index of the next edit appropriately.
*
+ * @param edit the edit to be undo to
* @throws CannotUndoException if one of the edits throws
* <code>CannotUndoException</code>
*/
@@ -342,6 +343,7 @@
* Redoes all changes from the index of the next edit to
* <code>edit</code>, updating the index of the next edit appropriately.
*
+ * @param edit the edit to be redo to
* @throws CannotRedoException if one of the edits throws
* <code>CannotRedoException</code>
*/
--- a/jdk/src/share/classes/javax/swing/undo/UndoableEditSupport.java Fri May 16 17:41:47 2014 +0400
+++ b/jdk/src/share/classes/javax/swing/undo/UndoableEditSupport.java Fri May 16 17:45:35 2014 +0400
@@ -96,6 +96,8 @@
* Called only from <code>postEdit</code> and <code>endUpdate</code>. Calls
* <code>undoableEditHappened</code> in all listeners. No synchronization
* is performed here, since the two calling methods are synchronized.
+ *
+ * @param e edit to be verified
*/
protected void _postEdit(UndoableEdit e) {
UndoableEditEvent ev = new UndoableEditEvent(realSource, e);
@@ -110,6 +112,8 @@
* DEADLOCK WARNING: Calling this method may call
* <code>undoableEditHappened</code> in all listeners.
* It is unwise to call this method from one of its listeners.
+ *
+ * @param e edit to be posted
*/
public synchronized void postEdit(UndoableEdit e) {
if (updateLevel == 0) {
@@ -142,6 +146,8 @@
/**
* Called only from <code>beginUpdate</code>.
* Exposed here for subclasses' use.
+ *
+ * @return new created {@code CompoundEdit} object
*/
protected CompoundEdit createCompoundEdit() {
return new CompoundEdit();