[jboss-cvs] jboss-seam/src/main/org/jboss/seam/annotations/datamodel ...

[Gavin King]

  User: gavin   
  Date: 06/09/18 12:43:02

  Modified:    src/main/org/jboss/seam/annotations/datamodel   
                        DataModel.java DataModelSelection.java
                        DataModelSelectionIndex.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.6       +14 -4     jboss-seam/src/main/org/jboss/seam/annotations/datamodel/DataModel.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: DataModel.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/annotations/datamodel/DataModel.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -b -r1.5 -r1.6
  --- DataModel.java	22 May 2006 03:48:39 -0000	1.5
  +++ DataModel.java	18 Sep 2006 16:43:02 -0000	1.6
  @@ -1,4 +1,4 @@
  -//$Id: DataModel.java,v 1.5 2006/05/22 03:48:39 gavin Exp $
  +//$Id: DataModel.java,v 1.6 2006/09/18 16:43:02 gavin Exp $
   package org.jboss.seam.annotations.datamodel;
   
   import static java.lang.annotation.ElementType.FIELD;
  @@ -12,16 +12,26 @@
   import org.jboss.seam.ScopeType;
   import org.jboss.seam.annotations.DataBinderClass;
   import org.jboss.seam.databinding.DataModelBinder;
  +import org.jboss.seam.jsf.ListDataModel;
  +import org.jboss.seam.jsf.MapDataModel;
   
   /**
  - * Outjects a List to the same scope as the owning component
  + * Outjects a collection to the same scope as the owning component
    * (or to the EVENT scope in the case of a stateless component),
  - * after wrapping as a ListDataModel. Note that the List
  + * after wrapping as a JSF DataModel (a List as a ListDataModel, a
  + * Map as a MapDataModel, a Set as a SetDataModel, an array as an 
  + * ArrayDataModel). Note that the List, Map, Set or array
    * will be re-wrapped and re-outjected each time the current
    * component value is different to the value held by the
  - * context variable as determined by calling List.equals().
  + * context variable as determined by calling equals() on the 
  + * underlying collection.
    * 
    * @author Gavin King
  + * 
  + * @see org.jboss.seam.jsf.ListDataModel
  + * @see org.jboss.seam.jsf.MapDataModel
  + * @see org.jboss.seam.jsf.SetDataModel
  + * @see org.jboss.seam.jsf.ArrayDataModel
    */
   @Target({FIELD, METHOD})
   @Retention(RUNTIME)
  
  
  
  1.5       +4 -3      jboss-seam/src/main/org/jboss/seam/annotations/datamodel/DataModelSelection.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: DataModelSelection.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/annotations/datamodel/DataModelSelection.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -b -r1.4 -r1.5
  --- DataModelSelection.java	22 May 2006 03:48:39 -0000	1.4
  +++ DataModelSelection.java	18 Sep 2006 16:43:02 -0000	1.5
  @@ -1,4 +1,4 @@
  -//$Id: DataModelSelection.java,v 1.4 2006/05/22 03:48:39 gavin Exp $
  +//$Id: DataModelSelection.java,v 1.5 2006/09/18 16:43:02 gavin Exp $
   package org.jboss.seam.annotations.datamodel;
   
   import static java.lang.annotation.ElementType.FIELD;
  @@ -13,10 +13,11 @@
   import org.jboss.seam.databinding.DataModelSelector;
   
   /**
  - * Injects the selected row data of a ListDataModel. Intended
  - * for use with @DataModel.
  + * Injects the selected row data of a DataModel. 
  + * Intended for use with @DataModel.
    * 
    * @author Gavin King
  + * @see DataModel
    */
   @Target({FIELD, METHOD})
   @Retention(RUNTIME)
  
  
  
  1.5       +5 -3      jboss-seam/src/main/org/jboss/seam/annotations/datamodel/DataModelSelectionIndex.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: DataModelSelectionIndex.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/annotations/datamodel/DataModelSelectionIndex.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -b -r1.4 -r1.5
  --- DataModelSelectionIndex.java	22 May 2006 03:48:39 -0000	1.4
  +++ DataModelSelectionIndex.java	18 Sep 2006 16:43:02 -0000	1.5
  @@ -1,4 +1,4 @@
  -//$Id: DataModelSelectionIndex.java,v 1.4 2006/05/22 03:48:39 gavin Exp $
  +//$Id: DataModelSelectionIndex.java,v 1.5 2006/09/18 16:43:02 gavin Exp $
   package org.jboss.seam.annotations.datamodel;
   
   import static java.lang.annotation.ElementType.FIELD;
  @@ -13,10 +13,12 @@
   import org.jboss.seam.databinding.DataModelIndexSelector;
   
   /**
  - * Injects the selected row index of a ListDataModel. Intended
  - * for use with @DataModel.
  + * Injects the selected row index of a ListDataModel,
  + * MapDataModel or ArrayDataModel. Intended for use 
  + * with @DataModel.
    * 
    * @author Gavin King
  + * @see DataModel
    */
   @Target({FIELD, METHOD})
   @Retention(RUNTIME)