From a1ac2f7c1d4abeacb999e46fb5261bfb52e1a4c7 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Mon, 3 Sep 2018 11:19:25 +0200 Subject: [PATCH] DATAMONGO-2075 - Polishing. Tweaks to Javadoc and reference docs to align with american-english spelling. Original pull request: #606. --- .../data/mongodb/MongoTransactionManager.java | 9 +++++---- .../asciidoc/reference/client-session-transactions.adoc | 6 +++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoTransactionManager.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoTransactionManager.java index f884572d4..3ec5eb731 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoTransactionManager.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoTransactionManager.java @@ -51,8 +51,8 @@ import com.mongodb.client.ClientSession; * By default failure of a {@literal commit} operation raises a {@link TransactionSystemException}. One may override * {@link #doCommit(MongoTransactionObject)} to implement the * Retry Commit Operation - * behaviour as outlined in the MongoDB reference manual. - * + * behavior as outlined in the MongoDB reference manual. + * * @author Christoph Strobl * @author Mark Paluch * @currentRead Shadow's Edge - Brent Weeks @@ -75,7 +75,7 @@ public class MongoTransactionManager extends AbstractPlatformTransactionManager *

* Optionally it is possible to set default {@link TransactionOptions transaction options} defining * {@link com.mongodb.ReadConcern} and {@link com.mongodb.WriteConcern}. - * + * * @see #setDbFactory(MongoDbFactory) * @see #setTransactionSynchronization(int) */ @@ -227,8 +227,9 @@ public class MongoTransactionManager extends AbstractPlatformTransactionManager * } while (--retries > 0); * * - * + * * @param transactionObject never {@literal null}. + * @throws Exception in case of transaction errors. */ protected void doCommit(MongoTransactionObject transactionObject) throws Exception { transactionObject.commitTransaction(); diff --git a/src/main/asciidoc/reference/client-session-transactions.adoc b/src/main/asciidoc/reference/client-session-transactions.adoc index 887deaa1c..0fd672aa8 100644 --- a/src/main/asciidoc/reference/client-session-transactions.adoc +++ b/src/main/asciidoc/reference/client-session-transactions.adoc @@ -317,11 +317,11 @@ structures in place. *Transient Errors* -MongoDB can add special labels to errors raised during a transactional execution. Those may indicate transient failures -that might vanish by simply retrying the operation. +MongoDB can add special labels to errors raised during transactional execution. Those may indicate transient failures +that might vanish by merely retrying the operation. We highly recommend https://github.com/spring-projects/spring-retry[Spring Retry] for those purposes. Nevertheless one may override `MongoTransactionManager#doCommit(MongoTransactionObject)` to implement a https://docs.mongodb.com/manual/core/transactions/#retry-commit-operation[Retry Commit Operation] -behaviour as outlined in the MongoDB reference manual. +behavior as outlined in the MongoDB reference manual. *Count*