Revision: 1676
          http://svn.sourceforge.net/spring-rich-c/?rev=1676&view=rev
Author:   kevinstembridge
Date:     2007-01-18 07:30:57 -0800 (Thu, 18 Jan 2007)

Log Message:
-----------
Added javadoc

Modified Paths:
--------------
    
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/table/MutableTableModel.java

Modified: 
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/table/MutableTableModel.java
===================================================================
--- 
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/table/MutableTableModel.java
   2007-01-18 15:29:48 UTC (rev 1675)
+++ 
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/table/MutableTableModel.java
   2007-01-18 15:30:57 UTC (rev 1676)
@@ -20,18 +20,73 @@
 import javax.swing.table.TableModel;
 
 /**
+ * A table model whose contents can change.
+ * 
  * @author Keith Donald
  */
 public interface MutableTableModel extends TableModel {
+    
+    /**
+     * Adds the given row to the end of the list of existing rows in the table 
model. All 
+     * registered table model listeners will be notified of the additional row.
+     * 
+     * @param row The row to be added. Must not be null.
+     * 
+     * @throws IllegalArgumentException if [EMAIL PROTECTED] row} is null.
+     */
     public void addRow(Object row);
 
+    /**
+     * Adds the given rows to the end of the list of existing rows in the 
table model. All 
+     * registered table model listeners will be notified of the additional 
rows.
+     *
+     * @param rows The rows to be added. May be empty but must not be null.
+     * 
+     * @throws IllegalArgumentException if [EMAIL PROTECTED] rows} is null.
+     */
     public void addRows(List rows);
 
+    /**
+     * Removes from the table model the row at the given position in the list 
of rows. All 
+     * registered table model listeners will be notified of the removal of the 
row. 
+     *
+     * @param index The zero-based position of the row to be removed.
+     * 
+     * @throws IndexOutOfBoundsException if [EMAIL PROTECTED] index} is not 
within the bounds of the 
+     * model's collection of rows.
+     */
     public void remove(int index);
 
+    /**
+     * Removes all of the rows from [EMAIL PROTECTED] firstIndex} to [EMAIL 
PROTECTED] lastIndex} inclusive. All 
+     * registered table model listeners will be notified of the removal of the 
rows.
+     *
+     * @param firstIndex The zero-based position of the first row to be 
removed.
+     * @param lastIndex The zero-based position of the last row to be removed.
+     * 
+     * @throws IllegalArgumentException if [EMAIL PROTECTED] lastIndex} is 
less than [EMAIL PROTECTED] firstIndex}.
+     * @throws IndexOutOfBoundsException if either argument is outside the 
bounds of the 
+     * number of rows in the model.
+     */
     public void remove(int firstIndex, int lastIndex);
 
+    /**
+     * Removes the rows at each of the given positions. All registered table 
model listeners 
+     * will be notified of the removal of the rows.
+     *
+     * @param indexes The array of zero-based indexes of the rows to be 
removed. May be empty
+     * but must not be null.
+     * 
+     * @throws IllegalArgumentException if [EMAIL PROTECTED] indexes} is null.
+     * @throws IndexOutOfBoundsException if any of the elements in the array 
are not within the
+     * bounds of the model's collection of rows.
+     */
     public void remove(int[] indexes);
 
+    /**
+     * Removes all rows from the table model. All registered table model 
listeners will be 
+     * notified of the removal of the rows.
+     */
     public void clear();
-}
\ No newline at end of file
+    
+}


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
spring-rich-c-cvs mailing list
spring-rich-c-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs

Reply via email to