Fix problems with checkstyle in interfacemanager-api module 10/50610/2
authorDavid Suarez <david.suarez.fuentes@ericsson.com>
Wed, 18 Jan 2017 10:30:36 +0000 (11:30 +0100)
committerDavid Suarez <david.suarez.fuentes@ericsson.com>
Wed, 18 Jan 2017 11:14:11 +0000 (12:14 +0100)
Fix several problems found by checkstyle:

- Incomplete JavaDoc
- Formatting
- Line lengths
- Re-order methods and constructors
- Optimize imports

Change-Id: I52c5a63967406f03289750d3eca8931dc11e70d9
Signed-off-by: David Suarez <david.suarez.fuentes@ericsson.com>
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/exceptions/InterfaceAlreadyExistsException.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/exceptions/InterfaceNotFoundException.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/exceptions/InterfaceServiceNotFoundException.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/globals/IfmConstants.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/globals/InterfaceInfo.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/globals/InterfaceServiceUtil.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/globals/LogicalGroupInterfaceInfo.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/globals/VlanInterfaceInfo.java
interfacemanager/interfacemanager-api/src/main/java/org/opendaylight/genius/interfacemanager/interfaces/IInterfaceManager.java

index ec8ecdd8db25b7332b4908a78fddd1d1a6a276ed..c7fe17bcd2bd3595c75d4cfb705d6d4596d55473 100644 (file)
@@ -9,11 +9,8 @@ package org.opendaylight.genius.interfacemanager.exceptions;
 
 public class InterfaceAlreadyExistsException extends Exception {
 
-    /**
-     * 
-     */
     private static final long serialVersionUID = 1L;
-    
+
     public InterfaceAlreadyExistsException() {
 
     }
index 17cc49e0918e414ea3040635f4c8c8fbd7595ec7..e6dbbfbeeafb6aa8cba3ea7c61d637a1b3c4f044 100644 (file)
@@ -9,9 +9,6 @@ package org.opendaylight.genius.interfacemanager.exceptions;
 
 public class InterfaceNotFoundException extends Exception {
 
-    /**
-     * 
-     */
     private static final long serialVersionUID = 1L;
 
     public InterfaceNotFoundException() {
index e868b9465c8b5134c010e1a0fed184f587c064e8..21b266b9a2b59f7e08a194514f1c1c8a584c6fd1 100644 (file)
@@ -9,9 +9,6 @@ package org.opendaylight.genius.interfacemanager.exceptions;
 
 public class InterfaceServiceNotFoundException extends Exception {
 
-    /**
-     * 
-     */
     private static final long serialVersionUID = 1L;
 
     public InterfaceServiceNotFoundException() {
index b8296e007453e7738260ee5234c09873ea233f88..7e63a0d98f6bd95e8837075b112238844065ffb7 100644 (file)
@@ -19,19 +19,19 @@ public class IfmConstants {
     public static final int DEFAULT_ARP_FLOW_PRIORITY = 100;
     public static final int INVALID_PORT_NO = -1;
     public static final BigInteger INVALID_DPID = new BigInteger("-1");
-    //Id pool
+    // Id pool
     public static final String IFM_IDPOOL_NAME = "interfaces";
     public static final long IFM_ID_POOL_START = 1L;
     public static final long IFM_ID_POOL_END = 65535;
-    //Group Prefix
+    // Group Prefix
     public static final long VLAN_GROUP_START = 1000;
     public static final long TRUNK_GROUP_START = 20000;
     public static final long LOGICAL_GROUP_START = 100000;
-    //Table
+    // Table
     public static final long DELAY_TIME_IN_MILLISECOND = 10000;
-    //Cookies
+    // Cookies
     public static final BigInteger COOKIE_L3_BASE = new BigInteger("8000000", 16);
     public static final BigInteger COOKIE_EGRESS_DISPATCHER_TABLE = new BigInteger("1300000", 16);
-    //Tunnel Monitoring
+    // Tunnel Monitoring
     public static final int DEFAULT_MONITOR_INTERVAL = 10000;
 }
index 6a7cd4a26f395cef0b8bf613506c0cc31e417af2..29515dec82aaf194e377c3d4b8d4bea5dcd5b885 100644 (file)
@@ -12,12 +12,9 @@ import java.math.BigInteger;
 
 public class InterfaceInfo implements Serializable {
 
-    /**
-     *
-     */
     private static final long serialVersionUID = 1L;
 
-    public enum InterfaceType  {
+    public enum InterfaceType {
         VLAN_INTERFACE,
         VXLAN_TRUNK_INTERFACE,
         GRE_TRUNK_INTERFACE,
@@ -29,14 +26,11 @@ public class InterfaceInfo implements Serializable {
     }
 
     public enum InterfaceAdminState {
-        ENABLED,
-        DISABLED
+        ENABLED, DISABLED
     }
 
     public enum InterfaceOpState {
-        UP,
-        DOWN,
-        UNKNOWN
+        UP, DOWN, UNKNOWN
     }
 
     protected InterfaceType interfaceType;
@@ -52,14 +46,6 @@ public class InterfaceInfo implements Serializable {
     protected boolean isUntaggedVlan;
     protected String macAddress;
 
-    public String getInterfaceName() {
-        return interfaceName;
-    }
-
-    public void setInterfaceName(String interfaceName) {
-        this.interfaceName = interfaceName;
-    }
-
     public InterfaceInfo(BigInteger dpId, String portName) {
         this.dpId = dpId;
         this.portName = portName;
@@ -69,6 +55,14 @@ public class InterfaceInfo implements Serializable {
         this.portName = portName;
     }
 
+    public String getInterfaceName() {
+        return interfaceName;
+    }
+
+    public void setInterfaceName(String interfaceName) {
+        this.interfaceName = interfaceName;
+    }
+
     public boolean isOperational() {
         return adminState == InterfaceAdminState.ENABLED && opState == InterfaceOpState.UP;
     }
@@ -76,48 +70,63 @@ public class InterfaceInfo implements Serializable {
     public InterfaceType getInterfaceType() {
         return interfaceType;
     }
+
     public void setInterfaceType(InterfaceType lportType) {
         this.interfaceType = lportType;
     }
+
     public int getInterfaceTag() {
         return interfaceTag;
     }
+
     public void setInterfaceTag(int interfaceTag) {
         this.interfaceTag = interfaceTag;
     }
+
     public void setUntaggedVlan(boolean isUntaggedVlan) {
         this.isUntaggedVlan = isUntaggedVlan;
     }
+
     public boolean isUntaggedVlan() {
-        return  isUntaggedVlan;
+        return isUntaggedVlan;
     }
+
     public BigInteger getDpId() {
         return dpId;
     }
+
     public void setDpId(BigInteger dpId) {
         this.dpId = dpId;
     }
+
     public InterfaceAdminState getAdminState() {
         return adminState;
     }
+
     public void setAdminState(InterfaceAdminState adminState) {
         this.adminState = adminState;
     }
+
     public InterfaceOpState getOpState() {
         return opState;
     }
+
     public void setOpState(InterfaceOpState opState) {
         this.opState = opState;
     }
+
     public long getGroupId() {
         return groupId;
     }
+
     public void setGroupId(long groupId) {
         this.groupId = groupId;
     }
+
     public long getL2domainGroupId() {
         return l2domainGroupId;
     }
+
     public void setL2domainGroupId(long l2domainGroupId) {
         this.l2domainGroupId = l2domainGroupId;
     }
@@ -133,7 +142,8 @@ public class InterfaceInfo implements Serializable {
     public void setPortName(String portName) {
         this.portName = portName;
     }
-    public String getPortName(){
+
+    public String getPortName() {
         return this.portName;
     }
 
index 3db47a1ab7d85847a83dc0e643142a503009dd19..046b0ae8a4c7d36c8ee099dcb074a6e229e2f2bc 100644 (file)
@@ -8,12 +8,12 @@
 
 package org.opendaylight.genius.interfacemanager.globals;
 
+import com.google.common.base.Optional;
 import java.math.BigInteger;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
-
 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.genius.mdsalutil.FlowInfoKey;
@@ -26,49 +26,52 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeIngress;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceTypeFlowBased;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflow;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflowBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfo;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.ServicesInfoKey;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceTypeFlowBased;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflow;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.StypeOpenflowBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesKey;
-
-import com.google.common.base.Optional;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
 public class InterfaceServiceUtil {
 
     public static ServicesInfo buildServiceInfo(String serviceName, short serviceIndex, int servicePriority,
             BigInteger cookie, List<Instruction> instructions) {
-        List<BoundServices>  boundService = new ArrayList<>();
-        boundService.add(new BoundServicesBuilder().setServicePriority((short)servicePriority).setServiceName(serviceName).build());
-        return new ServicesInfoBuilder().setBoundServices(boundService).setKey(new ServicesInfoKey(serviceName, ServiceModeIngress.class)).build();
-    }
-
-    public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
-                                                 BigInteger cookie, List<Instruction> instructions) {
-        StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority).setInstruction(instructions);
-        return new BoundServicesBuilder().setKey(new BoundServicesKey(servicePriority))
-                .setServiceName(serviceName).setServicePriority(servicePriority)
-                .setServiceType(ServiceTypeFlowBased.class).addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
+        List<BoundServices> boundService = new ArrayList<>();
+        boundService.add(new BoundServicesBuilder().setServicePriority((short) servicePriority)
+                .setServiceName(serviceName).build());
+        return new ServicesInfoBuilder().setBoundServices(boundService)
+                .setKey(new ServicesInfoKey(serviceName, ServiceModeIngress.class)).build();
     }
 
     public static ServicesInfo buildServiceInfo(String serviceName, short serviceIndex, int servicePriority,
             BigInteger cookie) {
-        List<BoundServices>  boundService = new ArrayList<>();
-        boundService.add(new BoundServicesBuilder().setServicePriority((short)servicePriority).setServiceName(serviceName).build());
-        return new ServicesInfoBuilder().setBoundServices(boundService).setKey(new ServicesInfoKey(serviceName, ServiceModeIngress.class)).build();
+        List<BoundServices> boundService = new ArrayList<>();
+        boundService.add(new BoundServicesBuilder().setServicePriority((short) servicePriority)
+                .setServiceName(serviceName).build());
+        return new ServicesInfoBuilder().setBoundServices(boundService)
+                .setKey(new ServicesInfoKey(serviceName, ServiceModeIngress.class)).build();
     }
 
-    public static List<MatchInfo> getMatchInfoForVlanLPort(BigInteger dpId, long portNo, long vlanId, boolean isVlanTransparent) {
+    public static BoundServices getBoundServices(String serviceName, short servicePriority, int flowPriority,
+            BigInteger cookie, List<Instruction> instructions) {
+        StypeOpenflowBuilder augBuilder = new StypeOpenflowBuilder().setFlowCookie(cookie).setFlowPriority(flowPriority)
+                .setInstruction(instructions);
+        return new BoundServicesBuilder().setKey(new BoundServicesKey(servicePriority)).setServiceName(serviceName)
+                .setServicePriority(servicePriority).setServiceType(ServiceTypeFlowBased.class)
+                .addAugmentation(StypeOpenflow.class, augBuilder.build()).build();
+    }
+
+    public static List<MatchInfo> getMatchInfoForVlanLPort(BigInteger dpId, long portNo, long vlanId,
+            boolean isVlanTransparent) {
         List<MatchInfo> matches = new ArrayList<>();
-        matches.add(new MatchInfo(MatchFieldType.in_port, new BigInteger[] {dpId, BigInteger.valueOf(portNo)}));
+        matches.add(new MatchInfo(MatchFieldType.in_port, new BigInteger[] { dpId, BigInteger.valueOf(portNo) }));
         if (vlanId != 0 && !isVlanTransparent) {
             matches.add(new MatchInfo(MatchFieldType.vlan_vid, new long[] { vlanId }));
         }
@@ -80,14 +83,14 @@ public class InterfaceServiceUtil {
                 .child(Interface.class, new InterfaceKey(interfaceName)).build();
         Optional<Interface> ifInstance = MDSALUtil.read(LogicalDatastoreType.CONFIGURATION, id, broker);
         if (ifInstance.isPresent()) {
-            IfL2vlan vlanIface =ifInstance.get().getAugmentation(IfL2vlan.class);
-            short vlanId = vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
-            return vlanId;
+            IfL2vlan vlanIface = ifInstance.get().getAugmentation(IfL2vlan.class);
+            return vlanIface.getVlanId() == null ? 0 : vlanIface.getVlanId().getValue().shortValue();
         }
         return -1;
     }
 
-    public static Set<Object> getStatRequestKeys(BigInteger dpId, short tableId, List<MatchInfo> matches, String flowId, long groupId) {
+    public static Set<Object> getStatRequestKeys(BigInteger dpId, short tableId, List<MatchInfo> matches, String flowId,
+            long groupId) {
         Set<Object> statRequestKeys = new HashSet<>();
         statRequestKeys.add(getFlowStatisticsKey(dpId, tableId, matches, flowId));
         statRequestKeys.add(getGroupStatisticsKey(dpId, groupId));
@@ -98,16 +101,16 @@ public class InterfaceServiceUtil {
         return new GroupInfoKey(dpId, groupId);
     }
 
-    public static FlowInfoKey getFlowStatisticsKey(BigInteger dpId, short tableId, List<MatchInfo> matches, String flowId) {
+    public static FlowInfoKey getFlowStatisticsKey(BigInteger dpId, short tableId, List<MatchInfo> matches,
+            String flowId) {
         return new FlowInfoKey(dpId, tableId, MDSALUtil.buildMatches(matches), flowId);
     }
 
     public static List<MatchInfo> getLPortDispatcherMatches(short serviceIndex, int interfaceTag) {
         List<MatchInfo> mkMatches = new ArrayList<>();
-        mkMatches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
-                 MetaDataUtil.getMetaDataForLPortDispatcher(interfaceTag, serviceIndex),
-                 MetaDataUtil.getMetaDataMaskForLPortDispatcher() }));
+        mkMatches.add(new MatchInfo(MatchFieldType.metadata,
+                new BigInteger[] { MetaDataUtil.getMetaDataForLPortDispatcher(interfaceTag, serviceIndex),
+                        MetaDataUtil.getMetaDataMaskForLPortDispatcher() }));
         return mkMatches;
     }
-
 }
index b0fe53107902ee13a6bd5c17babfe58c39406337..9fed2d2aa86595e9ebe49baca6ac8139027b4d03 100644 (file)
@@ -9,22 +9,16 @@ package org.opendaylight.genius.interfacemanager.globals;
 
 import java.math.BigInteger;
 import java.util.List;
-import java.util.ArrayList;
 
 public class LogicalGroupInterfaceInfo extends InterfaceInfo {
-
-    /*
-         List of vxlan/GRE physical tunnel interfaces makes a logical tunnel interface
-         between a pair of DPNs
-
-     */
-
-    private List<String> parentInterfaceNames;
-
-    public LogicalGroupInterfaceInfo(String portName, BigInteger srcDpId,List<String> pInterfaces) {
-        super(srcDpId,portName);
-
-        parentInterfaceNames = new ArrayList(pInterfaces);
+    private static final long serialVersionUID = 1L;
+    // List of VXLAN/GRE physical tunnel interfaces makes a logical tunnel
+    // interface between a pair of DPNs
+    private final List<String> parentInterfaceNames;
+
+    public LogicalGroupInterfaceInfo(String portName, BigInteger srcDpId, List<String> parentInterfaces) {
+        super(srcDpId, portName);
+        this.parentInterfaceNames = parentInterfaces;
     }
 
     public List<String> getParentInterfaceNames() {
@@ -42,6 +36,4 @@ public class LogicalGroupInterfaceInfo extends InterfaceInfo {
     public void deleteParentInterfaceName(String parentIfname) {
         parentInterfaceNames.remove(parentIfname);
     }
-
 }
-
index a15e4f909d1418a1dd62b9be6fe55b2107a53c40..f8ba2895b26e042d0462e8b2094cf53023705a23 100644 (file)
@@ -11,15 +11,11 @@ import java.math.BigInteger;
 
 public class VlanInterfaceInfo extends InterfaceInfo {
 
-    /**
-     * 
-     */
     private static final long serialVersionUID = 1L;
     private short vlanId;
     private boolean isVlanTransparent;
 
-    public VlanInterfaceInfo(BigInteger dpId,
-            String portName, short vlanId) {
+    public VlanInterfaceInfo(BigInteger dpId, String portName, short vlanId) {
         super(dpId, portName);
         this.vlanId = vlanId;
     }
index 26ffc9a35b425d8e0e9b14bbabb2962efe3e3281..7618cc420d4a11ef92c1d1c8f388361db4c43d1e 100644 (file)
@@ -10,19 +10,21 @@ package org.opendaylight.genius.interfacemanager.interfaces;
 
 import java.math.BigInteger;
 import java.util.List;
-
 import org.opendaylight.genius.interfacemanager.exceptions.InterfaceAlreadyExistsException;
 import org.opendaylight.genius.interfacemanager.globals.InterfaceInfo;
 import org.opendaylight.genius.mdsalutil.ActionInfo;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.ServiceModeBase;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServices;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.IfL2vlan;
 
 public interface IInterfaceManager {
     @Deprecated
     Long getPortForInterface(String ifName);
 
+    @Deprecated
+    Long getPortForInterface(Interface intf);
+
     @Deprecated
     BigInteger getDpnForInterface(String ifName);
 
@@ -35,28 +37,29 @@ public interface IInterfaceManager {
     @Deprecated
     List<ActionInfo> getInterfaceEgressActions(String ifName);
 
-    @Deprecated
-    Long getPortForInterface(Interface intf);
-
     InterfaceInfo getInterfaceInfo(String intInfo);
 
     InterfaceInfo getInterfaceInfoFromOperationalDataStore(String interfaceName,
             InterfaceInfo.InterfaceType interfaceType);
+
     InterfaceInfo getInterfaceInfoFromOperationalDataStore(String interfaceName);
 
     Interface getInterfaceInfoFromConfigDataStore(String interfaceName);
 
-    void createVLANInterface(String interfaceName, String portName, BigInteger dpId, Integer vlanId,
-            String description, IfL2vlan.L2vlanMode l2vlanMode) throws InterfaceAlreadyExistsException;
+    void createVLANInterface(String interfaceName, String portName, BigInteger dpId, Integer vlanId, String description,
+            IfL2vlan.L2vlanMode l2vlanMode) throws InterfaceAlreadyExistsException;
 
-    void createVLANInterface(String interfaceName, String portName, BigInteger dpId, Integer vlanId,
-            String description, IfL2vlan.L2vlanMode l2vlanMode, boolean isExternal) throws InterfaceAlreadyExistsException;
+    void createVLANInterface(String interfaceName, String portName, BigInteger dpId, Integer vlanId, String description,
+            IfL2vlan.L2vlanMode l2vlanMode, boolean isExternal) throws InterfaceAlreadyExistsException;
 
     void bindService(String interfaceName, Class<? extends ServiceModeBase> serviceMode, BoundServices serviceInfo);
+
     void unbindService(String interfaceName, Class<? extends ServiceModeBase> serviceMode, BoundServices serviceInfo);
+
     List<Interface> getVlanInterfaces();
+
     List<Interface> getVxlanInterfaces();
 
     boolean isExternalInterface(String interfaceName);
 
-}
\ No newline at end of file
+}