Permalink
Browse files

Javadoc changes

  • Loading branch information...
1 parent b83ab01 commit 993bae5aefb8f0aeb30d9184acc8ee7ffa3dd56b @TheNavigateur TheNavigateur committed Nov 25, 2011
Showing with 3 additions and 3 deletions.
  1. +3 −3 core/src/main/java/org/prevayler/Transaction.java
View
6 core/src/main/java/org/prevayler/Transaction.java
@@ -7,11 +7,11 @@
import java.io.Serializable;
import java.util.Date;
-/** An atomic transaction to be executed on a Prevalent System. Any operation which changes the observable state of a Prevalent System must be encapsulated in a Transaction.
+/** An atomic transaction to be executed on a Prevalent System.
* <br>
- * <br>IMPORTANT: Transaction objects CANNOT reference business objects directly. Instead, you must search for the business objects you need via the given <code>prevalentSystem</code>. See org.prevayler.demos for usage examples.
+ * <br>To be recoverable, any changes to the observable state of a Prevalent System must be encapsulated in Transactions and performed via the given <code>prevalentSystem</code> in each Transaction.
* <br>
- * <br>Business objects referenced by a Transaction object will be mere copies of the original business objects when that Transaction is recovered from the serialized journal file. This will make the transactions work when they are executed for the first time but have no effect during shutdown recovery. This is known as the prevalence baptism problem because everyone comes across it, despite this warning.
+ * <br>Upon recovery execution, anything outside <code>prevalentSystem</code> will be a freshly deserialized copy, so cannot reference anything in the Prevalent System.
* <br>
* @param <P> The type or any supertype of the Prevalent System you intend to perform the transaction upon. <br>
*/

0 comments on commit 993bae5

Please sign in to comment.