Merge "BUG-4117: add support for flow old Notif"

[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / core / sal / OFRpcFutureResultTransformFactory.java

diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcFutureResultTransformFactory.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcFutureResultTransformFactory.java
index aa8982043e7e8126d90fc402e31ff45177c8ee97..dfe92306c900d926d93c4b2dbcb5c8efb7e29071 100644 (file)
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcFutureResultTransformFactory.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcFutureResultTransformFactory.java
@@ -1,14 +1,14 @@
 /**
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
- * 
+ *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
 package org.opendaylight.openflowplugin.openflow.md.core.sal;
 
+import com.google.common.base.Function;
 import java.util.Collection;
-
 import org.opendaylight.controller.sal.common.util.Rpcs;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowOutputBuilder;
@@ -30,25 +30,25 @@ import org.opendaylight.yangtools.yang.common.RpcResult;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.base.Function;
-
 /**
- * collection of transformation functions dedicated to rpc future results  
+ * collection of transformation functions dedicated to rpc future results
  */
 public abstract class OFRpcFutureResultTransformFactory {
-    
-    protected static Logger LOG = LoggerFactory
+
+    private static final String MSG_ADD_FLOW_RPC = "Returning the Add Flow RPC result to MD-SAL";
+    protected static final Logger LOG = LoggerFactory
             .getLogger(OFRpcFutureResultTransformFactory.class);
 
     /**
-     * @param input
-     * @param result
-     * @return
+     *
+     * @param input rpc result input
+     * @param result results
+     * @param <E> rpc result input type
+     * @return rpc result
      */
     protected static <E> RpcResult<E> assembleRpcResult(RpcResult<?> input, E result) {
         Collection<RpcError> errors = input.getErrors();
-        RpcResult<E> rpcResult = Rpcs.getRpcResult(input.isSuccessful(), result, errors);
-        return rpcResult;
+        return Rpcs.getRpcResult(input.isSuccessful(), result, errors);
     }
 
     /**
@@ -67,13 +67,13 @@ public abstract class OFRpcFutureResultTransformFactory {
                 AddFlowOutput result = addFlowOutput.build();
 
                 RpcResult<AddFlowOutput> rpcResult = assembleRpcResult(input, result);
-                LOG.debug("Returning the Add Flow RPC result to MD-SAL");
+                LOG.debug(MSG_ADD_FLOW_RPC);
                 return rpcResult;
             }
 
         };
     }
-    
+
     /**
      * @return translator from {@link UpdateFlowOutput} to {@link RemoveFlowOutput}
      */
@@ -90,13 +90,13 @@ public abstract class OFRpcFutureResultTransformFactory {
                 RemoveFlowOutput result = removeFlowOutput.build();
 
                 RpcResult<RemoveFlowOutput> rpcResult = assembleRpcResult(input, result);
-                LOG.debug("Returning the Add Flow RPC result to MD-SAL");
+                LOG.debug(MSG_ADD_FLOW_RPC);
                 return rpcResult;
             }
 
         };
     }
-    
+
     /**
      * @return translator from {@link UpdateGroupOutput} to {@link AddGroupOutput}
      */
@@ -106,7 +106,7 @@ public abstract class OFRpcFutureResultTransformFactory {
             @Override
             public RpcResult<AddGroupOutput> apply(final RpcResult<UpdateGroupOutput> input) {
                 UpdateGroupOutput updateGroupOutput = input.getResult();
-                
+
                 AddGroupOutputBuilder addGroupOutput = new AddGroupOutputBuilder();
                 addGroupOutput.setTransactionId(updateGroupOutput.getTransactionId());
                 AddGroupOutput result = addGroupOutput.build();
@@ -117,9 +117,9 @@ public abstract class OFRpcFutureResultTransformFactory {
             }
         };
     }
-    
+
     /**
-     * @return
+     * @return rpc result function for group udpate
      */
     public static Function<RpcResult<UpdateGroupOutput>,RpcResult<RemoveGroupOutput>> createForRemoveGroupOutput() {
         return new Function<RpcResult<UpdateGroupOutput>,RpcResult<RemoveGroupOutput>>() {
@@ -134,13 +134,13 @@ public abstract class OFRpcFutureResultTransformFactory {
                 RemoveGroupOutput result = removeGroupOutput.build();
 
                 RpcResult<RemoveGroupOutput> rpcResult = assembleRpcResult(input, result);
-                LOG.debug("Returning the Add Flow RPC result to MD-SAL");
+                LOG.debug(MSG_ADD_FLOW_RPC);
                 return rpcResult;
             }
 
         };
     }
-    
+
     /**
      * @return translator from {@link UpdateMeterOutput} to {@link AddMeterOutput}
      */
@@ -150,7 +150,7 @@ public abstract class OFRpcFutureResultTransformFactory {
             @Override
             public RpcResult<AddMeterOutput> apply(final RpcResult<UpdateMeterOutput> input) {
                 UpdateMeterOutput updateMeterOutput = input.getResult();
-                
+
                 AddMeterOutputBuilder addMeterOutput = new AddMeterOutputBuilder();
                 addMeterOutput.setTransactionId(updateMeterOutput.getTransactionId());
                 AddMeterOutput result = addMeterOutput.build();
@@ -161,10 +161,10 @@ public abstract class OFRpcFutureResultTransformFactory {
             }
         };
     }
-    
-    
+
+
     /**
-     * @return
+     * @return return rpc result function
      */
     public static Function<RpcResult<UpdateMeterOutput>, RpcResult<RemoveMeterOutput>> createForRemoveMeterOutput() {
         return new Function<RpcResult<UpdateMeterOutput>,RpcResult<RemoveMeterOutput>>() {
@@ -172,7 +172,7 @@ public abstract class OFRpcFutureResultTransformFactory {
             @Override
             public RpcResult<RemoveMeterOutput> apply(final RpcResult<UpdateMeterOutput> input) {
                 UpdateMeterOutput updateMeterOutput = input.getResult();
-                
+
                 RemoveMeterOutputBuilder removeMeterOutput = new RemoveMeterOutputBuilder();
                 removeMeterOutput.setTransactionId(updateMeterOutput.getTransactionId());
                 RemoveMeterOutput result = removeMeterOutput.build();
@@ -183,8 +183,8 @@ public abstract class OFRpcFutureResultTransformFactory {
             }
         };
     }
-    
-    
-    
-    
+
+
+
+
 }