Fixing checkstyle and javadoc errors 17/13517/3
authorBharat saraswal <bharat.saraswal@huawei.com>
Tue, 19 Sep 2017 16:01:18 +0000 (21:31 +0530)
committerBharat saraswal <bharat.saraswal@huawei.com>
Fri, 22 Sep 2017 04:14:50 +0000 (04:14 +0000)
(followed:onap-java-style) removed redundant code. merged all changes in one commit for one repo.

Issue-Id:DCAEGEN2-92

Change-Id: I072e02dbedd93c01fcf3a297170cb2f7286b3b72
Signed-off-by: Bharat saraswal <bharat.saraswal@huawei.com>
27 files changed:
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/BaseDynamicPropertiesProvider.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/DynamicPropertiesProvider.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/AlertAction.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/AlertType.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/BaseCEFModel.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/CEFModel.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/Criticality.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/Event.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/EventListener.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/EventSeverity.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/PerformanceCounter.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/Priority.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/ThresholdCrossingAlertFields.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/util/AnalyticsModelIOUtils.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/util/json/mixin/cef/BaseCEFModelMixin.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/util/json/mixin/cef/EventListenerMixin.java
dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/util/json/mixin/cef/EventMixin.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/BaseAnalyticsModelUnitTest.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/facade/tca/AAITest.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/facade/tca/TCAVESResponseTest.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/util/AnalyticsModelIOUtilsTest.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/util/TestAppConfig.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/util/json/mixin/facade/tca/TCAVESResponseMixinTest.java
dcae-analytics-model/src/test/java/org/openecomp/dcae/apod/analytics/model/util/json/mixin/policy/tca/TCAPolicyMixinTest.java
dcae-analytics-test/src/main/java/org/openecomp/dcae/apod/analytics/test/BaseDCAEAnalyticsCommonTest.java
dcae-analytics-test/src/main/java/org/openecomp/dcae/apod/analytics/test/BaseDCAEAnalyticsUnitTest.java
dcae-analytics-test/src/main/java/org/openecomp/dcae/apod/analytics/test/runner/GuiceJUnitRunner.java

index 4190587..80e1665 100644 (file)
@@ -62,8 +62,6 @@ public abstract class BaseDynamicPropertiesProvider implements DynamicProperties
      * @return return true if Dynamic Properties are present
      */
     public boolean isDynamicPropertiesPresent() {
-        return dynamicProperties.size() == 0;
+        return dynamicProperties.isEmpty();
     }
-
-
 }
index 9fc8046..aa17043 100644 (file)
@@ -32,7 +32,7 @@ public enum AlertType implements CEFModel {
     SERVICE_ANOMALY("SERVICE-ANOMALY"),
     UNKNOWN(null);
 
-    private String name;
+    private final String name;
 
     AlertType(String name) {
         this.name = name;
@@ -41,5 +41,4 @@ public enum AlertType implements CEFModel {
     public String getName() {
         return name;
     }
-
 }
index 5438297..519e961 100644 (file)
@@ -36,6 +36,4 @@ import org.openecomp.dcae.apod.analytics.model.domain.BaseDynamicPropertiesProvi
 @Data
 @EqualsAndHashCode(callSuper = true)
 public abstract class BaseCEFModel extends BaseDynamicPropertiesProvider implements CEFModel {
-
-
 }
index bb8a13a..d727a0e 100644 (file)
@@ -44,7 +44,7 @@ public class Event extends BaseCEFModel {
     private CommonEventHeader commonEventHeader;
 
     /**
-     * MeasurementsForVfScaling fields
+     * Measurements for Vf scaling fields
      *
      * @param measurementsForVfScalingFields New value for MeasurementsForVfScaling
      * @return MeasurementsForVfScaling fields
@@ -52,12 +52,10 @@ public class Event extends BaseCEFModel {
     private MeasurementsForVfScalingFields measurementsForVfScalingFields;
 
     /**
-     * Threshold crossing Fields
+     * Threshold crossing alert Fields.
      *
      * @param thresholdCrossingAlertFields New value for Threshold crossing Fields
      * @return Threshold crossing Fields
      */
     private ThresholdCrossingAlertFields thresholdCrossingAlertFields;
-
-
 }
index 0854790..aa543f7 100644 (file)
@@ -34,13 +34,12 @@ public class EventListener extends BaseCEFModel {
 
 
     private static final long serialVersionUID = 1L;
-    /**
+
+  /**
      * Common Event Format - Event
      *
      * @param event New value for Event
      * @return Common Event Format Event
      */
     private Event event;
-
-
 }
index e8dbee9..46b4c4f 100644 (file)
@@ -33,13 +33,15 @@ import lombok.EqualsAndHashCode;
 public class PerformanceCounter extends BaseCEFModel {
 
     private static final long serialVersionUID = 1L;
+
     /**
-     * Performance Counter Criticality
+     * Performance Counter Criticality.
      *
      * @param criticality New value for Criticality
      * @return Performance Counter Criticality
      */
     private Criticality criticality;
+
     /**
      * Performance Counter Name
      *
@@ -47,19 +49,20 @@ public class PerformanceCounter extends BaseCEFModel {
      * @return Performance Counter Name
      */
     private String name;
-    /**
-     * Performance Counter Threshold Crossed
+
+   /**
+     * Performance Counter for Threshold Crossed.
      *
      * @param thresholdCrossed New value for Performance Counter Threshold Crossed
      * @return Performance Counter Threshold Crossed
      */
     private String thresholdCrossed;
+
     /**
-     * Performance Counter Value
+     * Performance Counter Value.
      *
      * @param value New Performance Counter Value
      * @return Performance Counter Value
      */
     private String value;
-
 }
index f2c6674..0206899 100644 (file)
@@ -27,6 +27,8 @@ package org.openecomp.dcae.apod.analytics.model.domain.cef;
  */
 public enum Priority implements CEFModel {
 
-    High, Medium, Normal, Low;
-
+    High,
+    Medium,
+    Normal,
+    Low
 }
index 55dd696..5fbe3e3 100644 (file)
 
 package org.openecomp.dcae.apod.analytics.model.domain.cef;
 
+import java.util.List;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
-import java.util.List;
-
 /**
  * Common Event Format - Fields Specific to threshold crossing alert events
  *
@@ -37,7 +36,7 @@ public class ThresholdCrossingAlertFields extends BaseCEFModel {
     private static final long serialVersionUID = 1L;
 
     /**
-     * Additional Performance counters
+     * Additional Performance counters parameters.
      *
      * @param additionalParameters New value for Additional Performance counters
      * @return Additional Performance counters
@@ -45,10 +44,10 @@ public class ThresholdCrossingAlertFields extends BaseCEFModel {
     private List<PerformanceCounter> additionalParameters;
 
     /**
-     *  Event Action
+     *  Event alert action
      *
      *  @param alertAction New Event Action
-     *  @return Event Action
+     *  @return Event alert action
      */
     private AlertAction alertAction;
 
@@ -156,6 +155,4 @@ public class ThresholdCrossingAlertFields extends BaseCEFModel {
      * @return Version of the thresholdCrossingAlertFields block
      */
     private Integer thresholdCrossingFieldsVersion;
-
-
 }
index d6d5dc2..df1d46d 100644 (file)
@@ -22,15 +22,14 @@ package org.openecomp.dcae.apod.analytics.model.util;
 
 import com.fasterxml.jackson.core.JsonParseException;
 import com.fasterxml.jackson.databind.JsonMappingException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.nio.charset.Charset;
 import java.util.Properties;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Utility class containing methods for IO related operations
@@ -50,8 +49,9 @@ public abstract class AnalyticsModelIOUtils extends AnalyticsModelJsonUtils {
      * @param <T>  binding Class Type
      *
      * @return binding Class Object which properties populated from JSON File Location
+     * @throws IOException when fails to do IO operations
      */
-    public static final <T> T convertToJsonObject(String fileLocation, Class<T> bindingClass) {
+    public static final <T> T convertToJsonObject(String fileLocation, Class<T> bindingClass) throws IOException {
 
         // Load Resource from give path
         final InputStream resourceAsStream = loadResourceAsStream(fileLocation);
@@ -59,14 +59,13 @@ public abstract class AnalyticsModelIOUtils extends AnalyticsModelJsonUtils {
         // If resource is null throw an exception
         if (resourceAsStream == null) {
             final String errorMessage = String.format("Invalid File location: %s", fileLocation);
-            throw new RuntimeException(errorMessage, new FileNotFoundException(errorMessage));
+            throw new IOException(errorMessage, new FileNotFoundException(errorMessage));
         }
 
         // Parse input stream
         try (InputStreamReader inputStreamReader = new InputStreamReader(resourceAsStream, Charset.forName("UTF-8"))) {
 
             return ANALYTICS_MODEL_OBJECT_MAPPER.readValue(inputStreamReader, bindingClass);
-
         } catch (JsonMappingException | JsonParseException e) {
 
             // If parsing fails due to Invalid Json or Json IO Issues throw an exception
@@ -74,17 +73,14 @@ public abstract class AnalyticsModelIOUtils extends AnalyticsModelJsonUtils {
                     fileLocation);
 
             LOG.error(errorMessage);
-            throw new RuntimeException(errorMessage, e);
-
+            throw new IOException(errorMessage, e);
         } catch (IOException e) {
 
             // If parsing fails due to IO Issues throw an exception
             final String errorMessage = String.format("IO Error while parsing Json File location: %s", fileLocation);
             LOG.error(errorMessage);
-            throw new RuntimeException(errorMessage, e);
-
+            throw new IOException(errorMessage, e);
         }
-
     }
 
     /**
@@ -105,7 +101,8 @@ public abstract class AnalyticsModelIOUtils extends AnalyticsModelJsonUtils {
         // If properties file is not present throw an exception
         if (propertiesFileInputStream == null) {
             final String errorMessage = String.format("Invalid Properties File at location: %s",
-                    propertiesFileLocation);
+                propertiesFileLocation);
+            //TODO: discuss and change this excpeiton as well.
             throw new RuntimeException(errorMessage, new FileNotFoundException(errorMessage));
         }
 
@@ -132,6 +129,4 @@ public abstract class AnalyticsModelIOUtils extends AnalyticsModelJsonUtils {
         // Load Resource from give path
         return Thread.currentThread().getContextClassLoader().getResourceAsStream(fileLocation);
     }
-
-
 }
index df69c8c..f0cfd1b 100644 (file)
@@ -43,6 +43,9 @@ public abstract class BaseAnalyticsModelUnitTest extends BaseDCAEAnalyticsUnitTe
 
     protected static ObjectMapper objectMapper;
 
+    /**
+     * Before running test cases need to assign object mapper.
+     */
     @BeforeClass
     public static void beforeClass() {
         final AnalyticsModelObjectMapperSupplier analyticsModelObjectMapperSupplier =
@@ -52,7 +55,7 @@ public abstract class BaseAnalyticsModelUnitTest extends BaseDCAEAnalyticsUnitTe
 
 
     /**
-     * Deserialize given Json file location to given model class and returns it back without any validation check
+     * Deserialize given Json file location to given model class and returns it back without any validation check.
      *
      * @param jsonFileLocation Classpath location of the json file
      * @param modelClass       Model Class type
@@ -81,7 +84,7 @@ public abstract class BaseAnalyticsModelUnitTest extends BaseDCAEAnalyticsUnitTe
 
     /**
      * Deserialize given Json file location to given model class and then validates deserialization by comparing it
-     * with given expected Object
+     * with given expected Object.
      *
      * @param jsonFileLocation   Classpath location of the json file
      * @param modelClass         Model Class type
@@ -95,12 +98,18 @@ public abstract class BaseAnalyticsModelUnitTest extends BaseDCAEAnalyticsUnitTe
         return actualValue;
     }
 
+    /**
+     * Serialize model to json.
+     * @param model model
+     * @return json
+     * @throws JsonProcessingException when fails to process object
+     */
     public static String serializeModelToJson(Object model) throws JsonProcessingException {
         return objectMapper.writeValueAsString(model);
     }
 
     /**
-     * Converts given model to json string and compare it with json present at given file location
+     * Converts given model to json string and compare it with json present at given file location.
      *
      * @param model                    Model which needs to be compared
      * @param expectedJsonFileLocation Location of file containing expected json string
@@ -114,17 +123,16 @@ public abstract class BaseAnalyticsModelUnitTest extends BaseDCAEAnalyticsUnitTe
             assertJson(expectedModelString, actualModelString);
             return model;
         } catch (IOException | JSONException ex) {
-            LOG.error("Error while doing assert Json serialization Assertion: model: {}, " +
-                    "expected Json File Location: {}, Exception {}", model, expectedJsonFileLocation, ex);
+            LOG.error("Error while doing assert Json serialization Assertion: model: {}, "
+                + "expected Json File Location: {}, Exception {}", model, expectedJsonFileLocation, ex);
             throw new RuntimeException(ex);
         }
-
     }
 
 
     /**
      * Checks both serialization and deserialization.
-     *
+     * </p>
      * First checks deserialization and then serialize the deserialized object back to json
      * and check if matches the given json file location string
      *
@@ -143,6 +151,4 @@ public abstract class BaseAnalyticsModelUnitTest extends BaseDCAEAnalyticsUnitTe
 
         return actualValue;
     }
-
-
 }
index d5c5186..3aa6460 100644 (file)
@@ -33,27 +33,25 @@ import static org.junit.Assert.assertThat;
 public class AAITest extends BaseAnalyticsModelUnitTest {
 
     private AAI aai;
+    private static final String GENERIC_VNF_ID = "testVNFID";
+    private static final String CHANGED_GENERIC_VNF_ID = "changedVNFID";
 
     @Before
     public void before() {
-        this.aai = new AAI();
+        aai = new AAI();
     }
 
     @Test
     public void getGenericVNFId() throws Exception {
-        final String genericVNFId = "testVNFID";
-        aai.setGenericVNFId(genericVNFId);
-        assertThat("VNFID must be same", aai.getGenericVNFId(), is(genericVNFId));
+        aai.setGenericVNFId(GENERIC_VNF_ID);
+        assertThat("VNFID must be same", aai.getGenericVNFId(), is(GENERIC_VNF_ID));
     }
 
     @Test
     public void setGenericVNFId() throws Exception {
         final String genericVNFId = "testVNFID";
-        aai.setGenericVNFId(genericVNFId);
-        final String changedGenericVNFId = "changedVNFID";
-        aai.setGenericVNFId(changedGenericVNFId);
-        assertThat("VNFID must be same as changed VNFID", aai.getGenericVNFId(), is(changedGenericVNFId));
-
+        aai.setGenericVNFId(GENERIC_VNF_ID);
+        aai.setGenericVNFId(CHANGED_GENERIC_VNF_ID);
+        assertThat("VNFID must be same as changed VNFID", aai.getGenericVNFId(), is(CHANGED_GENERIC_VNF_ID));
     }
-
 }
index 9696823..38dde65 100644 (file)
@@ -31,14 +31,13 @@ import static org.junit.Assert.assertThat;
  */
 public class TCAVESResponseTest extends BaseAnalyticsModelUnitTest {
 
-    final String tcaVESCEFResponseJsonFileLocation = "data/json/facade/tca_ves_cef_response.json";
-
+    private static final String TCA_VES_CEF_RESPONSE_JSON_FILE_LOCATION = "data/json/facade/tca_ves_cef_response.json";
 
     @Test
     public void testTCAPolicyJsonConversions() throws Exception {
 
         final TCAVESResponse vesCEFMessageResponse =
-                assertJsonConversions(tcaVESCEFResponseJsonFileLocation, TCAVESResponse.class);
+            assertJsonConversions(TCA_VES_CEF_RESPONSE_JSON_FILE_LOCATION, TCAVESResponse.class);
 
         assertThat("VES CEF Message Response AAI generics VNF Id must match",
                 vesCEFMessageResponse.getAai().getGenericVNFId(), is("vpp-test(?)"));
@@ -74,5 +73,4 @@ public class TCAVESResponseTest extends BaseAnalyticsModelUnitTest {
                 vesCEFMessageResponse.getClosedLoopEventStatus(), is("ONSET"));
 
     }
-
 }
index ac8d823..bbfb7f5 100644 (file)
@@ -54,17 +54,16 @@ public class AnalyticsModelIOUtilsTest extends BaseAnalyticsModelUnitTest {
         assertEquals("App Description much with json settings file value", "Test App Description", appDescription);
     }
 
-    @Test(expected = RuntimeException.class)
+    @Test(expected = IOException.class)
     public void testConvertToJsonObjectWhenFileLocationIsInvValid() throws Exception {
         AnalyticsModelIOUtils.convertToJsonObject("InvalidFileLocation", ConfigHolder.class);
     }
 
-    @Test(expected = RuntimeException.class)
+    @Test(expected = IOException.class)
     public void testConvertToJsonObjectWhenJsonFileHasInvalidJson() throws Exception {
         AnalyticsModelIOUtils.convertToJsonObject(INVALID_TEST_CONFIG_FILE_LOCATION, ConfigHolder.class);
     }
 
-
     @Test
     public void testValidPropertiesFileLoading() throws Exception {
         final Properties properties =
@@ -82,8 +81,6 @@ public class AnalyticsModelIOUtilsTest extends BaseAnalyticsModelUnitTest {
         final Properties mockProperties = Mockito.mock(Properties.class);
         doThrow(new IOException()).when(mockProperties).load(any(InputStream.class));
         AnalyticsModelIOUtils.loadPropertiesFile(TEST_PROPERTIES_FILE_LOCATION, mockProperties);
-
     }
-    
 }
 
index 3285ded..1233d09 100644 (file)
@@ -33,13 +33,13 @@ import static org.junit.Assert.assertThat;
  */
 public class TCAVESResponseMixinTest extends BaseAnalyticsModelUnitTest {
 
-    final String tcaVESCEFResponseJsonFileLocation = "data/json/facade/tca_ves_cef_response.json";
+    private static final String TCA_VES_CEF_RESPONSE_JSON_FILE_LOCATION = "data/json/facade/tca_ves_cef_response.json";
 
     @Test
     public void testTCAPolicyJsonConversions() throws Exception {
 
         final TCAVESResponse vesCEFMessageResponse =
-                assertJsonConversions(tcaVESCEFResponseJsonFileLocation, TCAVESResponse.class);
+            assertJsonConversions(TCA_VES_CEF_RESPONSE_JSON_FILE_LOCATION, TCAVESResponse.class);
 
         assertThat("VES CEF Message Response AAI generics VNF Id must match",
                 vesCEFMessageResponse.getAai().getGenericVNFId(), is("vpp-test(?)"));
@@ -51,7 +51,5 @@ public class TCAVESResponseMixinTest extends BaseAnalyticsModelUnitTest {
                 vesCEFMessageResponse.getTargetType(), is("VNF"));
 
         testSerialization(vesCEFMessageResponse, getClass());
-
     }
-
 }
index a42f816..4084f11 100644 (file)
@@ -33,12 +33,12 @@ import static org.junit.Assert.assertThat;
  */
 public class TCAPolicyMixinTest extends BaseAnalyticsModelUnitTest {
 
-    final String tcaPolicyJsonFileLocation = "data/json/policy/tca_policy.json";
+    private static final String TCA_POLICY_JSON_FILE_LOCATION = "data/json/policy/tca_policy.json";
 
     @Test
     public void testTCAPolicyJsonConversions() throws Exception {
 
-        final TCAPolicy tcaPolicy = assertJsonConversions(tcaPolicyJsonFileLocation, TCAPolicy.class);
+        final TCAPolicy tcaPolicy = assertJsonConversions(TCA_POLICY_JSON_FILE_LOCATION, TCAPolicy.class);
 
         assertThat("TCA Policy Metrics Per Event Name must be 2",
                 tcaPolicy.getMetricsPerEventName().size(), is(2));
@@ -47,10 +47,5 @@ public class TCAPolicyMixinTest extends BaseAnalyticsModelUnitTest {
                 tcaPolicy.getMetricsPerEventName().get(0).getThresholds().size(), is(3));
 
         testSerialization(tcaPolicy, getClass());
-
     }
-
-
-
-
 }
index c1d939e..4698f21 100644 (file)
@@ -86,8 +86,8 @@ abstract class BaseDCAEAnalyticsCommonTest {
             final String newLine = System.getProperty("line.separator");
             String line = reader.readLine();
             while (line != null) {
-                result.append(line);
-                result.append(newLine);
+                result.append(line)
+                    .append(newLine);
                 line = reader.readLine();
             }
             jsonFileInputStream.close();
index 6c6071e..6353442 100644 (file)
@@ -40,7 +40,7 @@ public class GuiceJUnitRunner extends BlockJUnit4ClassRunner {
 
     private static final Logger LOG = LoggerFactory.getLogger(GuiceJUnitRunner.class);
 
-    private Injector injector;
+    private final Injector injector;
 
     public GuiceJUnitRunner(Class<?> klass) throws InitializationError {
         super(klass);
@@ -71,7 +71,7 @@ public class GuiceJUnitRunner extends BlockJUnit4ClassRunner {
         Module[] modules = new Module[classes.length];
         for (int i = 0; i < classes.length; i++) {
             try {
-                modules[i] = (Module) (classes[i]).newInstance();
+                modules[i] = (Module) classes[i].newInstance();
             } catch (InstantiationException | IllegalAccessException e) {
                 throw new InitializationError(e);
             }