[hibernate-commits] Hibernate SVN: r10468 - branches/Branch_3_2/Hibernate3/src/org/hibernate

[hibernate-commits at lists.jboss.org]

Author: steve.ebersole at jboss.com
Date: 2006-09-08 08:23:08 -0400 (Fri, 08 Sep 2006)
New Revision: 10468

Modified:
   branches/Branch_3_2/Hibernate3/src/org/hibernate/FlushMode.java
Log:
HHH-2042 : FlushMode javadoc

Modified: branches/Branch_3_2/Hibernate3/src/org/hibernate/FlushMode.java
===================================================================
--- branches/Branch_3_2/Hibernate3/src/org/hibernate/FlushMode.java	2006-09-06 23:07:54 UTC (rev 10467)
+++ branches/Branch_3_2/Hibernate3/src/org/hibernate/FlushMode.java	2006-09-08 12:23:08 UTC (rev 10468)
@@ -11,6 +11,9 @@
  * and executing SQL statements.
  *
  * @see Session#setFlushMode(FlushMode)
+ * @see Query#setFlushMode(FlushMode)
+ * @see Criteria#setFlushMode(FlushMode)
+ *
  * @author Gavin King
  */
 public final class FlushMode implements Serializable {
@@ -23,12 +26,13 @@
 		this.level = level;
 		this.name = name;
 	}
+
 	public String toString() {
 		return name;
 	}
 
 	/**
-	 * The <tt>Session</tt> is never flushed unless <tt>flush()</tt>
+	 * The {@link Session} is never flushed unless {@link Session#flush}
 	 * is explicitly called by the application. This mode is very
 	 * efficient for read only transactions.
 	 *
@@ -37,27 +41,27 @@
 	public static final FlushMode NEVER = new FlushMode( 0, "NEVER" );
 
 	/**
-	 * The <tt>Session</tt> is onyl eve flushed when <tt>flush()</tt>
+	 * The {@link Session} is only ever flushed when {@link Session#flush}
 	 * is explicitly called by the application. This mode is very
 	 * efficient for read only transactions.
 	 */
 	public static final FlushMode MANUAL = new FlushMode( 0, "MANUAL" );
 
 	/**
-	 * The <tt>Session</tt> is flushed when <tt>Transaction.commit()</tt>
+	 * The {@link Session} is flushed when {@link Transaction#commit}
 	 * is called.
 	 */
 	public static final FlushMode COMMIT = new FlushMode(5, "COMMIT");
 
 	/**
-	 * The <tt>Session</tt> is sometimes flushed before query execution
+	 * The {@link Session} is sometimes flushed before query execution
 	 * in order to ensure that queries never return stale state. This
 	 * is the default flush mode.
 	 */
 	public static final FlushMode AUTO = new FlushMode(10, "AUTO");
 
 	/**
-	 * The <tt>Session</tt> is flushed before every query. This is
+	 * The {@link Session} is flushed before every query. This is
 	 * almost always unnecessary and inefficient.
 	 */
 	public static final FlushMode ALWAYS = new FlushMode(20, "ALWAYS");
@@ -86,9 +90,3 @@
 		return ( FlushMode ) INSTANCES.get( name );
 	}
 }
-
-
-
-
-
-