Fix warnings/javadocs in sal-distributed-datastore

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / ThreePhaseCommitCohortProxy.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java
index 357ab92c819946ccc9e008db0a6b9fd1ad5bcf2f..17017b9b668ea699d1dab0ecfa7deac2448c84b4 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ThreePhaseCommitCohortProxy.java
@@ -34,7 +34,7 @@ import org.slf4j.LoggerFactory;
 import scala.concurrent.Future;
 
 /**
- * ThreePhaseCommitCohortProxy represents a set of remote cohort proxies
+ * ThreePhaseCommitCohortProxy represents a set of remote cohort proxies.
  */
 public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<ActorSelection> {
 
@@ -76,31 +76,31 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
         this.cohorts = cohorts;
         this.transactionId = Preconditions.checkNotNull(transactionId);
 
-        if(cohorts.isEmpty()) {
+        if (cohorts.isEmpty()) {
             cohortsResolvedFuture.set(null);
         }
     }
 
     private ListenableFuture<Void> resolveCohorts() {
-        if(cohortsResolvedFuture.isDone()) {
+        if (cohortsResolvedFuture.isDone()) {
             return cohortsResolvedFuture;
         }
 
         final AtomicInteger completed = new AtomicInteger(cohorts.size());
-        for(final CohortInfo info: cohorts) {
+        for (final CohortInfo info: cohorts) {
             info.getActorFuture().onComplete(new OnComplete<ActorSelection>() {
                 @Override
                 public void onComplete(Throwable failure, ActorSelection actor)  {
-                    synchronized(completed) {
+                    synchronized (completed) {
                         boolean done = completed.decrementAndGet() == 0;
-                        if(failure != null) {
+                        if (failure != null) {
                             LOG.debug("Tx {}: a cohort Future failed", transactionId, failure);
                             cohortsResolvedFuture.setException(failure);
-                        } else if(!cohortsResolvedFuture.isDone()) {
+                        } else if (!cohortsResolvedFuture.isDone()) {
                             LOG.debug("Tx {}: cohort actor {} resolved", transactionId, actor);
 
                             info.setResolvedActor(actor);
-                            if(done) {
+                            if (done) {
                                 LOG.debug("Tx {}: successfully resolved all cohort actors", transactionId);
                                 cohortsResolvedFuture.set(null);
                             }
@@ -144,7 +144,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
         LOG.debug("Tx {} finishCanCommit", transactionId);
 
         // For empty transactions return immediately
-        if(cohorts.size() == 0){
+        if (cohorts.size() == 0) {
             LOG.debug("Tx {}: canCommit returning result true", transactionId);
             returnFuture.set(Boolean.TRUE);
             return;
@@ -186,7 +186,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
                     return;
                 }
 
-                if(iterator.hasNext() && result) {
+                if (iterator.hasNext() && result) {
                     sendCanCommitTransaction(iterator.next(), this);
                 } else {
                     LOG.debug("Tx {}: canCommit returning result: {}", transactionId, result);
@@ -202,9 +202,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
     private void sendCanCommitTransaction(CohortInfo toCohortInfo, OnComplete<Object> onComplete) {
         CanCommitTransaction message = new CanCommitTransaction(transactionId, toCohortInfo.getActorVersion());
 
-        if(LOG.isDebugEnabled()) {
-            LOG.debug("Tx {}: sending {} to {}", transactionId, message, toCohortInfo.getResolvedActor());
-        }
+        LOG.debug("Tx {}: sending {} to {}", transactionId, message, toCohortInfo.getResolvedActor());
 
         Future<Object> future = actorContext.executeOperationAsync(toCohortInfo.getResolvedActor(),
                 message.toSerializable(), actorContext.getTransactionCommitOperationTimeout());
@@ -213,12 +211,10 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
 
     private Future<Iterable<Object>> invokeCohorts(MessageSupplier messageSupplier) {
         List<Future<Object>> futureList = Lists.newArrayListWithCapacity(cohorts.size());
-        for(CohortInfo cohort : cohorts) {
+        for (CohortInfo cohort : cohorts) {
             Object message = messageSupplier.newMessage(transactionId, cohort.getActorVersion());
 
-            if(LOG.isDebugEnabled()) {
-                LOG.debug("Tx {}: Sending {} to cohort {}", transactionId, message , cohort);
-            }
+            LOG.debug("Tx {}: Sending {} to cohort {}", transactionId, message , cohort);
 
             futureList.add(actorContext.executeOperationAsync(cohort.getResolvedActor(), message,
                     actorContext.getTransactionCommitOperationTimeout()));
@@ -255,15 +251,16 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
                 CommitTransactionReply.class, true, operationCallback);
     }
 
+    @SuppressWarnings("checkstyle:IllegalCatch")
     private static boolean successfulFuture(ListenableFuture<Void> future) {
-        if(!future.isDone()) {
+        if (!future.isDone()) {
             return false;
         }
 
         try {
             future.get();
             return true;
-        } catch(Exception e) {
+        } catch (Exception e) {
             return false;
         }
     }
@@ -279,7 +276,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
         // if not for some reason, we'll try to build it here.
 
         ListenableFuture<Void> future = resolveCohorts();
-        if(successfulFuture(future)) {
+        if (successfulFuture(future)) {
             finishVoidOperation(operationName, messageSupplier, expectedResponseClass, propagateException,
                     returnFuture, callback);
         } else {
@@ -294,7 +291,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
                 public void onFailure(Throwable failure) {
                     LOG.debug("Tx {}: a {} cohort path Future failed: {}", transactionId, operationName, failure);
 
-                    if(propagateException) {
+                    if (propagateException) {
                         returnFuture.setException(failure);
                     } else {
                         returnFuture.set(null);
@@ -319,9 +316,9 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
             @Override
             public void onComplete(Throwable failure, Iterable<Object> responses) throws Throwable {
                 Throwable exceptionToPropagate = failure;
-                if(exceptionToPropagate == null) {
-                    for(Object response: responses) {
-                        if(!response.getClass().equals(expectedResponseClass)) {
+                if (exceptionToPropagate == null) {
+                    for (Object response: responses) {
+                        if (!response.getClass().equals(expectedResponseClass)) {
                             exceptionToPropagate = new IllegalArgumentException(
                                     String.format("Unexpected response type %s", response.getClass()));
                             break;
@@ -329,9 +326,9 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
                     }
                 }
 
-                if(exceptionToPropagate != null) {
+                if (exceptionToPropagate != null) {
                     LOG.debug("Tx {}: a {} cohort Future failed", transactionId, operationName, exceptionToPropagate);
-                    if(propagateException) {
+                    if (propagateException) {
                         // We don't log the exception here to avoid redundant logging since we're
                         // propagating to the caller in MD-SAL core who will log it.
                         returnFuture.setException(exceptionToPropagate);
@@ -357,7 +354,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
     @Override
     List<Future<ActorSelection>> getCohortFutures() {
         List<Future<ActorSelection>> cohortFutures = new ArrayList<>(cohorts.size());
-        for(CohortInfo info: cohorts) {
+        for (CohortInfo info: cohorts) {
             cohortFutures.add(info.getActorFuture());
         }
 
@@ -395,6 +392,7 @@ public class ThreePhaseCommitCohortProxy extends AbstractThreePhaseCommitCohort<
 
     private interface MessageSupplier {
         Object newMessage(TransactionIdentifier transactionId, short version);
+
         boolean isSerializedReplyType(Object reply);
     }
 }