Reviewed javadoc.

This commit is contained in:
Ulrik Sandberg
2007-10-08 21:25:50 +00:00
parent 848b2a7903
commit 42c2e80e85
3 changed files with 13 additions and 12 deletions

View File

@@ -27,11 +27,12 @@ package org.springframework.transaction.compensating;
* {@link #performOperation()} method of a
* CompensatingTransactionOperationExecutor implementation would actually delete
* the entry, leaving it for the {@link #rollback()} method to recreate it using
* data from the original entry. In an LDAP system for instance this will not be
* possible, because it might not be possible to retrieve all the stored data
* from the original entry. In that case, the {@link #performOperation()} method
* will instead move the entry to a temporary location and leave it for the
* {@link #commit()} method to actually remove the entry.
* data from the original entry. However, this will not always be possible. In
* an LDAP system, for instance, it might not be possible to retrieve all the
* stored data from the original entry. In that case, the
* {@link #performOperation()} method will instead move the entry to a temporary
* location and leave it for the {@link #commit()} method to actually remove the
* entry.
*
* @author Mattias Arthursson
* @since 1.2
@@ -45,9 +46,9 @@ public interface CompensatingTransactionOperationExecutor {
public void rollback();
/**
* Commit the operation. In many cases this will not require any work at all
* to be performed. However in some cases there will be interesting stuff to
* do. See class description for elaboration on this.
* Commit the operation. In many cases, this will not require any work at
* all to be performed. However, in some cases there will be interesting
* stuff to do. See class description for elaboration on this.
*/
public void commit();

View File

@@ -17,7 +17,7 @@ package org.springframework.transaction.compensating;
/**
* A CompensatingTransactionOperationManager implementation records and performs
* operations that are to be performed within a compensating transaction and
* operations that are to be performed within a compensating transaction. It
* keeps track of compensating actions necessary for rolling back each
* individual operation.
*
@@ -42,7 +42,7 @@ public interface CompensatingTransactionOperationManager {
Object[] args);
/**
* Rollback all recorded operations, by performing each of the recorded
* Rollback all recorded operations by performing each of the recorded
* rollback operations.
*/
public void rollback();

View File

@@ -19,8 +19,8 @@ package org.springframework.transaction.compensating;
* An implementation of this interface is responsible for recording data and
* supplying a {@link CompensatingTransactionOperationExecutor} to be invoked
* for execution and compensating transaction management of the operation.
* Recording of an operation should not fail (throwing an Exception), but rather
* log the result.
* Recording of an operation should not fail (throwing an Exception), but
* instead log the result.
*
* @author Mattias Arthursson
* @since 1.2