Hello,
Please review the proposed changes to address
JDK-8076520: Fix missing doclint warnings in javax.swing.{table,
tree, undo, plaf.{metal, nimbus, synth}}
http://cr.openjdk.java.net/~darcy/8076520.0/
Patch below.
A number of the API elements are marked as "obsolete." Should they be
deprecated under another bug?
Thanks,
-Joe
---
old/src/java.desktop/share/classes/javax/swing/plaf/metal/MetalFileChooserUI.java
2015-04-01 22:34:23.192472352 -0700
+++
new/src/java.desktop/share/classes/javax/swing/plaf/metal/MetalFileChooserUI.java
2015-04-01 22:34:22.988472348 -0700
@@ -569,7 +569,9 @@
return super.createListSelectionListener(fc);
}
- // Obsolete class, not used in this version.
+ /**
+ * Obsolete class, not used in this version.
+ */
protected class SingleClickListener extends MouseAdapter {
/**
* Constructs an instance of {@code SingleClickListener}.
@@ -580,7 +582,9 @@
}
}
- // Obsolete class, not used in this version.
+ /**
+ * Obsolete class, not used in this version.
+ */
@SuppressWarnings("serial") // Superclass is not serializable
across versions
protected class FileRenderer extends DefaultListCellRenderer {
}
---
old/src/java.desktop/share/classes/javax/swing/plaf/nimbus/AbstractRegionPainter.java
2015-04-01 22:34:23.708472364 -0700
+++
new/src/java.desktop/share/classes/javax/swing/plaf/nimbus/AbstractRegionPainter.java
2015-04-01 22:34:23.492472359 -0700
@@ -495,8 +495,16 @@
* control points and bezier curve anchors.
*/
protected static class PaintContext {
+ /**
+ * Cache mode.
+ */
protected static enum CacheMode {
- NO_CACHING, FIXED_SIZES, NINE_SQUARE_SCALE
+ /** No caching.*/
+ NO_CACHING,
+ /** Fixed sizes.*/
+ FIXED_SIZES,
+ /** Nine square scale.*/
+ NINE_SQUARE_SCALE
}
private static Insets EMPTY_INSETS = new Insets(0, 0, 0, 0);
---
old/src/java.desktop/share/classes/javax/swing/plaf/nimbus/NimbusStyle.java
2015-04-01 22:34:24.220472376 -0700
+++
new/src/java.desktop/share/classes/javax/swing/plaf/nimbus/NimbusStyle.java
2015-04-01 22:34:24.052472372 -0700
@@ -120,11 +120,17 @@
*/
public final class NimbusStyle extends SynthStyle {
/* Keys and scales for large/small/mini components, based on
Apples sizes */
+ /** Large key */
public static final String LARGE_KEY = "large";
+ /** Small key */
public static final String SMALL_KEY = "small";
+ /** Mini key */
public static final String MINI_KEY = "mini";
+ /** Large scale */
public static final double LARGE_SCALE = 1.15;
+ /** Small scale */
public static final double SMALL_SCALE = 0.857;
+ /** Mini scale */
public static final double MINI_SCALE = 0.714;
/**
---
old/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthInternalFrameUI.java
2015-04-01 22:34:24.748472388 -0700
+++
new/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthInternalFrameUI.java
2015-04-01 22:34:24.548472384 -0700
@@ -56,6 +56,10 @@
return new SynthInternalFrameUI((JInternalFrame)b);
}
+ /**
+ * Constructs a {@code SynthInternalFrameUI}.
+ * @param b an internal frame
+ */
protected SynthInternalFrameUI(JInternalFrame b) {
super(b);
}
---
old/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthScrollBarUI.java
2015-04-01 22:34:25.280472401 -0700
+++
new/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthScrollBarUI.java
2015-04-01 22:34:25.108472397 -0700
@@ -48,6 +48,11 @@
private boolean validMinimumThumbSize;
+ /**
+ * Returns a UI.
+ * @return a UI
+ * @param c a component
+ */
public static ComponentUI createUI(JComponent c) {
return new SynthScrollBarUI();
}
---
old/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthSliderUI.java
2015-04-01 22:34:25.816472413 -0700
+++
new/src/java.desktop/share/classes/javax/swing/plaf/synth/SynthSliderUI.java
2015-04-01 22:34:25.616472409 -0700
@@ -93,6 +93,10 @@
return new SynthSliderUI((JSlider)c);
}
+ /**
+ * Constructs a {@code SynthSliderUI}.
+ * @param c a slider
+ */
protected SynthSliderUI(JSlider c) {
super(c);
}
---
old/src/java.desktop/share/classes/javax/swing/table/AbstractTableModel.java
2015-04-01 22:34:26.396472427 -0700
+++
new/src/java.desktop/share/classes/javax/swing/table/AbstractTableModel.java
2015-04-01 22:34:26.168472421 -0700
@@ -320,9 +320,8 @@
*
* If no such listeners exist, this method returns an empty array.
*
- * @param listenerType the type of listeners requested; this parameter
- * should specify an interface that descends from
- * <code>java.util.EventListener</code>
+ * @param <T> the listener type
+ * @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such
---
old/src/java.desktop/share/classes/javax/swing/table/DefaultTableCellRenderer.java
2015-04-01 22:34:26.872472438 -0700
+++
new/src/java.desktop/share/classes/javax/swing/table/DefaultTableCellRenderer.java
2015-04-01 22:34:26.688472433 -0700
@@ -95,6 +95,9 @@
*/
private static final Border SAFE_NO_FOCUS_BORDER = new
EmptyBorder(1, 1, 1, 1);
private static final Border DEFAULT_NO_FOCUS_BORDER = new
EmptyBorder(1, 1, 1, 1);
+ /**
+ * A border without focus.
+ */
protected static Border noFocusBorder = DEFAULT_NO_FOCUS_BORDER;
// We need a place to store the color the JLabel should be returned
---
old/src/java.desktop/share/classes/javax/swing/table/DefaultTableColumnModel.java
2015-04-01 22:34:27.408472450 -0700
+++
new/src/java.desktop/share/classes/javax/swing/table/DefaultTableColumnModel.java
2015-04-01 22:34:27.232472446 -0700
@@ -652,9 +652,8 @@
*
* If no such listeners exist, this method returns an empty array.
*
- * @param listenerType the type of listeners requested; this parameter
- * should specify an interface that descends from
- * <code>java.util.EventListener</code>
+ * @param <T> the listener type
+ * @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this model,
* or an empty array if no such
---
old/src/java.desktop/share/classes/javax/swing/table/DefaultTableModel.java
2015-04-01 22:34:27.972472463 -0700
+++
new/src/java.desktop/share/classes/javax/swing/table/DefaultTableModel.java
2015-04-01 22:34:27.784472459 -0700
@@ -314,15 +314,7 @@
/**
* Obsolete as of Java 2 platform v1.3. Please use
<code>setRowCount</code> instead.
- */
- /*
- * Sets the number of rows in the model. If the new size is greater
- * than the current size, new rows are added to the end of the model
- * If the new size is less than the current size, all
- * rows at index <code>rowCount</code> and greater are discarded.
- *
* @param rowCount the new number of rows
- * @see #setRowCount
*/
public void setNumRows(int rowCount) {
int old = getRowCount();
---
old/src/java.desktop/share/classes/javax/swing/table/JTableHeader.java
2015-04-01 22:34:28.496472475 -0700
+++
new/src/java.desktop/share/classes/javax/swing/table/JTableHeader.java
2015-04-01 22:34:28.332472471 -0700
@@ -281,14 +281,8 @@
/**
* Obsolete as of Java 2 platform v1.3. Real time repaints, in
response to
* column dragging or resizing, are now unconditional.
- */
- /*
- * Sets whether the body of the table updates in real time when
- * a column is resized or dragged.
- *
- * @param flag true if tableView should update
- * the body of the table in real time
- * @see #getUpdateTableInRealTime
+ * @param flag true if tableView should update the body of the
+ * table in real time
*/
public void setUpdateTableInRealTime(boolean flag) {
updateTableInRealTime = flag;
@@ -297,15 +291,7 @@
/**
* Obsolete as of Java 2 platform v1.3. Real time repaints, in
response to
* column dragging or resizing, are now unconditional.
- */
- /*
- * Returns true if the body of the table view updates in real
- * time when a column is resized or dragged. User can set this flag to
- * false to speed up the table's response to user resize or drag
actions.
- * The default is true.
- *
* @return true if the table updates in real time
- * @see #setUpdateTableInRealTime
*/
public boolean getUpdateTableInRealTime() {
return updateTableInRealTime;
---
old/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeCellEditor.java
2015-04-01 22:34:29.004472487 -0700
+++
new/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeCellEditor.java
2015-04-01 22:34:28.836472483 -0700
@@ -477,6 +477,15 @@
return true;
}
+ /**
+ * Determine the offset.
+ * @param tree a <code>JTree</code> object
+ * @param value a value
+ * @param isSelected selection status
+ * @param expanded expansion status
+ * @param leaf leaf status
+ * @param row current row
+ */
protected void determineOffset(JTree tree, Object value,
boolean isSelected, boolean expanded,
boolean leaf, int row) {
@@ -653,6 +662,9 @@
// This should not be used. It will be removed when new API is
// allowed.
+ /**
+ * Do not use.
+ */
public void EditorContainer() {
setLayout(null);
}
---
old/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeModel.java 2015-04-01
22:34:29.508472499 -0700
+++
new/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeModel.java 2015-04-01
22:34:29.316472494 -0700
@@ -657,9 +657,8 @@
*
* If no such listeners exist, this method returns an empty array.
*
- * @param listenerType the type of listeners requested; this parameter
- * should specify an interface that descends from
- * <code>java.util.EventListener</code>
+ * @param <T> the listener type
+ * @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such
---
old/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeSelectionModel.java
2015-04-01 22:34:29.984472510 -0700
+++
new/src/java.desktop/share/classes/javax/swing/tree/DefaultTreeSelectionModel.java
2015-04-01 22:34:29.804472505 -0700
@@ -664,9 +664,8 @@
*
* If no such listeners exist, this method returns an empty array.
*
- * @param listenerType the type of listeners requested; this parameter
- * should specify an interface that descends from
- * <code>java.util.EventListener</code>
+ * @param <T> the listener type
+ * @param listenerType the type of listeners requested
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such
---
old/src/java.desktop/share/classes/javax/swing/tree/FixedHeightLayoutCache.java
2015-04-01 22:34:30.492472521 -0700
+++
new/src/java.desktop/share/classes/javax/swing/tree/FixedHeightLayoutCache.java
2015-04-01 22:34:30.320472517 -0700
@@ -74,7 +74,9 @@
private Stack<Stack<TreePath>> tempStacks;
-
+ /**
+ * Constructs a {@code FixedHeightLayoutCache}.
+ */
public FixedHeightLayoutCache() {
super();
tempStacks = new Stack<Stack<TreePath>>();
---
old/src/java.desktop/share/classes/javax/swing/tree/VariableHeightLayoutCache.java
2015-04-01 22:34:30.968472532 -0700
+++
new/src/java.desktop/share/classes/javax/swing/tree/VariableHeightLayoutCache.java
2015-04-01 22:34:30.808472529 -0700
@@ -88,6 +88,9 @@
private Stack<Stack<TreePath>> tempStacks;
+ /**
+ * Constructs a {@code VariableHeightLayoutCache}.
+ */
public VariableHeightLayoutCache() {
super();
tempStacks = new Stack<Stack<TreePath>>();
---
old/src/java.desktop/share/classes/javax/swing/undo/CompoundEdit.java
2015-04-01 22:34:31.464472544 -0700
+++
new/src/java.desktop/share/classes/javax/swing/undo/CompoundEdit.java
2015-04-01 22:34:31.288472540 -0700
@@ -45,6 +45,9 @@
*/
protected Vector<UndoableEdit> edits;
+ /**
+ * Constructs a {@code CompoundEdit}.
+ */
public CompoundEdit() {
super();
inProgress = true;
--- old/src/java.desktop/share/classes/javax/swing/undo/StateEdit.java
2015-04-01 22:34:31.912472554 -0700
+++ new/src/java.desktop/share/classes/javax/swing/undo/StateEdit.java
2015-04-01 22:34:31.748472550 -0700
@@ -59,6 +59,9 @@
public class StateEdit
extends AbstractUndoableEdit {
+ /**
+ * Obsolete RCS version identity.
+ */
protected static final String RCSID = "$Id: StateEdit.java,v 1.6
1997/10/01 20:05:51 sandipc Exp $";
//
@@ -114,6 +117,11 @@
init (anObject,name);
}
+ /**
+ * Initialize the state edit.
+ * @param anObject The object to watch for changing state
+ * @param name The presentation name to be used for this edit
+ */
protected void init (StateEditable anObject, String name) {
this.object = anObject;
this.preState = new Hashtable<Object, Object>(11);
---
old/src/java.desktop/share/classes/javax/swing/undo/UndoableEditSupport.java
2015-04-01 22:34:32.448472567 -0700
+++
new/src/java.desktop/share/classes/javax/swing/undo/UndoableEditSupport.java
2015-04-01 22:34:32.260472562 -0700
@@ -34,9 +34,21 @@
* @author Ray Ryan
*/
public class UndoableEditSupport {
+ /**
+ * The update level.
+ */
protected int updateLevel;
+ /**
+ * The compound edit.
+ */
protected CompoundEdit compoundEdit;
+ /**
+ * The list of listeners.
+ */
protected Vector<UndoableEditListener> listeners;
+ /**
+ * The real source.
+ */
protected Object realSource;
/**
