[Hibernate-commits] Hibernate2/src/net/sf/hibernate/collection ArrayHolder.java,1.12,1.13 Bag.java,1.11,1.12 CollectionPersister.java,1.20,1.21 List.java,1.11,1.12 Map.java,1.11,1.12 ODMGCollection.java,1.7,1.8 PersistentCollection.java,1.13,1.14 Set.java,1.11,1.12 SortedMap.java,1.8,1.9 SortedSet.java,1.9,1.10

[<one...@us...>]

Update of /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection
In directory sc8-pr-cvs1:/tmp/cvs-serv29107/hibernate/collection

Modified Files:
	ArrayHolder.java Bag.java CollectionPersister.java List.java 
	Map.java ODMGCollection.java PersistentCollection.java 
	Set.java SortedMap.java SortedSet.java 
Log Message:
JavaDoc refresh, including @author tags

Index: ArrayHolder.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/ArrayHolder.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** ArrayHolder.java	6 Apr 2003 10:11:07 -0000	1.12
--- ArrayHolder.java	25 Apr 2003 03:40:30 -0000	1.13
***************
*** 19,25 ****
  /**
   * A persistent wrapper for an array. Lazy initialization
!  * is NOT supported.
   */
- 
  public class ArrayHolder extends PersistentCollection {
  	private Object array;
--- 19,27 ----
  /**
   * A persistent wrapper for an array. Lazy initialization
!  * is NOT supported. Use of Hibernate arrays is not really
!  * recommended.
!  * 
!  * @author Gavin King
   */
  public class ArrayHolder extends PersistentCollection {
  	private Object array;

Index: Bag.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/Bag.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** Bag.java	19 Apr 2003 03:26:07 -0000	1.11
--- Bag.java	25 Apr 2003 03:40:30 -0000	1.12
***************
*** 20,24 ****
  import net.sf.hibernate.type.Type;
  
! 
  public class Bag extends ODMGCollection implements DBag, java.util.List {
  	
--- 20,31 ----
  import net.sf.hibernate.type.Type;
  
! /**
!  * An unordered, unkeyed collection that can contain the same element
!  * multiple times. The Java collections API, bizarrely, has no <tt>Bag</tt>.
!  * Most developers seem to use <tt>List</tt>s to represent bag semantics,
!  * so Hibernate follows this practice.
!  * 
!  * @author Gavin King
!  */
  public class Bag extends ODMGCollection implements DBag, java.util.List {
  	

Index: CollectionPersister.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/CollectionPersister.java,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** CollectionPersister.java	19 Apr 2003 03:26:07 -0000	1.20
--- CollectionPersister.java	25 Apr 2003 03:40:30 -0000	1.21
***************
*** 44,52 ****
  /**
   * Plugs into an instance of <tt>PersistentCollection</tt>, in order to
!  * implement persistence of that collection while in a particular role.
!  *
   * May be considered an immutable view of the mapping object
   */
- 
  public final class CollectionPersister implements CollectionMetadata {
  	
--- 44,57 ----
  /**
   * Plugs into an instance of <tt>PersistentCollection</tt>, in order to
!  * implement persistence of that collection while in a particular role.<br>
!  * <br>
!  * This class is highly coupled to the <tt>PersistentCollection</tt>
!  * hierarchy, since double dispatch is used to load and update collection 
!  * elements.<br>
!  * <br>
   * May be considered an immutable view of the mapping object
+  * 
+  * @author Gavin King
   */
  public final class CollectionPersister implements CollectionMetadata {
  	

Index: List.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/List.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** List.java	6 Apr 2003 10:11:07 -0000	1.11
--- List.java	25 Apr 2003 03:40:31 -0000	1.12
***************
*** 20,24 ****
  
  /**
!  * A persistent wrapper for a java.util.List
   */
  public class List extends ODMGCollection implements java.util.List, DList, DArray {
--- 20,28 ----
  
  /**
!  * A persistent wrapper for a <tt>java.util.List</tt>. Underlying
!  * collection is an <tt>ArrayList</tt>.
!  * 
!  * @see java.util.ArrayList
!  * @author Gavin King
   */
  public class List extends ODMGCollection implements java.util.List, DList, DArray {

Index: Map.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/Map.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** Map.java	6 Apr 2003 10:11:07 -0000	1.11
--- Map.java	25 Apr 2003 03:40:31 -0000	1.12
***************
*** 20,24 ****
  
  /**
!  * A persistent wrapper for a java.util.Map
   */
  public class Map extends PersistentCollection implements java.util.Map, DMap {
--- 20,28 ----
  
  /**
!  * A persistent wrapper for a <tt>java.util.Map</tt>. Underlying collection
!  * is a <tt>HashMap</tt>.
!  * 
!  * @see java.util.HashMap
!  * @author Gavin King
   */
  public class Map extends PersistentCollection implements java.util.Map, DMap {

Index: ODMGCollection.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/ODMGCollection.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -d -r1.7 -r1.8
*** ODMGCollection.java	9 Feb 2003 06:28:14 -0000	1.7
--- ODMGCollection.java	25 Apr 2003 03:40:31 -0000	1.8
***************
*** 10,13 ****
--- 10,21 ----
  import net.sf.hibernate.engine.SessionImplementor;
  
+ /**
+  * All Hibernate collections actually implement the ODMG <tt>DCollection</tt>
+  * interface and are castable to that type. However, we don't recommend that
+  * the object model be "polluted" by using this interface, unless the
+  * application is using the ODMG API.
+  * 
+  * @author Gavin King
+  */
  public abstract class ODMGCollection extends PersistentCollection implements DCollection {
  	

Index: PersistentCollection.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/PersistentCollection.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -d -r1.13 -r1.14
*** PersistentCollection.java	19 Apr 2003 03:26:07 -0000	1.13
--- PersistentCollection.java	25 Apr 2003 03:40:31 -0000	1.14
***************
*** 22,26 ****
  
  /**
!  * Persistent collections are treated as value objects by hibernate.
   * ie. they have no independent existence beyond the object holding
   * a reference to them. Unlike instances of entity classes, they are
--- 22,26 ----
  
  /**
!  * Persistent collections are treated as value objects by Hibernate.
   * ie. they have no independent existence beyond the object holding
   * a reference to them. Unlike instances of entity classes, they are
***************
*** 35,44 ****
   * lazy instantiation of collection elements. The downside is that
   * only certain abstract collection types are supported and any
!  * extra semantics (eg. sorted collections) are lost<br>
   * <br>
!  * Changes to _structure_ of the collection are recorded by the
   * collection calling back to the session. Changes to mutable
   * elements (ie. composite elements) are discovered by cloning their
!  * state when the collection is initialized.
   */
  
--- 35,50 ----
   * lazy instantiation of collection elements. The downside is that
   * only certain abstract collection types are supported and any
!  * extra semantics are lost<br>
   * <br>
!  * Applications should <em>never</em> use classes in this package 
!  * directly, unless extending the "framework" here.<br>
!  * <br>
!  * Changes to <em>structure</em> of the collection are recorded by the
   * collection calling back to the session. Changes to mutable
   * elements (ie. composite elements) are discovered by cloning their
!  * state when the collection is initialized and comparing at flush
!  * time.
!  * 
!  * @author Gavin King
   */
  

Index: Set.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/Set.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** Set.java	6 Apr 2003 10:11:07 -0000	1.11
--- Set.java	25 Apr 2003 03:40:31 -0000	1.12
***************
*** 22,26 ****
  
  /**
!  * A persistent wrapper for a java.util.Set
   */
  public class Set extends ODMGCollection implements java.util.Set, DSet {
--- 22,30 ----
  
  /**
!  * A persistent wrapper for a <tt>java.util.Set</tt>. The underlying
!  * collection is a <tt>HashSet</tt>.
!  * 
!  * @see java.util.HashSet
!  * @author Gavin King
   */
  public class Set extends ODMGCollection implements java.util.Set, DSet {

Index: SortedMap.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/SortedMap.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** SortedMap.java	6 Apr 2003 10:11:07 -0000	1.8
--- SortedMap.java	25 Apr 2003 03:40:31 -0000	1.9
***************
*** 14,21 ****
  
  /**
!  * A persistent wrapper for a java.util.SortedMap
!  *
!  * @version 	1.x
!  * @author		<a href="mailto:dou...@al...">e</a>
   */
  public class SortedMap extends Map implements java.util.SortedMap {
--- 14,22 ----
  
  /**
!  * A persistent wrapper for a <tt>java.util.SortedMap</tt>. Underlying
!  * collection is a <tt>TreeMap</tt>.
!  * 
!  * @see java.util.TreeMap
!  * @author <a href="mailto:dou...@al...">e</a>
   */
  public class SortedMap extends Map implements java.util.SortedMap {

Index: SortedSet.java
===================================================================
RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/collection/SortedSet.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** SortedSet.java	6 Apr 2003 10:11:08 -0000	1.9
--- SortedSet.java	25 Apr 2003 03:40:31 -0000	1.10
***************
*** 13,20 ****
  
  /**
!  * A persistent wrapper for a java.util.SortedSet
!  *
!  * @version 	1.x
!  * @author		<a href="mailto:dou...@al...">e</a>
   */
  public class SortedSet extends Set implements java.util.SortedSet {
--- 13,21 ----
  
  /**
!  * A persistent wrapper for a <tt>java.util.SortedSet</tt>. Underlying
!  * collection is a <tt>TreeSet</tt>.
!  * 
!  * @see java.util.TreeSet
!  * @author <a href="mailto:dou...@al...">e</a>
   */
  public class SortedSet extends Set implements java.util.SortedSet {