[hibernate-commits] Hibernate SVN: r10735 - trunk/Hibernate3/src/org/hibernate

[hibernate-commits at lists.jboss.org]

Author: christian.bauer at jboss.com
Date: 2006-11-06 13:07:45 -0500 (Mon, 06 Nov 2006)
New Revision: 10735

Modified:
   trunk/Hibernate3/src/org/hibernate/Session.java
Log:
Fixed Javadoc

Modified: trunk/Hibernate3/src/org/hibernate/Session.java
===================================================================
--- trunk/Hibernate3/src/org/hibernate/Session.java	2006-11-06 18:07:22 UTC (rev 10734)
+++ trunk/Hibernate3/src/org/hibernate/Session.java	2006-11-06 18:07:45 UTC (rev 10735)
@@ -236,7 +236,8 @@
 
 	/**
 	 * Return the persistent instance of the given entity class with the given identifier,
-	 * assuming that the instance exists.
+	 * assuming that the instance exists. This method might return a proxied instance that
+	 * is initialized on-demand, when a non-identifier method is accessed.
 	 * <br><br>
 	 * You should not use this method to determine if an instance exists (use <tt>get()</tt>
 	 * instead). Use this only to retrieve an instance that you assume exists, where non-existence
@@ -251,7 +252,8 @@
 
 	/**
 	 * Return the persistent instance of the given entity class with the given identifier,
-	 * assuming that the instance exists.
+	 * assuming that the instance exists. This method might return a proxied instance that
+	 * is initialized on-demand, when a non-identifier method is accessed.
 	 * <br><br>
 	 * You should not use this method to determine if an instance exists (use <tt>get()</tt>
 	 * instead). Use this only to retrieve an instance that you assume exists, where non-existence
@@ -324,7 +326,7 @@
 	 * with <tt>cascade="save-update"</tt>.
 	 *
 	 * @see Session#save(java.lang.Object)
-	 * @see Session#update(Object object, Serializable id)
+	 * @see Session#update(Object object)
 	 * @param object a transient or detached instance containing new or updated state
 	 * @throws HibernateException
 	 */
@@ -338,7 +340,7 @@
 	 * with <tt>cascade="save-update"</tt>.
 	 *
 	 * @see Session#save(java.lang.Object)
-	 * @see Session#update(Object object, Serializable id)
+	 * @see Session#update(Object object)
 	 * @param object a transient or detached instance containing new or updated state
 	 * @throws HibernateException
 	 */
@@ -611,8 +613,9 @@
 
 	/**
 	 * Return the persistent instance of the given entity class with the given identifier,
-	 * or null if there is no such persistent instance. (If the instance, or a proxy for the
-	 * instance, is already associated with the session, return that instance or proxy.)
+	 * or null if there is no such persistent instance. (If the instance is already associated
+	 * with the session, return that instance. This method never returns an unitialized instance.)
+	 * Obtain the specified lock mode if the instance exists.
 	 *
 	 * @param clazz a persistent class
 	 * @param id an identifier
@@ -623,8 +626,9 @@
 
 	/**
 	 * Return the persistent instance of the given entity class with the given identifier,
-	 * or null if there is no such persistent instance. Obtain the specified lock mode
-	 * if the instance exists.
+	 * or null if there is no such persistent instance. (If the instance is already associated
+	 * with the session, return that instance. This method never returns an unitialized instance.)
+	 * Obtain the specified lock mode if the instance exists.
 	 *
 	 * @param clazz a persistent class
 	 * @param id an identifier
@@ -636,8 +640,8 @@
 
 	/**
 	 * Return the persistent instance of the given named entity with the given identifier,
-	 * or null if there is no such persistent instance. (If the instance, or a proxy for the
-	 * instance, is already associated with the session, return that instance or proxy.)
+	 * or null if there is no such persistent instance. (If the instance is already associated
+	 * with the session, return that instance. This method never returns an unitialized instance.)
 	 *
 	 * @param entityName the entity name
 	 * @param id an identifier
@@ -648,8 +652,9 @@
 
 	/**
 	 * Return the persistent instance of the given entity class with the given identifier,
-	 * or null if there is no such persistent instance. Obtain the specified lock mode
-	 * if the instance exists.
+	 * or null if there is no such persistent instance. (If the instance is already associated
+	 * with the session, return that instance. This method never returns an unitialized instance.)
+	 * Obtain the specified lock mode if the instance exists.
 	 *
 	 * @param entityName the entity name
 	 * @param id an identifier