From: <one...@us...> - 2003-04-25 03:41:06
|
Update of /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine In directory sc8-pr-cvs1:/tmp/cvs-serv29107/hibernate/engine Modified Files: Batcher.java Cascades.java CollectionSnapshot.java Key.java Mapping.java RowSelection.java SessionFactoryImplementor.java SessionImplementor.java TypedValue.java Versioning.java Log Message: JavaDoc refresh, including @author tags Index: Batcher.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/Batcher.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Batcher.java 5 Jan 2003 02:11:20 -0000 1.3 --- Batcher.java 25 Apr 2003 03:40:32 -0000 1.4 *************** *** 12,17 **** --- 12,19 ---- * exists for the whole session, even when batching is disabled. * Provides transparent <tt>PreparedStatement</tt> caching. + * * @see java.sql.PreparedStatement * @see net.sf.hibernate.impl.SessionImpl + * @author Gavin King */ public interface Batcher { Index: Cascades.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/Cascades.java,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** Cascades.java 21 Apr 2003 06:34:46 -0000 1.13 --- Cascades.java 25 Apr 2003 03:40:32 -0000 1.14 *************** *** 20,24 **** --- 20,26 ---- /** * Implements cascaded save / delete / update / evict + * * @see net.sf.hibernate.type.AssociationType + * @author Gavin King */ public final class Cascades { Index: CollectionSnapshot.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/CollectionSnapshot.java,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** CollectionSnapshot.java 9 Feb 2003 06:28:15 -0000 1.2 --- CollectionSnapshot.java 25 Apr 2003 03:40:32 -0000 1.3 *************** *** 4,7 **** --- 4,15 ---- import java.io.Serializable; + /** + * A "snapshot" of collection state. A <tt>PersistentCollection</tt> + * carries a snapshot of its state even when serialized and transported + * to another process. This allows us to track exactly which rows changed + * if the entity is passed to <tt>update()</tt>. + * + * @author Gavin King + */ public interface CollectionSnapshot extends Serializable { public Serializable getKey(); Index: Key.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/Key.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** Key.java 20 Mar 2003 13:59:05 -0000 1.5 --- Key.java 25 Apr 2003 03:40:32 -0000 1.6 *************** *** 11,14 **** --- 11,15 ---- * A globally unique identifier of an instance, consisting of the * user-visible identifier and the identifier space (eg. tablename). + * @author Gavin King */ public final class Key implements Serializable { Index: Mapping.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/Mapping.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** Mapping.java 26 Jan 2003 01:33:35 -0000 1.4 --- Mapping.java 25 Apr 2003 03:40:32 -0000 1.5 *************** *** 9,15 **** --- 9,17 ---- * and "uncompiled" mappings (ie. <tt>Configuration</tt>) that are used by * implementors of <tt>Type</tt>. + * * @see net.sf.hibernate.type.Type * @see net.sf.hibernate.impl.SessionFactoryImpl * @see net.sf.hibernate.cfg.Configuration + * @author Gavin King */ public interface Mapping { Index: RowSelection.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/RowSelection.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** RowSelection.java 5 Jan 2003 02:11:20 -0000 1.3 --- RowSelection.java 25 Apr 2003 03:40:32 -0000 1.4 *************** *** 2,5 **** --- 2,9 ---- package net.sf.hibernate.engine; + /** + * Represents a selection or rows in a JDBC <tt>ResultSet</tt> + * @author Gavin King + */ public final class RowSelection { private Integer firstRow; Index: SessionFactoryImplementor.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/SessionFactoryImplementor.java,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** SessionFactoryImplementor.java 10 Apr 2003 09:49:16 -0000 1.8 --- SessionFactoryImplementor.java 25 Apr 2003 03:40:32 -0000 1.9 *************** *** 18,23 **** --- 18,25 ---- * Defines the internal contract between the <tt>SessionFactory</tt> and other parts of * Hibernate such as implementors of <tt>Type</tt>. + * * @see net.sf.hibernate.SessionFactory * @see net.sf.hibernate.impl.SessionFactoryImpl + * @author Gavin King */ public interface SessionFactoryImplementor extends Mapping, SessionFactory { Index: SessionImplementor.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/SessionImplementor.java,v retrieving revision 1.11 retrieving revision 1.12 diff -C2 -d -r1.11 -r1.12 *** SessionImplementor.java 6 Apr 2003 10:11:09 -0000 1.11 --- SessionImplementor.java 25 Apr 2003 03:40:32 -0000 1.12 *************** *** 25,28 **** --- 25,29 ---- * @see net.sf.hibernate.Session the interface to the application * @see net.sf.hibernate.impl.SessionImpl the actual implementation + * @author Gavin King */ public interface SessionImplementor extends Session { Index: TypedValue.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/TypedValue.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** TypedValue.java 5 Jan 2003 02:11:20 -0000 1.3 --- TypedValue.java 25 Apr 2003 03:40:32 -0000 1.4 *************** *** 5,8 **** --- 5,13 ---- import net.sf.hibernate.type.Type; + /** + * An ordered pair of a value and its Hibernate type. + * @see net.sf.hibernate.type.Type + * @author Gavin King + */ public final class TypedValue { private Type type; Index: Versioning.java =================================================================== RCS file: /cvsroot/hibernate/Hibernate2/src/net/sf/hibernate/engine/Versioning.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** Versioning.java 5 Jan 2003 02:11:20 -0000 1.3 --- Versioning.java 25 Apr 2003 03:40:32 -0000 1.4 *************** *** 11,14 **** --- 11,15 ---- /** * Utility methods for managing versions and timestamps + * @author Gavin King */ public final class Versioning { |