Fix checkstyle error for java 8 build success 49/32449/1
authorAnil Vishnoi <vishnoianil@gmail.com>
Tue, 12 Jan 2016 22:18:55 +0000 (14:18 -0800)
committerAnil Vishnoi <vishnoianil@gmail.com>
Tue, 12 Jan 2016 22:20:53 +0000 (14:20 -0800)
Change-Id: I6240c6b9e7b329ad16387c6d50c21601fc9067c0
Signed-off-by: Anil Vishnoi <vishnoianil@gmail.com>
62 files changed:
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/ConnectionConductorFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/HandshakeManagerImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/HandshakeStepWrapper.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/MDController.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/MessageFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/RpcListeningExecutorService.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/RpcUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/ThreadPoolLoggingExecutor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/extension/ActionExtensionHelper.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/extension/ExtensionConverterManagerImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/extension/MatchExtensionHelper.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcFutureResultTransformFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTask.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskContext.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/ActionConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/FlowConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/FlowStatsResponseConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/IpConversionUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/MeterConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/MeterStatsResponseConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/OFToMDSalFlowConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/PacketOutConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/PortConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/action/ActionSetNwDstReactorMappingFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/action/ActionSetNwSrcReactorMappingFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/ConvertReactor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/Convertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/InjectionKey.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/InjectionResultTargetKey.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/OrderComparator.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/common/ResultInjector.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/flowflag/FlowFlagConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/flowflag/FlowFlagReactorMappingFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/match/MatchConvertor.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/match/MatchConvertorImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/match/MatchConvertorUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/convertor/match/MatchReactorMappingFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/session/IGetBandwith.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/session/OFRoleManager.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/session/RolePushException.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/session/SwitchConnectionCookieOFImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/AbstractErrorTranslator.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/translator/ErrorV10Translator.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/MessageSourcePollRegistration.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/QueueItemOFImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/QueueKeeperFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/QueueKeeperFairImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/QueueKeeperHarvester.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketFinisher.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketFinisherImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactory.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/queue/TicketProcessorFactoryImpl.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/ByteUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/FlowCreatorUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/InventoryDataServiceUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/OpenflowPortsUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/PacketInUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/RpcInputOutputTuple.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/RpcResultUtil.java
openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/util/TaskUtil.java

index 236b568356bfc8e15997df2f280b3ccd31d8d004..26e6e772241a54e612687b4ff098500b1ee0a4d8 100644 (file)
@@ -29,8 +29,8 @@ public final class ConnectionConductorFactory {
     }
 
     /**
-     * @param connectionAdapter
-     * @param queueProcessor 
+     * @param connectionAdapter connection conductor adaptor
+     * @param queueProcessor  message queue process
      * @return conductor for given connection
      */
     public static ConnectionConductor createConductor(ConnectionAdapter connectionAdapter,
index 794bfe7f8d647bf10b246080a04db82af3cf2b82..0a4e98c47d8204b266a72d09db9b5fb6a0ae3cd3 100644 (file)
@@ -63,9 +63,9 @@ public class HandshakeManagerImpl implements HandshakeManager {
     private boolean useVersionBitmap;
 
     /**
-     * @param connectionAdapter
-     * @param highestVersion
-     * @param versionOrder
+     * @param connectionAdapter connection adaptor for switch
+     * @param highestVersion highest openflow version
+     * @param versionOrder list of version in order for connection protocol negotiation
      */
     public HandshakeManagerImpl(ConnectionAdapter connectionAdapter, Short highestVersion,
             List<Short> versionOrder) {
@@ -125,8 +125,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
     }
 
     /**
-     * @param remoteVersion
-     * @throws Exception
+     * @param remoteVersion remote version
+     * @throws Exception exception
      */
     private void handleStepByStepVersionNegotiation(final Short remoteVersion) throws Exception {
         LOG.debug("remoteVersion:{} lastProposedVersion:{}, highestVersion:{}",
@@ -178,8 +178,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
     }
 
     /**
-     * @param remoteVersion
-     * @throws Exception
+     * @param remoteVersion remote version
+     * @throws Exception exception
      */
     private void handleLowerVersionProposal(Short remoteVersion) throws Exception {
         Short proposedVersion;
@@ -197,8 +197,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
     }
 
     /**
-     * @param elements
-     * @throws Exception
+     * @param elements version elements
+     * @throws Exception exception
      */
     private void handleVersionBitmapNegotiation(List<Elements> elements) throws Exception {
         final Short proposedVersion = proposeCommonBitmapVersion(elements);
@@ -227,7 +227,7 @@ public class HandshakeManagerImpl implements HandshakeManager {
 
     /**
      *
-     * @return
+     * @return next tx id
      */
     private Long getNextXid() {
         activeXid += 1;
@@ -235,14 +235,14 @@ public class HandshakeManagerImpl implements HandshakeManager {
     }
 
     /**
-     * @param xid
+     * @param xid tx id
      */
     private void setActiveXid(Long xid) {
         this.activeXid = xid;
     }
 
     /**
-     * @param remoteVersion
+     * @param remoteVersion remove version
      */
     private void checkNegotiationStalling(Short remoteVersion) {
         if (lastReceivedVersion != null && lastReceivedVersion.equals(remoteVersion)) {
@@ -258,8 +258,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
 
     /**
      * find common highest supported bitmap version
-     * @param list
-     * @return
+     * @param list bitmap list
+     * @return proposed bitmap value
      */
     protected Short proposeCommonBitmapVersion(List<Elements> list) {
         Short supportedHighestVersion = null;
@@ -287,8 +287,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
 
     /**
      * find supported version based on remoteVersion
-     * @param remoteVersion
-     * @return
+     * @param remoteVersion openflow version supported by remote entity
+     * @return openflow version
      */
     protected short proposeNextVersion(short remoteVersion) {
         Short proposal = null;
@@ -307,8 +307,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
 
     /**
      * send hello reply without versionBitmap
-     * @param helloVersion
-     * @param helloXid
+     * @param helloVersion initial hello version for openflow connection negotiation
+     * @param helloXid transaction id
      * @throws Exception
      */
     private ListenableFuture<Void> sendHelloMessage(Short helloVersion, final Long helloXid) throws Exception {
@@ -360,8 +360,8 @@ public class HandshakeManagerImpl implements HandshakeManager {
 
     /**
      * after handshake set features, register to session
-     * @param proposedVersion
-     * @param xid
+     * @param proposedVersion proposed openflow version
+     * @param xid transaction id
      */
     protected void postHandshake(final Short proposedVersion, final Long xid) {
         // set version
index 35da23e9f17635e6cff62117ef5425427c48a501..ccaa6cdf61904962c19c8d1cc78e5483b3771696 100644 (file)
@@ -30,9 +30,9 @@ public class HandshakeStepWrapper implements Runnable {
 
 
     /**
-     * @param helloMessage
-     * @param handshakeManager
-     * @param connectionAdapter
+     * @param helloMessage initial hello message
+     * @param handshakeManager connection handshake manager
+     * @param connectionAdapter connection adaptor fro switch
      */
     public HandshakeStepWrapper(HelloMessage helloMessage,
             HandshakeManager handshakeManager, ConnectionAdapter connectionAdapter) {
index 1691d152d89067e8efa52bbea05d5ff950331c82..da6901c395735c6a72feaf9ffc96d24ed7ef97a8 100644 (file)
@@ -406,7 +406,7 @@ public class MDController implements IMDController, AutoCloseable {
     }
 
     /**
-     * @param extensionConverterProvider
+     * @param extensionConverterProvider extension convertor provider
      */
     public void setExtensionConverterProvider(ExtensionConverterProvider extensionConverterProvider) {
         this.extensionConverterProvider = extensionConverterProvider;
index febf50e48f8994f5ba4e65f1b2fc0f64c251695f..ffc39ebbf1e8f15ba57035c6bc0ed7ef742432fc 100644 (file)
@@ -26,8 +26,8 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 public abstract class MessageFactory {
 
     /**
-     * @param helloVersion
-     * @param helloXid
+     * @param helloVersion openflow version for hello message to send to switch
+     * @param helloXid transaction id for hello message
      * @return HelloInput without elements
      */
     public static HelloInput createHelloInput(short helloVersion, long helloXid) {
@@ -35,8 +35,8 @@ public abstract class MessageFactory {
     }
 
     /**
-     * @param highestVersion
-     * @param xid
+     * @param highestVersion highest openflow version
+     * @param xid transaction id
      * @return builder with prepared header
      */
     private static HelloInputBuilder prepareHelloInputBuilder(
@@ -48,9 +48,9 @@ public abstract class MessageFactory {
     }
     
     /**
-     * @param helloVersion
-     * @param helloXid
-     * @param versionOrder
+     * @param helloVersion openflow version for hello message to send to switch
+     * @param helloXid transaction id for hello message
+     * @param versionOrder list of openflow version in order
      * @return HelloInput with elements (version bitmap)
      */
     public static HelloInput createHelloInput(short helloVersion, long helloXid, List<Short> versionOrder) {
@@ -86,7 +86,7 @@ public abstract class MessageFactory {
     }
 
     /**
-     * @param elements
+     * @param elements list of versions
      * @return version boolean list
      */
     public static List<Boolean> digVersions(List<Elements> elements) {
@@ -102,8 +102,8 @@ public abstract class MessageFactory {
     }
     
     /**
-     * @param ofVersion 
-     * @param ofXid 
+     * @param ofVersion  openflow version
+     * @param ofXid transaction id
      * @return barrier message
      */
     public static BarrierInput createBarrier(short ofVersion, long ofXid) {
index be1ae2cb4608d0f924547addba5ba42bd12fc6d4..f785a07fdce271d78b338c68b1c9d3aa9a9e39bf 100644 (file)
@@ -32,7 +32,7 @@ public class RpcListeningExecutorService implements ListeningExecutorService {
     private DataContainer notSupportedTask = new NoDataContainerTask();
     
     /**
-     * @param executorService
+     * @param executorService executor service
      */
     public RpcListeningExecutorService(ListeningExecutorService executorService) {
         this.executorServiceDelegate = executorService;
index 49ef06b600b08a19f2529e6ebe4326a3a102ad24..925a327b65791b134f0fea2044cc7ac7bc7559f7 100644 (file)
@@ -17,8 +17,8 @@ import org.opendaylight.yangtools.yang.common.RpcResult;
 public abstract class RpcUtil {
 
     /**
-     * @param result
-     * @throws Exception 
+     * @param result rpc result
+     * @throws Exception exception thrown by method if rpc fails
      */
     public static void smokeRpc(RpcResult<?> result) throws Exception {
         if (!result.isSuccessful()) {
index 481e4585fba8fa3579ad263644559a4c7bd5ba41..efd5a61fa2e16077cf2bf90d349b9b22a91dc9c4 100644 (file)
@@ -22,11 +22,11 @@ public class ThreadPoolLoggingExecutor extends ThreadPoolExecutor {
     private static final Logger LOG = LoggerFactory.getLogger(ThreadPoolLoggingExecutor.class);
 
     /**
-     * @param corePoolSize
-     * @param maximumPoolSize
-     * @param keepAliveTime
-     * @param unit
-     * @param workQueue
+     * @param corePoolSize thread pool size
+     * @param maximumPoolSize maximum pool size
+     * @param keepAliveTime keep alive time
+     * @param unit time unit
+     * @param workQueue task queue
      * @param poolName thread name prefix
      */
     public ThreadPoolLoggingExecutor(int corePoolSize, int maximumPoolSize,
index f6a54166eb66db6b79d3611502f84cea8bcabe35..994e223e0ca35451339ee5d415614fb848a44109 100644 (file)
@@ -32,9 +32,9 @@ public final class ActionExtensionHelper {
     }
 
     /**
-     * @param action
-     * @param ofVersion
-     * @param actionPath
+     * @param action openflow action
+     * @param ofVersion openflow version
+     * @param actionPath openflow action path
      * @return augmentation wrapper containing augmentation depending on matchPath
      */
     public static org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action
index 6563713c839519415ab5361c67c54fe839d2906b..a2e77d9bca08513312bdd330eea4e3732c39d7a8 100644 (file)
@@ -66,9 +66,9 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     }
 
     /**
-     * @param key
-     * @param extConvertor
-     * @return
+     * @param key message key
+     * @param extConvertor extension convertor
+     * @return registration closure
      */
     private <FROM extends DataContainer, PATH extends AugmentationPath, KEY extends MessageTypeKey<?>>
     RegistrationCloserFromOFJava<FROM, PATH> hireJanitor(
@@ -81,9 +81,9 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     }
 
     /**
-     * @param key
-     * @param extConvertor
-     * @return
+     * @param key message type key
+     * @param extConvertor extension convertor
+     * @return registration closure
      */
     private <FROM extends DataContainer, PATH extends AugmentationPath, KEY extends MessageTypeKey<?>>
     RegistrationCloserActionFromOFJava<FROM, PATH> hireJanitor(
@@ -96,9 +96,9 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     }
 
     /**
-     * @param key
-     * @param extConvertor
-     * @return
+     * @param key message type key
+     * @param extConvertor extension convertor
+     * @return registration closure
      */
     private <TO extends DataContainer> RegistrationCloserToOFJava<TO> hireJanitor(
             final ConverterExtensionKey<? extends ExtensionKey> key, final ConvertorToOFJava<TO> extConvertor) {
@@ -110,9 +110,9 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     }
 
     /**
-     * @param key
-     * @param extConvertor
-     * @return
+     * @param key message type key
+     * @param extConvertor extension convertor
+     * @return registration closure
      */
     private <TO extends DataContainer> RegistrationCloserActionToOFJava<TO> hireJanitor(
             final TypeVersionKey<? extends Action> key, final ConvertorActionToOFJava<Action, TO> extConvertor) {
@@ -124,9 +124,9 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     }
 
     /**
-     * @param key
-     * @param extConvertor
-     * @return
+     * @param key message type key
+     * @param extConvertor extension convertor
+     * @return registration closure
      */
     private <TO extends DataContainer, K extends ExperimenterMessageOfChoice> RegistrationCloserMessageToOFJava<TO, K> hireMessageJanitor(
             final TypeVersionKey<K> key,
@@ -139,9 +139,9 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     }
 
     /**
-     * @param key
-     * @param extConvertor
-     * @return
+     * @param key message type key
+     * @param extConvertor extension convertor
+     * @return registration closure
      */
     private <FROM extends DataContainer, PATH extends AugmentationPath, KEY extends MessageTypeKey<?>>
     RegistrationCloserMessageFromOFJava<FROM, PATH> hireMessageJanitor(
@@ -156,8 +156,8 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     /**
      * cancel registration of given converter
      *
-     * @param key
-     * @param converter
+     * @param key message key
+     * @param converter extension convertor
      */
     public void unregister(final ConverterExtensionKey<?> key, final ConvertorToOFJava<?> converter) {
         ConvertorToOFJava<?> registeredConverter = registryToOFJAva.get(key);
@@ -169,8 +169,8 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     /**
      * cancel registration of given converter
      *
-     * @param key
-     * @param converter
+     * @param key message key
+     * @param converter extension convertor
      */
     public void unregister(final TypeVersionKey<? extends Action> key, final ConvertorActionToOFJava<?, ?> converter) {
         ConvertorActionToOFJava<?, ?> registeredConverter = registryActionToOFJAva.get(key);
@@ -182,8 +182,8 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     /**
      * cancel registration of given converter
      *
-     * @param key
-     * @param converter
+     * @param key message key
+     * @param converter extension convertor
      */
     public void unregister(final MessageTypeKey<?> key, final ConvertorFromOFJava<?, ?> converter) {
         ConvertorFromOFJava<?, ?> registeredConverter = registryFromOFJAva.get(key);
@@ -195,8 +195,8 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     /**
      * cancel registration of given converter
      *
-     * @param key
-     * @param converter
+     * @param key message key
+     * @param converter extension convertor
      */
     public void unregister(final MessageTypeKey<?> key, final ConvertorActionFromOFJava<?, ?> converter) {
         ConvertorActionFromOFJava<?, ?> registeredConverter = registryActionFromOFJAva.get(key);
@@ -208,8 +208,8 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     /**
      * cancel registration of given converter
      *
-     * @param key
-     * @param converter
+     * @param key message key
+     * @param converter extension convertor
      */
     public void unregister(final MessageTypeKey<?> key, final ConvertorMessageFromOFJava<?, ?> converter) {
         ConvertorMessageFromOFJava<?, ?> registeredConverter = registryMessageFromOFJAva.get(key);
@@ -221,8 +221,8 @@ public class ExtensionConverterManagerImpl implements ExtensionConverterManager
     /**
      * cancel registration of given converter
      *
-     * @param key
-     * @param converter
+     * @param key message key
+     * @param converter extension convertor
      */
     public void unregister(final TypeVersionKey<?> key, final ConvertorMessageToOFJava<?, ?> converter) {
         ConvertorMessageToOFJava<?, ?> registeredConverter = registryMessageToOFJAva.get(key);
index dcc802ded5790deac08dd377712df24bbc32ded3..3ae5ca0884eb4090b5bbe9f25690ab5fbbc18f3d 100644 (file)
@@ -49,9 +49,10 @@ public final class MatchExtensionHelper {
     }
 
     /**
-     * @param matchEntries
-     * @param ofVersion
-     * @param matchPath
+     * @param matchEntries match entries
+     * @param ofVersion openflow version
+     * @param matchPath match path
+     * @param <EXT_POINT> extension point
      * @return augmentation wrapper containing augmentation depending on matchPath
      */
     @SuppressWarnings("unchecked")
index 0c1dd5a6454b123de17e9567713e213240160524..dfe92306c900d926d93c4b2dbcb5c8efb7e29071 100644 (file)
@@ -40,9 +40,11 @@ public abstract class OFRpcFutureResultTransformFactory {
             .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();
@@ -117,7 +119,7 @@ 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>>() {
@@ -162,7 +164,7 @@ 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>>() {
index 75ff8bbfebba1667613996ecc5c4248963f4ad8c..b2f0f4588e2a8e6218fe451ab5dbe5e5d04f52b2 100644 (file)
@@ -29,9 +29,9 @@ public abstract class OFRpcTask<T, K> implements Callable<ListenableFuture<K>> {
     private SwitchConnectionDistinguisher cookie;
     
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie 
+     * @param taskContext rpc task context
+     * @param input  task input
+     * @param cookie switch connection distinguisher cookie value
      */
     public OFRpcTask(OFRpcTaskContext taskContext, SwitchConnectionDistinguisher cookie, T input) {
         this.taskContext = taskContext;
index ab8e42842883e3ff995587cba0f91120221a9b02..d2d196488795c367e574b1fa7be7ff08e97a2219 100644 (file)
@@ -92,7 +92,7 @@ public class OFRpcTaskContext {
         this.maxTimeoutUnit = maxTimeoutUnit;
     }
     /**
-     * @param rpcPool
+     * @param rpcPool executor service pool for rpc
      */
     public void setRpcPool(ListeningExecutorService rpcPool) {
         this.rpcPool = rpcPool;
@@ -106,7 +106,7 @@ public class OFRpcTaskContext {
     }
     
     /**
-     * @param messageSpy
+     * @param messageSpy the message spy
      */
     public void setMessageSpy(MessageSpy<DataContainer> messageSpy) {
         this.messageSpy = messageSpy;
index 1ca56d8136b90bd2df01f0cea5dfa27a7269deb4..60df8aabf3be101c6d405f0502a45a9d540f32ca 100644 (file)
@@ -198,9 +198,9 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
+     * @param taskContext task context
+     * @param input flow object input
+     * @param cookie switch connection distinguisher cookie value
      * @return UpdateFlow task
      */
     public static OFRpcTask<AddFlowInput, RpcResult<UpdateFlowOutput>> createAddFlowTask(
@@ -245,6 +245,12 @@ public abstract class OFRpcTaskFactory {
      * The next flowmod gets executed if the earlier one is successful.
      * All the flowmods should have the same xid, in-order to cross-reference
      * the notification
+     * @param taskContext task context
+     * @param ofFlowModInputs list of flow mod as input
+     * @param index  starting index
+     * @param cookie switch connection distinguisher
+     * @return listenable future with update flow output
+     *
      */
     protected static ListenableFuture<RpcResult<UpdateFlowOutput>> chainFlowMods(
             final List<FlowModInputBuilder> ofFlowModInputs, final int index,
@@ -285,8 +291,8 @@ public abstract class OFRpcTaskFactory {
 
 
     /**
-     * @param input
-     * @return
+     * @param input flow input
+     * @return flow added notification
      */
     protected static NotificationComposer<FlowAdded> createFlowAddedNotification(
             final AddFlowInput input) {
@@ -302,9 +308,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
+     * @param taskContext task context
+     * @param input update flow input
+     * @param cookie switch connection distinguisher cookie value
+     * @param rwTx  read write transaction
      * @return UpdateFlow task
      */
     public static OFRpcTask<UpdateFlowInput, RpcResult<UpdateFlowOutput>> createUpdateFlowTask(
@@ -422,8 +429,8 @@ public abstract class OFRpcTaskFactory {
 
 
     /**
-     * @param input
-     * @return
+     * @param input update flow input
+     * @return flow update notification
      */
     protected static NotificationComposer<FlowUpdated> createFlowUpdatedNotification(final UpdateFlowInput input) {
         return new NotificationComposer<FlowUpdated>() {
@@ -438,9 +445,9 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
+     * @param taskContext taks context
+     * @param input group update input
+     * @param cookie switch connection distinguisher cookie value
      * @return update group task
      */
     public static OFRpcTask<AddGroupInput, RpcResult<UpdateGroupOutput>> createAddGroupTask(
@@ -484,8 +491,8 @@ public abstract class OFRpcTaskFactory {
 
 
     /**
-     * @param input
-     * @return
+     * @param input group add input
+     * @return group added notification
      */
     protected static NotificationComposer<GroupAdded> createGroupAddedNotification(
             final AddGroupInput input) {
@@ -501,9 +508,9 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
+     * @param taskContext task context
+     * @param input meter add input
+     * @param cookie switch connection distinguisher
      * @return update meter task
      */
     public static OFRpcTask<AddMeterInput, RpcResult<UpdateMeterOutput>> createAddMeterTask(
@@ -545,8 +552,8 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param input
-     * @return
+     * @param input add meter input
+     * @return meter added notification composer
      */
     protected static NotificationComposer<MeterAdded> createMeterAddedNotification(
             final AddMeterInput input) {
@@ -562,9 +569,9 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
+     * @param taskContext task context
+     * @param input update group output
+     * @param cookie switch connection distinguisher cookie value
      * @return UpdateFlow task
      */
     public static OFRpcTask<UpdateGroupInput, RpcResult<UpdateGroupOutput>> createUpdateGroupTask(
@@ -609,8 +616,8 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param input
-     * @return
+     * @param input group update input
+     * @return group updated notification composer
      */
     protected static NotificationComposer<GroupUpdated> createGroupUpdatedNotification(
             final UpdateGroupInput input) {
@@ -626,9 +633,9 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
+     * @param taskContext task context
+     * @param input update meter input
+     * @param cookie switch connection distinguisher cookie value
      * @return update meter task
      */
     public static OFRpcTask<UpdateMeterInput, RpcResult<UpdateMeterOutput>> createUpdateMeterTask(
@@ -671,8 +678,8 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param input
-     * @return
+     * @param input meter update input
+     * @return meter updated notification
      */
     protected static NotificationComposer<MeterUpdated> createMeterUpdatedNotification(
             final UpdateMeterInput input) {
@@ -689,10 +696,10 @@ public abstract class OFRpcTaskFactory {
 
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input update flow input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task remove flow task
      */
     public static OFRpcTask<RemoveFlowInput, RpcResult<UpdateFlowOutput>> createRemoveFlowTask(
             OFRpcTaskContext taskContext, RemoveFlowInput input,
@@ -731,8 +738,8 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param input
-     * @return
+     * @param input remove flow input
+     * @return flow removed notification
      */
     protected static NotificationComposer<FlowRemoved> createFlowRemovedNotification(
             final RemoveFlowInput input) {
@@ -749,10 +756,10 @@ public abstract class OFRpcTaskFactory {
 
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input remove group input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task remove group task
      */
     public static OFRpcTask<RemoveGroupInput, RpcResult<UpdateGroupOutput>> createRemoveGroupTask(
             final OFRpcTaskContext taskContext, RemoveGroupInput input,
@@ -795,8 +802,8 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param input
-     * @return
+     * @param input group remove input
+     * @return group removed notification
      */
     protected static NotificationComposer<GroupRemoved> createGroupRemovedNotification(
             final RemoveGroupInput input) {
@@ -812,10 +819,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input meter removed input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task meter remove task
      */
     public static OFRpcTask<RemoveMeterInput, RpcResult<UpdateMeterOutput>> createRemoveMeterTask(
             OFRpcTaskContext taskContext, RemoveMeterInput input,
@@ -859,8 +866,8 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param input
-     * @return
+     * @param input remove meter input
+     * @return meter removed notification composer
      */
     protected static NotificationComposer<MeterRemoved> createMeterRemovedNotification(
             final RemoveMeterInput input) {
@@ -876,10 +883,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get all statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get all group statistics task
      */
     public static OFRpcTask<GetAllGroupStatisticsInput, RpcResult<GetAllGroupStatisticsOutput>> createGetAllGroupStatisticsTask(
             final OFRpcTaskContext taskContext, GetAllGroupStatisticsInput input,
@@ -945,10 +952,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get group description input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get group description task
      */
     public static OFRpcTask<GetGroupDescriptionInput, RpcResult<GetGroupDescriptionOutput>> createGetGroupDescriptionTask(
             final OFRpcTaskContext taskContext, GetGroupDescriptionInput input,
@@ -998,10 +1005,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get group feature input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get group feature task
      */
     public static OFRpcTask<GetGroupFeaturesInput, RpcResult<GetGroupFeaturesOutput>> createGetGroupFeaturesTask(
             final OFRpcTaskContext taskContext, GetGroupFeaturesInput input,
@@ -1052,10 +1059,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get group statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get group statistics task
      */
     public static OFRpcTask<GetGroupStatisticsInput, RpcResult<GetGroupStatisticsOutput>> createGetGroupStatisticsTask(
             final OFRpcTaskContext taskContext, final GetGroupStatisticsInput input,
@@ -1110,10 +1117,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get meter config statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get all mtere config statistics task
      */
     public static OFRpcTask<GetAllMeterConfigStatisticsInput, RpcResult<GetAllMeterConfigStatisticsOutput>> createGetAllMeterConfigStatisticsTask(
             final OFRpcTaskContext taskContext, final GetAllMeterConfigStatisticsInput input,
@@ -1171,10 +1178,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get all meter statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get all meter statistics task
      */
     public static OFRpcTask<GetAllMeterStatisticsInput, RpcResult<GetAllMeterStatisticsOutput>> createGetAllMeterStatisticsTask(
             final OFRpcTaskContext taskContext, final GetAllMeterStatisticsInput input,
@@ -1233,10 +1240,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get meter features input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get meter feature task
      */
     public static OFRpcTask<GetMeterFeaturesInput, RpcResult<GetMeterFeaturesOutput>> createGetMeterFeaturesTask(
             final OFRpcTaskContext taskContext, final GetMeterFeaturesInput input,
@@ -1289,10 +1296,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get meter statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get meter statistics task
      */
     public static OFRpcTask<GetMeterStatisticsInput, RpcResult<GetMeterStatisticsOutput>> createGetMeterStatisticsTask(
             final OFRpcTaskContext taskContext, final GetMeterStatisticsInput input,
@@ -1349,10 +1356,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get all node connector statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get all node connector statistics task
      */
     public static OFRpcTask<GetAllNodeConnectorsStatisticsInput, RpcResult<GetAllNodeConnectorsStatisticsOutput>>
     createGetAllNodeConnectorsStatisticsTask(
@@ -1404,10 +1411,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get node connector statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get node connector statistics task
      */
     public static OFRpcTask<GetNodeConnectorStatisticsInput, RpcResult<GetNodeConnectorStatisticsOutput>>
     createGetNodeConnectorStatisticsTask(
@@ -1462,10 +1469,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get all flow statistics from flow table
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get all flow statistics from flow table task
      */
     public static OFRpcTask<GetAllFlowStatisticsFromFlowTableInput, RpcResult<GetAllFlowStatisticsFromFlowTableOutput>>
     createGetAllFlowStatisticsFromFlowTableTask(
@@ -1521,10 +1528,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get all flow statistics from all flow table
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get all flow statistics from all flow table task
      */
     public static OFRpcTask<GetAllFlowsStatisticsFromAllFlowTablesInput, RpcResult<GetAllFlowsStatisticsFromAllFlowTablesOutput>>
     createGetAllFlowsStatisticsFromAllFlowTablesTask(
@@ -1583,10 +1590,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get flow statistics from flow table
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get flow statistics from flow table task
      */
     public static OFRpcTask<GetFlowStatisticsFromFlowTableInput, RpcResult<GetFlowStatisticsFromFlowTableOutput>>
     createGetFlowStatisticsFromFlowTableTask(
@@ -1666,10 +1673,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input get aggregate flow statistics from flow table for all flow input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task get aggregate flow stats from flow table for all flow task
      */
     public static OFRpcTask<GetAggregateFlowStatisticsFromFlowTableForAllFlowsInput, RpcResult<GetAggregateFlowStatisticsFromFlowTableForAllFlowsOutput>>
     createGetAggregateFlowStatisticsFromFlowTableForAllFlowsTask(
@@ -1726,10 +1733,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input aggregate flow statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to fetch the statistics
      */
     public static OFRpcTask<GetAggregateFlowStatisticsFromFlowTableForGivenMatchInput, RpcResult<GetAggregateFlowStatisticsFromFlowTableForGivenMatchOutput>>
     createGetAggregateFlowStatisticsFromFlowTableForGivenMatchTask(
@@ -1797,10 +1804,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input flow table statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to fetch table statistics
      */
     public static OFRpcTask<GetFlowTablesStatisticsInput, RpcResult<GetFlowTablesStatisticsOutput>> createGetFlowTablesStatisticsTask(
             final OFRpcTaskContext taskContext, final GetFlowTablesStatisticsInput input, SwitchConnectionDistinguisher cookie) {
@@ -1849,10 +1856,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input queue statistics input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to fetch all queue statistics
      */
     public static OFRpcTask<GetAllQueuesStatisticsFromAllPortsInput, RpcResult<GetAllQueuesStatisticsFromAllPortsOutput>> createGetAllQueuesStatisticsFromAllPortsTask(
             final OFRpcTaskContext taskContext, final GetAllQueuesStatisticsFromAllPortsInput input, SwitchConnectionDistinguisher cookie) {
@@ -1903,10 +1910,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input queue statist from specific port input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to get queue statistics from specific port
      */
     public static OFRpcTask<GetAllQueuesStatisticsFromGivenPortInput, RpcResult<GetAllQueuesStatisticsFromGivenPortOutput>> createGetAllQueuesStatisticsFromGivenPortTask(
             final OFRpcTaskContext taskContext, final GetAllQueuesStatisticsFromGivenPortInput input, SwitchConnectionDistinguisher cookie) {
@@ -1959,10 +1966,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input queue statistics from given port
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to get queue statistics from given port
      */
     public static OFRpcTask<GetQueueStatisticsFromGivenPortInput, RpcResult<GetQueueStatisticsFromGivenPortOutput>> createGetQueueStatisticsFromGivenPortTask(
             final OFRpcTaskContext taskContext, final GetQueueStatisticsFromGivenPortInput input, SwitchConnectionDistinguisher cookie) {
@@ -2029,7 +2036,7 @@ public abstract class OFRpcTaskFactory {
         private SettableFuture<RpcResult<T>> result;
 
         /**
-         * @param result
+         * @param result result
          */
         public ResultCallback(SettableFuture<RpcResult<T>> result) {
             this.result = result;
@@ -2054,10 +2061,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input update port input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to update port
      */
     public static OFRpcTask<UpdatePortInput, RpcResult<UpdatePortOutput>> createUpdatePortTask(
             final OFRpcTaskContext taskContext, final UpdatePortInput input,
@@ -2094,10 +2101,10 @@ public abstract class OFRpcTaskFactory {
     }
 
     /**
-     * @param taskContext
-     * @param input
-     * @param cookie
-     * @return task
+     * @param taskContext task context
+     * @param input update table input
+     * @param cookie switch connection distinguisher cookie value
+     * @return task task to udpate table input
      */
     public static OFRpcTask<UpdateTableInput, RpcResult<UpdateTableOutput>> createUpdateTableTask(
             final OFRpcTaskContext taskContext, final UpdateTableInput input,
index 656841a511ed7fa45692d43b194c38056f678411..6ef2a029bdaa6853b3770eb2e1c2d97d4ea1e8bd 100644 (file)
@@ -86,10 +86,13 @@ public abstract class OFRpcTaskUtil {
     }
 
     /**
-     * @param task of rpc
-     * @param originalResult
-     * @param notificationProviderService
+     * @param task task
+     * @param originalResult original result
+     * @param notificationProviderService notification provider service
      * @param notificationComposer lazy notification composer
+     * @param <I> data container
+     * @param <N> notification
+     * @param <R> R
      */
     public static <R extends RpcResult<? extends TransactionAware>, N extends Notification, I extends DataContainer>
     void hookFutureNotification(
@@ -130,8 +133,10 @@ public abstract class OFRpcTaskUtil {
     }
 
     /**
-     * @param task of rpcl
-     * @param originalResult
+     * @param task of rpc
+     * @param originalResult original result
+     * @param <T> R
+     * @param <I> I
      * @return chained result with barrier
      */
     public static <T extends TransactionAware, I extends DataContainer>
@@ -165,8 +170,10 @@ public abstract class OFRpcTaskUtil {
     }
 
     /**
-     * @param originalInput
-     * @return
+     * @param originalInput original input
+     * @param barrierInput barrier input
+     * @param <T> T
+     * @return result
      */
     protected static <T extends TransactionAware> Function<RpcResult<BarrierOutput>, RpcResult<T>> transformBarrierToTransactionAware(
             final RpcResult<T> originalInput, final BarrierInput barrierInput) {
index ed64fa58ccc3fa0c5d7105105ac8b8893ea35552..7c844e9df501142d8b4fa691c9fc1e8147ee6b78 100644 (file)
@@ -203,7 +203,7 @@ public final class ActionConvertor {
      *
      * @param actions    SAL actions
      * @param version    Openflow protocol version used
-     * @param datapathid
+     * @param datapathid datapath id
      * @param flow       TODO
      * @return OF Library actions
      */
@@ -927,7 +927,7 @@ public final class ActionConvertor {
     /**
      * Method to convert OF actions associated with bucket to SAL Actions.
      *
-     * @param actionList
+     * @param actionList action list
      * @param ofVersion  current ofp version
      * @param actionPath TODO
      * @return List of converted SAL Actions.
@@ -1006,8 +1006,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF Output action object to SAL Output action object.
      *
-     * @param ofVersion
-     * @param ofVersion
+     * @param ofVersion openflow version
      * @param action    org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.
      *                  action.rev130731.actions.actions.list.Action
      * @return OutputAction
@@ -1045,8 +1044,8 @@ public final class ActionConvertor {
     /**
      * Method converts OF GroupAction object to SAL GroupAction object
      *
-     * @param action
-     * @return GroupAction
+     * @param action action
+     * @return GroupAction group action
      */
     public static GroupActionCase ofToSALGroupAction(final Action action) {
         GroupCase actionCase = (GroupCase) action.getActionChoice();
@@ -1064,8 +1063,8 @@ public final class ActionConvertor {
      * Method converts OF SetMplsTTL action object to SAL SetMplsTTL action
      * object.
      *
-     * @param action
-     * @return
+     * @param action action
+     * @return set-mpls ttl action
      */
     public static SetMplsTtlActionCase ofToSALSetMplsTtl(final Action action) {
         SetMplsTtlCase actionCase = (SetMplsTtlCase) action.getActionChoice();
@@ -1081,7 +1080,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF Pushvlan action to SAL PushVlan action.
      *
-     * @param action
+     * @param action input actioj
      * @return PushVlanAction
      */
     public static PushVlanActionCase ofToSALPushVlanAction(final Action action) {
@@ -1100,7 +1099,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF PushMpls action to SAL PushMpls action.
      *
-     * @param action
+     * @param action action
      * @return PushMplsAction
      */
     public static PushMplsActionCase ofToSALPushMplsAction(final Action action) {
@@ -1116,7 +1115,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF PopMpls action to SAL PopMpls action.
      *
-     * @param action
+     * @param action action
      * @return PopMplsActionCase
      */
     public static PopMplsActionCase ofToSALPopMplsAction(final Action action) {
@@ -1132,7 +1131,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF SetQueue action to SAL SetQueue action.
      *
-     * @param action
+     * @param action action
      * @return SetQueueAction
      */
     public static SetQueueActionCase ofToSALSetQueue(final Action action) {
@@ -1149,7 +1148,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF SetNwTtl action to SAL SetNwTtl action.
      *
-     * @param action
+     * @param action action
      * @return SetNwTtlAction
      */
     public static SetNwTtlActionCase ofToSALSetNwTtl(final Action action) {
@@ -1165,7 +1164,7 @@ public final class ActionConvertor {
     /**
      * Method converts OF Pushvlan action to SAL PushVlan action.
      *
-     * @param action
+     * @param action action
      * @return PushVlanAction
      */
     public static PushPbbActionCase ofToSALPushPbbAction(final Action action) {
index 93bf7cf5270e5c5b5d21c4aa507ed39da34dda9f..fe0ccc1851728d9232e9288ff08ba57ebf2a5ede 100644 (file)
@@ -169,6 +169,11 @@ public class FlowConvertor {
      * This method converts the SAL Flow to OF Flow.
      * It checks if there is a set-vlan-id (1.0) action made on OF1.3.
      * If yes its handled separately
+     *
+     * @param srcFlow source flow
+     * @param version openflow version
+     * @param datapathId datapath id
+     * @return list of flow mod build
      */
     public static List<FlowModInputBuilder> toFlowModInputs(Flow srcFlow, short version, BigInteger datapathId) {
         if (version >= OFConstants.OFP_VERSION_1_3 && isSetVlanIdActionCasePresent(srcFlow)) {
index d98ba1d66b49efd0650073ccdc718143ccef1e49..63f3da1456202b7b1a1d3a08f3e022ca132c9e4b 100644 (file)
@@ -38,8 +38,10 @@ public class FlowStatsResponseConvertor {
     /**
      * Method returns the list of MD-SAL format flow statistics, converted flow Openflow
      * specific flow statistics.
-     * @param allFlowStats
-     * @return
+     * @param allFlowStats all flow stats
+     * @param datapathid  datapath id
+     * @param ofVersion  openflow version
+     * @return list of flow and statistics mapping
      */
     public List<FlowAndStatisticsMapList> toSALFlowStatsList(List<FlowStats> allFlowStats, BigInteger datapathid, OpenflowVersion ofVersion){
 
@@ -55,8 +57,10 @@ public class FlowStatsResponseConvertor {
     /**
      * Method convert Openflow switch specific flow statistics to the MD-SAL format
      * flow statistics.
-     * @param flowStats
-     * @return
+     * @param flowStats flow statis
+     * @param datapathid  datapath id
+     * @param ofVersion  openflow version
+     * @return flow and statistics map
      */
     public FlowAndStatisticsMapList toSALFlowStats(FlowStats flowStats, BigInteger datapathid, OpenflowVersion ofVersion){
         FlowAndStatisticsMapListBuilder salFlowStatsBuilder = new FlowAndStatisticsMapListBuilder();
index 97a4be848cab8ce2562988843483e7367604b415..459f7e17415beabef47d48a3058e4a977840c3a1 100644 (file)
@@ -524,8 +524,9 @@ public final class IpConversionUtil {
 
     /**
      * Print a v6 prefix in byte array + 1 notation
-     *
      * @param _binary_form - prefix, in byte [] form, last byte is netmask
+     * @return string of v6 prefix
+     * @throws UnknownHostException unknown host exception
      */
     public static String byteArrayV6PrefixToString(final byte [] _binary_form) throws UnknownHostException {
         /* NO DIY!!! - InetAddresses will actually print correct canonical
index f8a61de3beb434978ec60f9c8cffef6bda3c5096..41a10aaf29ffaf1af3b79efd0c30f910e3cca911 100644 (file)
@@ -53,9 +53,8 @@ public final class MeterConvertor {
 
     // Get all the data for the meter from the Yang/SAL-Layer
     /**
-     * @param version
-     * @param source
-     *            Data source
+     * @param version of version
+     * @param source Data source
      * @return MeterModInput required by OF Library
      */
     public static MeterModInputBuilder toMeterModInput(
index 5c4b9ac65b3b39dc45b89f043ccf5d0108b4f329..35f6ae19a8e8012bc306ba9f20881d6c5e07a3bf 100644 (file)
@@ -56,7 +56,7 @@ public class MeterStatsResponseConvertor {
     /**
      * Method converts list of OF Meter Stats to SAL Meter Stats.
      *
-     * @param allMeterStats
+     * @param allMeterStats all meter stats
      * @return List of MeterStats
      */
     public List<MeterStats> toSALMeterStatsList(
@@ -116,7 +116,7 @@ public class MeterStatsResponseConvertor {
     /**
      * Method convert list of OF Meter config Stats to SAL Meter Config stats
      *
-     * @param allMeterConfigs
+     * @param allMeterConfigs all meter configs
      * @return list of MeterConfigStats
      */
     public List<MeterConfigStats> toSALMeterConfigList(List<MeterConfig> allMeterConfigs) {
index 1bdb5579208181b24adb4fbb4383680bf85c6591..4ca2d58bdae323d8b89d91c705a47f357b70e1b3 100644 (file)
@@ -49,9 +49,9 @@ public final class OFToMDSalFlowConvertor {
      * Method convert Openflow 1.3+ specific instructions to MD-SAL format
      * flow instruction
      *
-     * @param instructions
+     * @param instructions instructions
      * @param ofVersion    current ofp version
-     * @return
+     * @return instruction converted to SAL instruction
      */
     public static Instructions toSALInstruction(
             List<org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction> instructions, OpenflowVersion ofVersion) {
@@ -161,6 +161,8 @@ public final class OFToMDSalFlowConvertor {
      * Method wraps openflow 1.0 actions list to Apply Action Instructions
      *
      * @param ofVersion current ofp version
+     * @param actionsList list of action
+     * @return OF10 actions as an instructions
      */
 
     public static Instructions wrapOF10ActionsToInstruction(
index d67412703c04b1de53caa4205c4fb0d8ad5d1879..8e01cd0877bbb2363e8b641ae1bd0f0e4b279cfe 100644 (file)
@@ -40,8 +40,10 @@ public final class PacketOutConvertor {
     // Get all the data for the PacketOut from the Yang/SAL-Layer
 
     /**
-     * @param version
-     * @param inputPacket
+     * @param version openflow version
+     * @param inputPacket input packet
+     * @param datapathid  datapath id
+     * @param xid tx id
      * @return PacketOutInput required by OF Library
      */
     public static PacketOutInput toPacketOutInput(final TransmitPacketInput inputPacket, final short version, final Long xid,
index 2d6d3dd1b6754e0d65593a9ca03edbf43fd1a705..673ba54ba9d1e81f18ac50d5d51f0b16f7c65ddd 100644 (file)
@@ -38,8 +38,9 @@ public final class PortConvertor {
     /**
      * This method is used by PORT_MOD_MESSAGE
      *
-     * @param source
-     * @return
+     * @param source source port
+     * @param version openflow version
+     * @return port mod input
      */
 
     public static PortModInput toPortModInput(
@@ -115,8 +116,8 @@ public final class PortConvertor {
      * message(OF1.3.1)
      */
     /**
-     * @param source
-     *            :SAL FlowCapablePort
+     * @param source FlowCapablePort
+     * @param version openflow version
      * @return OF:Ports
      */
     public static Ports toPortDesc(
index fde4794a8ac38fa9eaf85c7814894fbf08206bc6..098b3cc3634ff65e9b106356b8ab79fb965bd41f 100644 (file)
@@ -43,7 +43,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.matc
 public class ActionSetNwDstReactorMappingFactory {
 
     /**
-     * @param conversionMapping
+     * @param conversionMapping conversion mapping
      */
     public static void addSetNwDstConvertors(final Map<Short, Convertor<SetNwDstActionCase, ?>> conversionMapping) {
         conversionMapping.put(OFConstants.OFP_VERSION_1_0, new ActionSetNwDstConvertorV10Impl());
@@ -51,7 +51,7 @@ public class ActionSetNwDstReactorMappingFactory {
     }
 
     /**
-     * @param injectionMapping
+     * @param injectionMapping injection mapping
      */
     public static void addSetNwDstInjectors(final Map<InjectionKey, ResultInjector<?, ?>> injectionMapping) {
         // OF-1.0| Ipv4Address -> ActionBuilder; SetNwDst
index 33add1cd56084a99cd6ce443899363d25ec7c281..376414a460d293444be79713780fc83b3c40d38b 100644 (file)
@@ -44,7 +44,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.matc
 public class ActionSetNwSrcReactorMappingFactory {
 
     /**
-     * @param conversionMapping
+     * @param conversionMapping conversion mapping
      */
     public static void addSetNwSrcConvertors(final Map<Short, Convertor<SetNwSrcActionCase, ?>> conversionMapping) {
         conversionMapping.put(OFConstants.OFP_VERSION_1_0, new ActionSetNwSrcConvertorV10Impl());
@@ -52,7 +52,7 @@ public class ActionSetNwSrcReactorMappingFactory {
     }
 
     /**
-     * @param injectionMapping
+     * @param injectionMapping injection mapping
      */
     public static void addSetNwSrcInjectors(final Map<InjectionKey, ResultInjector<?, ?>> injectionMapping) {
         // OF-1.0| Ipv4Address -> ActionBuilder; SetNwSrc
index 0c96de60383978760d0d262a0f5b9f71b85f79f2..d6e60b2a420a13b6aad60881a3a071f91f3c19d8 100644 (file)
@@ -34,17 +34,19 @@ public abstract class ConvertReactor<FROM> {
 
     /**
      * fill conversion and injection mappings
-     * @param conversions
-     * @param injections
+     * @param conversions convert from
+     * @param injections injection
      */
     protected abstract void initMappings(Map<Short, Convertor<FROM, ?>> conversions,
             Map<InjectionKey, ResultInjector<?, ?>> injections);
 
     /**
-     * @param source
-     * @param version
-     * @param target
-     * @param datapathid
+     * @param source convert from
+     * @param version openflow version
+     * @param target convert to
+     * @param datapathid datapath id
+     * @param <RESULT> result
+     * @param <TARGET> target
      */
     @SuppressWarnings("unchecked")
     public <RESULT, TARGET> void convert(final FROM source, final short version, final TARGET target, final BigInteger datapathid) {
@@ -66,10 +68,10 @@ public abstract class ConvertReactor<FROM> {
     }
 
     /**
-     * @param version
+     * @param version openflow version
      * @param convertedItem to be injected
      * @param target object
-     * @return
+     * @return injection key
      */
     protected InjectionKey buildInjectionKey(final short version, final Object convertedItem, final Object target) {
         return new InjectionKey(version, target.getClass());
index 0bdd660889497fa72219ef5e98dd96d4c80546cd..4583a15587c2ee7d45dcfd5e0a636ea8b7068ef8 100644 (file)
@@ -19,8 +19,8 @@ import java.math.BigInteger;
 public interface Convertor<FROM, TO> {
     
     /**
-     * @param source
-     * @param datapathid 
+     * @param source source type
+     * @param datapathid  datapath id
      * @return converted match (into OF-API model)
      */
     TO convert(FROM source,BigInteger datapathid);
index 127e3fd89315ee02067fbfd6fefb3a540f328f4b..8c7ab330deba262277ad417b630f0fad3f016eb4 100644 (file)
@@ -22,8 +22,8 @@ public class InjectionKey {
     private final Class<?> targetClazz;
 
     /**
-     * @param version
-     * @param targetClazz
+     * @param version openflow version
+     * @param targetClazz target class
      */
     public InjectionKey(final int version, final Class<?> targetClazz) {
         this.version = version;
index 4e59059692205539286ccd7acc743d42f1b8485e..7d1e8adfbe2ed003890b1497cd9250236a605885 100644 (file)
@@ -19,9 +19,9 @@ public class InjectionResultTargetKey extends InjectionKey {
     private final Class<?> resultClazz;
 
     /**
-     * @param version
-     * @param targetClazz
-     * @param resultClazz
+     * @param version openflow version
+     * @param targetClazz target class
+     * @param resultClazz result class
      */
     public InjectionResultTargetKey(final int version, final Class<?> targetClazz, final Class<?> resultClazz) {
         super(version, targetClazz);
index 70584a901e57b3d780843b8faaa42e8364b1d229..cb2cb1edf1e18eab06855d8fb7b6bdd4fd7755a9 100644 (file)
@@ -14,7 +14,7 @@ import java.util.Comparator;
 /**
  * Comparator for comparing objects which extend Ordered.
  *
- * @param <T>
+ * @param <T> T
  */
 public class OrderComparator<T extends Ordered> implements Comparator<T> {
 
index ceabb4dddd4737a1dd6233028ca93c6316faccde..43988815623b3d1eb3f217068d476422d8b5ab79 100644 (file)
@@ -17,8 +17,8 @@ package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.common;
 public interface ResultInjector<R, T> {
 
     /**
-     * @param result
-     * @param target
+     * @param result result
+     * @param target target
      */
     void inject(R result, T target);
     
index 7daa4a4d75a2ed89a448d737a09f7e1043e8b750..fc798c9fbfcab04c68a9c6d0ea6509caf426b7e8 100644 (file)
@@ -20,7 +20,8 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowMo
 public interface FlowFlagConvertor<E> extends Convertor<FlowModFlags, E> {
     
     /**
-     * @param source
+     * @param source flow mode flags
+     * @param datapathid  datapath id
      * @return converted match (into OF-API model)
      */
     @Override
index 68740853f3b9a93466219241fded41821926f0cc..bb5a685b27e6dbd80e745940a5493ec15ad42d27 100644 (file)
@@ -25,7 +25,7 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 public class FlowFlagReactorMappingFactory {
 
     /**
-     * @param conversionMapping
+     * @param conversionMapping conversion mapping
      */
     public static void addFlowFlagsConvertors(final Map<Short, Convertor<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowModFlags, ?>> conversionMapping) {
         conversionMapping.put(OFConstants.OFP_VERSION_1_3, new FlowFlagsConvertorImpl());
@@ -33,7 +33,7 @@ public class FlowFlagReactorMappingFactory {
     }
 
     /**
-     * @param injectionMapping
+     * @param injectionMapping injection mapping
      */
     public static void addFlowFlagsIjectors(final Map<InjectionKey, ResultInjector<?, ?>> injectionMapping) {
         // OF-1.3|FlowModFlags --> FlowModInputBuilder
index 2dfede1aa5b5a28f4d841d62464a40b602fac6b4..c51761c9e3454be3c0f2098e1bc118988fb39880 100644 (file)
@@ -20,7 +20,8 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026
 public interface MatchConvertor<E> extends Convertor<Match, E> {
     
     /**
-     * @param source
+     * @param source match input
+     * @param datapathid datapath id
      * @return converted match (into OF-API model)
      */
     @Override
index a6240b35ef97c8d4a6d5c8c6e441e44b81320e16..e41912152091658c49aa8a0752ee35f0ad5025a5 100644 (file)
@@ -910,10 +910,10 @@ public class MatchConvertorImpl implements MatchConvertor<List<MatchEntry>> {
     /**
      * Method convert Openflow 1.0 specific flow match to MD-SAL format flow
      * match
-     *
-     * @param swMatch
-     * @return
-     * @author avishnoi@in.ibm.com
+     * @param swMatch source match
+     * @param datapathid datapath id
+     * @param ofVersion openflow version
+     * @return match builder
      */
     public static MatchBuilder fromOFMatchV10ToSALMatch(@Nonnull final MatchV10 swMatch, @Nonnull final BigInteger datapathid, @Nonnull final OpenflowVersion ofVersion) {
         MatchBuilder matchBuilder = new MatchBuilder();
@@ -1072,10 +1072,9 @@ public class MatchConvertorImpl implements MatchConvertor<List<MatchEntry>> {
      * Method converts Openflow 1.3+ specific flow match to MD-SAL format flow
      * match
      *
-     * @param swMatch
-     * @param swMatch
-     * @param datapathid
-     * @param ofVersion
+     * @param swMatch source match
+     * @param datapathid datapath id
+     * @param ofVersion openflow version
      * @return md-sal match instance
      * @author avishnoi@in.ibm.com
      */
@@ -1823,9 +1822,9 @@ public class MatchConvertorImpl implements MatchConvertor<List<MatchEntry>> {
     /**
      * Method converts OF SetField action to SAL SetFiled action.
      *
-     * @param action
+     * @param action input action
      * @param ofVersion current ofp version
-     * @return
+     * @return set field builder
      */
     public static SetField fromOFSetFieldToSALSetFieldAction(
             final Action action, final OpenflowVersion ofVersion) {
index deb1d318ea9a2d1164d0ccb984da07c6de9d5d43..cc95a7bc2595df7cf7020387209fcec452023d16 100644 (file)
@@ -17,7 +17,7 @@ public abstract class MatchConvertorUtil {
     private static final String PREFIX_SEPARATOR = "/";
 
     /**
-     * @param pField
+     * @param pField ipv6 external header flag
      * @return integer containing lower 9 bits filled with corresponding flags
      */
     public static Integer ipv6ExthdrFlagsToInt(final Ipv6ExthdrFlags pField) {
index ba6648df0bb75c0d1a772911f3b7043e9adde5ec..bc4ca0c4e6654887b5fa9692ddd6bd17f7ad34a3 100644 (file)
@@ -32,7 +32,7 @@ import java.util.Map;
 public class MatchReactorMappingFactory {
 
     /**
-     * @param conversionMapping
+     * @param conversionMapping conversion mapping
      */
     public static void addMatchConvertors(final Map<Short, Convertor<Match, ?>> conversionMapping) {
         conversionMapping.put(OFConstants.OFP_VERSION_1_3, new MatchConvertorImpl());
@@ -40,7 +40,7 @@ public class MatchReactorMappingFactory {
     }
 
     /**
-     * @param injectionMapping
+     * @param injectionMapping injection mapping
      */
     public static void addMatchIjectors(final Map<InjectionKey, ResultInjector<?, ?>> injectionMapping) {
         // OF-1.3|List<MatchEntries> --> FlowModInputBuilder
index b836c0453974adfac9cf172f1f105d091bfd04cc..94b32cd256c9171a15469e2ad5e41e22a2c2eb1d 100644 (file)
@@ -19,7 +19,7 @@ public interface IGetBandwith {
 
        /**
         * 
-        * @param port
+        * @param port port group
         * @return port bandwidth
         */
     public boolean getBandwidth(PortGrouping port);
index acf5530fa0cfc83d1e1556a9b4a51c7c49d77087..fa5f7a519b94074d1e92f26e7ec3c1b7ba1260c8 100644 (file)
@@ -53,7 +53,7 @@ public class OFRoleManager implements AutoCloseable {
     private final SessionManager sessionManager;
 
     /**
-     * @param sessionManager
+     * @param sessionManager switch connection session manager
      */
     public OFRoleManager(final SessionManager sessionManager) {
         Preconditions.checkNotNull("Session manager can not be empty.", sessionManager);
@@ -73,7 +73,7 @@ public class OFRoleManager implements AutoCloseable {
     /**
      * change role on each connected device
      *
-     * @param role
+     * @param role openflow role
      */
     public void manageRoleChange(final OfpRole role) {
         for (final SessionContext session : sessionManager.getAllSessions()) {
index faa981c6ae71349aff8efb8434fbccf9e122de71..f00b2d7434ba51c7889624624a757079897afde5 100644 (file)
@@ -17,15 +17,15 @@ public class RolePushException extends Exception {
     /**
      * default ctor
      *
-     * @param message
+     * @param message exception message
      */
     public RolePushException(String message) {
         super(message);
     }
 
     /**
-     * @param message
-     * @param cause
+     * @param message exception message
+     * @param cause exception cause
      */
     public RolePushException(String message, Throwable cause) {
         super(message, cause);
index e799d168ddebdf6e552178f34b0f93ea2060ab98..17aec61063cc9cdfc81dcc0667b3fd80edd84ea4 100644 (file)
@@ -23,7 +23,7 @@ public class SwitchConnectionCookieOFImpl implements SwitchConnectionDistinguish
     private long cookie;
 
     /**
-     * @param cookie
+     * @param cookie switch connection cookie
      */
     public SwitchConnectionCookieOFImpl(long cookie) {
         this.cookie = cookie;
@@ -37,8 +37,7 @@ public class SwitchConnectionCookieOFImpl implements SwitchConnectionDistinguish
     }
 
     /**
-     * @param auxiliaryId
-     *            the auxiliaryId to set
+     * @param auxiliaryId  the auxiliaryId to set
      */
     public void setAuxiliaryId(short auxiliaryId) {
         this.auxiliaryId = auxiliaryId;
index 521e5700941d0a3fb65e7df5867e524663d3b05c..a03c093b7c419d2d7172bdc536d3acc3cc95b6b7 100644 (file)
@@ -61,10 +61,10 @@ public abstract class AbstractErrorTranslator implements IMDMessageTranslator<Of
     }
 
     /**
-     * @param message
-     * @param errorType
-     * @param node
-     * @return
+     * @param message error message
+     * @param errorType error type
+     * @param node node ref
+     * @return error message
      */
     protected abstract org.opendaylight.yang.gen.v1.urn.opendaylight.flow.errors.rev131116.ErrorMessage getGranularNodeErrors(ErrorMessage message, ErrorType errorType, NodeRef node);
 
index af2a5b6b62aa047ac0c1141609c3d15f86362f22..3d65a844ddd5ec2de7bbc318c1fc71b67a0ee2cf 100644 (file)
@@ -39,9 +39,9 @@ public class ErrorV10Translator extends AbstractErrorTranslator {
     }
 
     /**
-     * @param message
-     * @param errorType
-     * @param node
+     * @param message error message
+     * @param errorType error type
+     * @param node reference to node, that sent the error message
      * @return translated error message of general type (OF-1.0)
      */
     @Override
index 7a923bbf2adcde072f0f881595ac67b1deb9b0e2..cc543eb99172aa563c3144f1c16d09bdef552014 100644 (file)
@@ -20,8 +20,8 @@ public class MessageSourcePollRegistration<IN> implements AutoCloseable {
     private IN messageSource;
     
     /**
-     * @param messageSourceRegistry
-     * @param messageSource 
+     * @param messageSourceRegistry message source registry
+     * @param messageSource  message source
      */
     public MessageSourcePollRegistration(MessageSourcePollRegistrator<IN> messageSourceRegistry,
             IN messageSource) {
index 616b31ea4111534f98ad0350f40eedb9dc70df56..9ecdf433f3f55116a83bc6cb586a229f74986be6 100644 (file)
@@ -24,9 +24,9 @@ public class QueueItemOFImpl implements QueueItem<OfHeader> {
     
     
     /**
-     * @param message
-     * @param connectionConductor
-     * @param queueType
+     * @param message openflow message
+     * @param connectionConductor switch connection conductor
+     * @param queueType queue type
      */
     public QueueItemOFImpl(OfHeader message,
             ConnectionConductor connectionConductor, QueueType queueType) {
index 1143afa1def797c68a85f1f44f02b69eba2c5222..918dfede3260ad2aad8e43c62f0afa369ff59e75 100644 (file)
@@ -20,10 +20,9 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 public abstract class QueueKeeperFactory {
 
     /**
-     * @param sourceRegistrator
-     * @param capacity
-     *            blocking queue capacity
-     * @param waterMarkListener
+     * @param sourceRegistrator source registrator
+     * @param capacity blocking queue capacity
+     * @param waterMarkListener water mark listener
      * @return fair reading implementation of
      *         {@link org.opendaylight.openflowplugin.api.openflow.md.queue.QueueKeeper}
      *         (not registered = not started yet)
@@ -45,8 +44,8 @@ public abstract class QueueKeeperFactory {
      * {@link QueueKeeperFairImpl#close()} to kill the queue and stop
      * processing.
      * 
-     * @param sourceRegistrator
-     * @param queueKeeper
+     * @param sourceRegistrator source registrator
+     * @param queueKeeper queue keeper
      */
     public static <V> void plugQueue(
             MessageSourcePollRegistrator<QueueKeeper<V>> sourceRegistrator,
index f86dcd0deed53c3efa0492058cf002b066c0a3ea..656df50e572bb9c032e4feaa6d0b9290b481e492 100644 (file)
@@ -117,7 +117,7 @@ public class QueueKeeperFairImpl implements QueueKeeper<OfHeader> {
     }
 
     /**
-     * @param harvesterHandle
+     * @param harvesterHandle harvester handle
      */
     public void setHarvesterHandle(HarvesterHandle harvesterHandle) {
         this.harvesterHandle = harvesterHandle;
index 2a82d335e08bf514a1b2682f4ba61da479bd62c7..3d4657f5d035610d92f38757a0359a65aa706393 100644 (file)
@@ -16,7 +16,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * @param <IN>
+ * @param <IN> Type of queue keeper harvester
  *
  */
 public class QueueKeeperHarvester<IN> implements Runnable, HarvesterHandle {
@@ -29,8 +29,8 @@ public class QueueKeeperHarvester<IN> implements Runnable, HarvesterHandle {
     private volatile boolean wakeMe = false;
 
     /**
-     * @param enqueuer
-     * @param messageSources
+     * @param enqueuer queue enqueuer
+     * @param messageSources source of message
      */
     public QueueKeeperHarvester(final Enqueuer<QueueItem<IN>> enqueuer,
             final Collection<QueueKeeper<IN>> messageSources) {
index 0018b2da99e5086e30217836b758cdc5ae124f5d..d312d62faca4e7ddbba0fe4f8b33e7b7214cb80a 100644 (file)
@@ -22,7 +22,7 @@ public interface TicketFinisher<OUT> extends Runnable {
     
     /**
      * notify popListeners
-     * @param processedMessages
+     * @param processedMessages processed message
      */
     void firePopNotification(List<OUT> processedMessages);
 }
index 2607e12a2a0eeab2e54b44e188a9be2223a19b44..111f5c7226ca967e471a021dadca94f54322f8ad 100644 (file)
@@ -32,8 +32,8 @@ public class TicketFinisherImpl implements TicketFinisher<DataObject> {
     private BlockingQueue<TicketResult<DataObject>> queue;
 
     /**
-     * @param queue
-     * @param popListenersMapping
+     * @param queue ticket queue
+     * @param popListenersMapping message pop listener
      */
     public TicketFinisherImpl(BlockingQueue<TicketResult<DataObject>> queue,
             Map<Class<? extends DataObject>, Collection<PopListener<DataObject>>> popListenersMapping) {
index 50cb775e67ffd1588686d8b8e950ea1539251642..3018d8212c5d0ce61ec300d243ac87406ee487ca 100644 (file)
@@ -18,25 +18,25 @@ import org.opendaylight.yangtools.yang.binding.DataContainer;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 
 /**
- * @param <IN>
- * @param <OUT>
+ * @param <IN> type of DataObject
+ * @param <OUT> type of DataObject
  */
 public interface TicketProcessorFactory<IN extends DataObject, OUT extends DataObject> {
 
     /**
-     * @param ticket
+     * @param ticket ticket
      * @return runnable ticket processor
      */
     Runnable createProcessor(final Ticket<IN, OUT> ticket);
 
     /**
-     * @param ticket
+     * @param ticket ticket
      * @return runnable ticket processor
      */
     Runnable createSyncProcessor(final Ticket<IN, OUT> ticket);
 
     /**
-     * @param ticket
+     * @param ticket ticket
      * @return translated messages
      * 
      */
index 8b869caf7038a0498aed6d109af15f06a7dd5898..45fc0433ebf5d0e33d02e4b1ba4f2c2c41208c47 100644 (file)
@@ -61,7 +61,7 @@ public class TicketProcessorFactoryImpl implements TicketProcessorFactory<OfHead
     }
 
     /**
-     * @param ticket
+     * @param ticket ticket
      * @return runnable ticket processor
      */
     @Override
@@ -98,7 +98,7 @@ public class TicketProcessorFactoryImpl implements TicketProcessorFactory<OfHead
     }
 
     /**
-     * @param ticket
+     * @param ticket ticket
      * @return runnable ticket processor
      */
     @Override
@@ -131,7 +131,7 @@ public class TicketProcessorFactoryImpl implements TicketProcessorFactory<OfHead
 
 
     /**
-     * @param ticket
+     * @param ticket ticket
      *
      */
     @Override
index f7c682df23fe0370436ed1fe5cf34b3d210940ba..c41c26b8b06fa685b6a6c24fddbe6c385531fd4b 100644 (file)
@@ -26,8 +26,8 @@ public abstract class ByteUtil {
     private static final BaseEncoding HEX_16_ENCODING = PLAIN_HEX_16_ENCODING.withSeparator(DEFAULT_HEX_SEPARATOR, 2);
 
     /**
-     * @param bytes
-     * @param delimiter
+     * @param bytes bytes that needs to be converted to hex
+     * @param delimiter string delimiter
      * @return hexString containing bytes, separated with delimiter
      */
     public static String bytesToHexstring(final byte[] bytes, final String delimiter) {
@@ -41,7 +41,8 @@ public abstract class ByteUtil {
     /**
      * Utility method to convert BigInteger to n element byte array
      *
-     * @param bigInteger
+     * @param bigInteger big integer value that needs to be converted to byte
+     * @param numBytes convert to number of bytes
      * @return byte array containing n * 8 bits.
      */
     public static byte[] convertBigIntegerToNBytes(final BigInteger bigInteger, final int numBytes) {
index 9aca175600c34440ee269298f5641e6d130c3b72..4661258de3b13509a9986c467942aaa4b3b2b91f 100644 (file)
@@ -63,7 +63,7 @@ public final class FlowCreatorUtil {
     /**
      * Method creates openflow 1.0 format match, that can match all the flow entries.
      *
-     * @return
+     * @return V10 Match object
      */
     public static MatchV10 createWildcardedMatchV10() {
         MatchV10Builder builder = new MatchV10Builder();
index 0cd21ea335c4eb5bd273c2f9565f407b94cce6db..e4cb1c0c85afb33e433384a4f49f9385acad6e2b 100644 (file)
@@ -187,7 +187,7 @@ public abstract class InventoryDataServiceUtil {
     }
 
     /**
-     * @param dataPathId
+     * @param dataPathId datapath id in big interger value
      * @return string of size 16, padded with '0'
      */
     public static String bigIntegerToPaddedHex(final BigInteger dataPathId) {
index f8f64e51b4fbfed307ad6b776287f25d8733e95f..daffbf396b6f955784410824f0dcdcfd3fe4bc36 100644 (file)
@@ -122,8 +122,8 @@ public class OpenflowPortsUtil {
     }
 
     /**
-     * @param ofVersion
-     * @param portNumber
+     * @param ofVersion OpenFlow version of the switch
+     * @param portNumber port number
      * @return true if port number is valid for given protocol version
      */
     public static boolean checkPortValidity(final OpenflowVersion ofVersion, final Long portNumber) {
@@ -141,7 +141,7 @@ public class OpenflowPortsUtil {
     }
 
     /**
-     * @param portNumber
+     * @param portNumber port number
      * @return string containing number or logical name
      */
     public static String portNumberToString(final PortNumberUni portNumber) {
index 309411ffe070f57459c054937480c5a7880a7ff5..0f2698b865df593dbd712ff4bcadc8d31f7b6d5d 100644 (file)
@@ -23,7 +23,7 @@ public final class PacketInUtil {
     }
 
     /**
-     * @param reason
+     * @param reason openflow java packet in reason
      * @return corresponding MD-SAL reason class for given OF-API reason
      */
     public static Class<? extends PacketInReason> getMdSalPacketInReason(org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PacketInReason reason) {
index 42360e9fc1d990fab778a1a6abaea2de5c51cd1f..36f465201192daa236bc92e711be169e9eb75afa 100644 (file)
@@ -18,8 +18,8 @@ public class RpcInputOutputTuple<IN, OUT> {
     
     
     /**
-     * @param input
-     * @param output
+     * @param input input
+     * @param output output
      */
     public RpcInputOutputTuple(IN input, OUT output) {
         this.input = input;
index 4ade36caa3c3738d325fd5b4d6862ee93c4ac224..ac4305e83dd0201ac1d37faf9b072732ff582a24 100644 (file)
@@ -27,7 +27,8 @@ public final class RpcResultUtil {
     }
 
     /**
-     * @param e
+     * @param e connection exception
+     * @param <T> rpc result return type
      * @return error wrapped inside {@link RpcResult} which is wrapped inside future
      */
     public static <T> SettableFuture<RpcResult<T>> getRpcErrorFuture(ConnectionException e) {
index df01952f494207dd55c6616498bb506e24cbc06c..5ec05a13936747546203515115f7aa859c77b8b4 100644 (file)
@@ -28,9 +28,9 @@ public final class TaskUtil {
     }
 
     /**
-     * @param session
-     * @param cookie
-     * @param messageService
+     * @param session switch session context
+     * @param cookie connection distinguisher cookie value
+     * @param messageService message dispatch service instance
      * @return barrier response
      */
     public static RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrier(SessionContext session,