Add javadoc

src/Example.java

@@ -9,7 +9,6 @@
  * express or implied. See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 import java.awt.Dimension;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;

src/javax/swing/CheckListModel.java

@@ -14,22 +14,62 @@
 
 import java.util.Collection;
 
+/**
+ * Extended list model.
+ *
+ * @param <E> Type of element in this model.
+ */
 public interface CheckListModel<E> extends ListModel<E> {
 
+  /**
+   * Add an item to the check list.
+   *
+   * @param router Item
+   */
   public void addItem(E router);
 
+  /**
+   * Check an item.
+   *
+   * @param index Index of the item to check.
+   * @return Checked item
+   */
   public E checkItem(int index);
 
+  /**
+   * Check an item.
+   *
+   * @param item Item to check.
+   * @return Checked item
+   */
   public E checkItem(E item);
 
+  /** Clear the list. */
   public void clear();
 
+  /**
+   * Returns a collection of checked item.
+   *
+   * @return Collection of checked items.
+   */
   public Collection<E> getCheckedItems();
 
   @Override
   public E getElementAt(int index);
 
+  /**
+   * Tests if an item is checked.
+   *
+   * @param index Index of the item to test.
+   * @return True if the item is checked
+   */
   public boolean isChecked(int index);
 
-  public E troggleItem(int index);
+  /**
+   * Toggle the state of an item.
+   *
+   * @param index Index of the item to toggle
+   * @return The item
+   */
+  public E toggleItem(int index);
 }

src/javax/swing/CheckListSelectionListener.java

@@ -12,6 +12,11 @@
 
 package javax.swing;
 
+/**
+ * Selection listener.
+ *
+ * @param <T> Item
+ */
 public interface CheckListSelectionListener<T> {
   void selectionChanged(T item);
 }

src/javax/swing/DefaultCheckListModel.java

@@ -20,9 +20,11 @@
 
 public class DefaultCheckListModel<E> extends AbstractListModel<E> implements CheckListModel<E> {
 
-  private static final long serialVersionUID = 1L;
+  private static final long serialVersionUID = 726416792816178211L;
+
   private List<CheckableItem<E>> list;
 
+  /** Default constructor. */
   public DefaultCheckListModel() {
     list = new ArrayList<>();
   }
@@ -101,7 +103,7 @@ public boolean isChecked(int index) {
   }
 
   @Override
-  public E troggleItem(int index) {
+  public E toggleItem(int index) {
     CheckableItem<E> item = list.get(index);
     item.setSelected(!item.isSelected());
     fireContentsChanged(this, list.indexOf(item), list.indexOf(item));

src/javax/swing/JCheckList.java

@@ -24,10 +24,20 @@
 /** A JList with checkable items. */
 public class JCheckList<E> extends JList<E> {
 
+  /**
+   * Inner class representing a checkable item.
+   *
+   * @param <T> Item value
+   */
   public static class CheckableItem<T> {
     private boolean isSelected;
     private T value;
 
+    /**
+     * Constructor.
+     *
+     * @param value Item value
+     */
     public CheckableItem(T value) {
       this.value = value;
       isSelected = false;
@@ -59,6 +69,11 @@ public boolean equals(Object obj) {
       return false;
     }
 
+    /**
+     * Returns the item value.
+     *
+     * @return Item value
+     */
     public T getValue() {
       return value;
     }
@@ -71,10 +86,20 @@ public int hashCode() {
       return result;
     }
 
+    /**
+     * Tests if the item is selected.
+     *
+     * @return True if selected
+     */
     public boolean isSelected() {
       return isSelected;
     }
 
+    /**
+     * Selects the item.
+     *
+     * @param newValue True to select, false to unselect
+     */
     public void setSelected(boolean newValue) {
       isSelected = newValue;
     }
@@ -85,9 +110,11 @@ public String toString() {
     }
   }
 
+  /** Inner class to render the check list. */
   protected class CheckListRenderer extends JCheckBox implements ListCellRenderer<Object> {
     private static final long serialVersionUID = 1L;
 
+    /** Constructor. */
     public CheckListRenderer() {
       setBackground(UIManager.getColor("List.textBackground"));
       setForeground(UIManager.getColor("List.textForeground"));
@@ -129,7 +156,7 @@ public void mouseClicked(MouseEvent e) {
             if (index == -1) {
               return;
             }
-            E item = getModel().troggleItem(index);
+            E item = getModel().toggleItem(index);
             Rectangle rect = getCellBounds(index, index);
             repaint(rect);
             fireCheckListSelectionChanged(item);
@@ -154,10 +181,20 @@ public void intervalRemoved(ListDataEvent e) {
         };
   }
 
+  /**
+   * Adds a selection listener.
+   *
+   * @param listener The CheckListSelectionListener to add
+   */
   public void addCheckListSelectionListener(CheckListSelectionListener<E> listener) {
     listeners.add(listener);
   }
 
+  /**
+   * Checks an item.
+   *
+   * @param element The item to check.
+   */
   public void checkItem(E element) {
     E item = getModel().checkItem(element);
     fireCheckListSelectionChanged(item);
@@ -181,6 +218,12 @@ protected void fireCheckListSelectionChanged(E item) {
     }
   }
 
+  /**
+   * Gets an item.
+   *
+   * @param index The index of gthe item to get.
+   * @return The item.
+   */
   public E getItem(int index) {
     return model.getElementAt(index);
   }
@@ -190,10 +233,21 @@ public CheckListModel<E> getModel() {
     return model;
   }
 
+  /**
+   * Tests if an item is checked.
+   *
+   * @param index The index of the item to check
+   * @return The item
+   */
   public boolean isChecked(int index) {
     return model.isChecked(index);
   }
 
+  /**
+   * Removes the selection listener.
+   *
+   * @param listener The listener to remove
+   */
   public void removeCheckListSelectionListener(CheckListSelectionListener<E> listener) {
     listeners.remove(listener);
   }