Fix checkstyle warnings

[openflowplugin.git] / openflowplugin-api / src / main / java / org / opendaylight / openflowplugin / api / openflow / md / core / ConnectionConductor.java

diff --git a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/md/core/ConnectionConductor.java b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/md/core/ConnectionConductor.java
index e1ea51f563f2db37dec124dfd9ef0bd2c50fed86..6d517eb73ef90e3ab058827e0133537d48a577f2 100644 (file)
--- a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/md/core/ConnectionConductor.java
+++ b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/md/core/ConnectionConductor.java
@@ -18,93 +18,94 @@ import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731
 import org.opendaylight.yangtools.yang.binding.DataObject;
 
 
-/**
- * @author mirehak
- */
 public interface ConnectionConductor {
 
-    /** distinguished connection states */
-    public enum CONDUCTOR_STATE {
-        /** initial phase of talking to switch */
+    /** distinguished connection states. */
+    @SuppressWarnings({"checkstyle:abbreviationaswordinname", "checkstyle:typename"})
+    enum CONDUCTOR_STATE {
+        /** initial phase of talking to switch. */
         HANDSHAKING,
-        /** standard phase - interacting with switch */
+        /** standard phase - interacting with switch. */
         WORKING,
-        /** connection is idle, waiting for echo reply from switch */
+        /** connection is idle, waiting for echo reply from switch. */
         TIMEOUTING,
-        /** talking to switch is over - resting in pieces */
+        /** talking to switch is over - resting in pieces. */
         RIP
     }
 
-    /** supported version ordered by height (highest version is at the beginning) */
-    List<Short> versionOrder = Lists.newArrayList((short) 0x04, (short) 0x01);
+    /** supported version ordered by height (highest version is at the beginning). */
+    List<Short> VERSION_ORDER = Lists.newArrayList((short) 0x04, (short) 0x01);
 
     /**
-     * initialize wiring around {@link ConnectionAdapter}
+     * initialize wiring around {@link ConnectionAdapter}.
      */
     void init();
 
     /**
-     * @return the negotiated version
+     * return the negotiated version.
      */
     Short getVersion();
 
     /**
-     * @return the state of conductor
+     * return the state of conductor.
      */
     CONDUCTOR_STATE getConductorState();
 
     /**
-     * @param conductorState
+     * Setter.
+     * @param conductorState state
      */
     void setConductorState(CONDUCTOR_STATE conductorState);
 
     /**
-     * terminates owned connection
+     * terminates owned connection.
      * @return future result of disconnect action
      */
     Future<Boolean> disconnect();
 
     /**
-     * assign corresponding {@link SessionContext} to this conductor (to handle disconnect caused by switch)
-     * @param context
+     * assign corresponding {@link SessionContext} to this conductor (to handle disconnect caused by switch).
+     * @param context session context
      */
     void setSessionContext(SessionContext context);
 
     /**
-     * assign corresponding {@link org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher} to this conductor
-     * to handle disconnect caused by switch. This involves auxiliary conductors only.
-     * @param auxiliaryKey
+     * assign corresponding {@link org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher}
+     * to this conductor to handle disconnect caused by switch. This involves auxiliary conductors only.
+     * @param auxiliaryKey key
      */
     void setConnectionCookie(SwitchConnectionDistinguisher auxiliaryKey);
 
     /**
-     * @return the sessionContext
+     * return the sessionContext.
      */
     SessionContext getSessionContext();
 
     /**
-     * @return the auxiliaryKey (null if this is a primary connection)
+     * return the auxiliaryKey (null if this is a primary connection).
      */
     SwitchConnectionDistinguisher getAuxiliaryKey();
 
     /**
-     * @return the connectionAdapter
+     * return the connectionAdapter.
      */
     ConnectionAdapter getConnectionAdapter();
 
     /**
-     * assign global queueKeeper
-     * @param queueKeeper
+     * assign global queueKeeper.
+     * @param queueKeeper keeper
      */
     void setQueueProcessor(QueueProcessor<OfHeader, DataObject> queueKeeper);
 
     /**
+     * Setter.
      * @param errorHandler for internal exception handling
      */
     void setErrorHandler(ErrorHandler errorHandler);
 
     /**
-     * @param conductorId
+     * Setter.
+     * @param conductorId id
      */
     void setId(int conductorId);