[cp-patches] FYI: ListDataListener - reformatted, added API docs

[David Gilbert]

I committed this patch:

2005-10-17  David Gilbert  <address@hidden>

        * javax/swing/event/ListDataListener:
        reformatted and added API docs.

Regards,

Dave

Index: javax/swing/event/ListDataListener.java
===================================================================
RCS file: /cvsroot/classpath/classpath/javax/swing/event/ListDataListener.java,v
retrieving revision 1.5
diff -u -r1.5 ListDataListener.java
--- javax/swing/event/ListDataListener.java     2 Jul 2005 20:32:50 -0000       
1.5
+++ javax/swing/event/ListDataListener.java     17 Oct 2005 15:43:55 -0000
@@ -1,5 +1,5 @@
 /* ListDataListener.java --
-   Copyright (C) 2002 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Classpath.
 
@@ -37,33 +37,46 @@
 
 package javax.swing.event;
 
-// Imports
 import java.util.EventListener;
 
+import javax.swing.ListModel;
+
 /**
- * ListDataListener public interface
+ * A <code>ListDataListener</code> can register with a address@hidden 
ListModel} and
+ * receive notification of updates to the model.
+ * 
  * @author Andrew Selkirk
  * @author Ronald Veldema
  */
-public interface ListDataListener extends EventListener {
-
-       /**
-        * Contents Changed
-        * @param event ListDataEvent Event
-        */
-       void contentsChanged(ListDataEvent event);
-
-       /**
-        * Interval Added
-        * @param event ListDataEvent Event
-        */
-       void intervalAdded(ListDataEvent event);
-
-       /**
-        * Interval Removed
-        * @param event ListDataEvent Event
-        */
-       void intervalRemoved(ListDataEvent event);
+public interface ListDataListener extends EventListener 
+{
 
+  /**
+   * Notifies the listener that the contents of the list have changed
+   * in some way.  This method will be called if the change cannot be
+   * notified via the address@hidden #intervalAdded(ListDataEvent)} or the
+   * address@hidden #intervalRemoved(ListDataEvent)} methods.
+   * 
+   * @param event  the event.
+   */
+  void contentsChanged(ListDataEvent event);
+
+  /**
+   * Notifies the listener that one or more items have been added to the
+   * list.  The <code>event</code> argument can supply the indices for the
+   * range of items added.
+   * 
+   * @param event  the event.
+   */
+  void intervalAdded(ListDataEvent event);
+
+  /**
+   * Notifies the listener that one or more items have been removed from
+   * the list.  The <code>event</code> argument can supply the indices for 
+   * the range of items removed.
+   * 
+   * @param event  the event.
+   */
+  void intervalRemoved(ListDataEvent event);
 
-} // ListDataListener
+}