Set drools-pdp checkstyle config
Fixed last remaining checkstyle issues along with
setting the pom.xml to the correct path setting.
Fixed forbidden summary fragments, not allowed
to prepend summary with "This method returns"
Issue-ID: POLICY-1153
Change-Id: I267842080494132a7b5507731e14f027a3f6fe44
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
diff --git a/feature-active-standby-management/checkstyle-suppressions.xml b/feature-active-standby-management/checkstyle-suppressions.xml
new file mode 100644
index 0000000..cce8939
--- /dev/null
+++ b/feature-active-standby-management/checkstyle-suppressions.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2018 AT&T Technologies. All rights reserved.
+ ================================================================================
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ SPDX-License-Identifier: Apache-2.0
+ ============LICENSE_END=========================================================
+-->
+
+<!DOCTYPE suppressions PUBLIC
+ "-//Puppy Crawl//DTD Suppressions 1.0//EN"
+ "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
+
+<suppressions>
+ <suppress checks="AbbreviationAsWordInName"
+ files="PMStandbyStateChangeNotifier.java"
+ lines="1-9999"/>
+</suppressions>
diff --git a/feature-active-standby-management/pom.xml b/feature-active-standby-management/pom.xml
index 00beae0..086431c 100644
--- a/feature-active-standby-management/pom.xml
+++ b/feature-active-standby-management/pom.xml
@@ -82,6 +82,42 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>onap-java-style</id>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ <phase>process-sources</phase>
+ <configuration>
+ <!-- Use Google Java Style Guide: https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
+ with minor changes -->
+ <configLocation>onap-checkstyle/onap-java-style.xml</configLocation>
+ <!-- <sourceDirectory> is needed so that checkstyle ignores the generated sources directory -->
+ <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
+ <includeResources>true</includeResources>
+ <includeTestSourceDirectory>true</includeTestSourceDirectory>
+ <includeTestResources>true</includeTestResources>
+ <excludes>
+ </excludes>
+ <suppressionsLocation>${project.baseUri}checkstyle-suppressions.xml</suppressionsLocation>
+ <consoleOutput>true</consoleOutput>
+ <failsOnViolation>true</failsOnViolation>
+ <violationSeverity>warning</violationSeverity>
+ </configuration>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>org.onap.oparent</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>${oparent.version}</version>
+ <scope>compile</scope>
+ </dependency>
+ </dependencies>
+ </plugin>
</plugins>
</build>
diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java
index 9e481f0..1b7d91b 100644
--- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java
+++ b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java
@@ -62,12 +62,12 @@
public static final int SEQ_NUM = 1;
- /**************************/
+ /*========================*/
/* 'FeatureAPI' interface */
- /**************************/
+ /*========================*/
/**
- * {@inheritDoc}
+ * {@inheritDoc}.
*/
@Override
public int getSequenceNumber() {
@@ -75,7 +75,7 @@
}
/**
- * {@inheritDoc}
+ * {@inheritDoc}.
*/
@Override
public void globalInit(String[] args, String configDir) {
@@ -121,7 +121,7 @@
/**
- * {@inheritDoc}
+ * {@inheritDoc}.
*/
@Override
public boolean afterStart(PolicyEngine engine) {
@@ -210,7 +210,7 @@
}
/**
- * {@inheritDoc}
+ * {@inheritDoc}.
*/
@Override
public String getPdpdNowActive() {
@@ -218,7 +218,7 @@
}
/**
- * {@inheritDoc}
+ * {@inheritDoc}.
*/
@Override
public String getPdpdLastActive() {
@@ -226,7 +226,7 @@
}
/**
- * {@inheritDoc}
+ * {@inheritDoc}.
*/
@Override
public String getResourceName() {
diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java
index f0fd278..12d716a 100644
--- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java
+++ b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java
@@ -39,7 +39,7 @@
@NamedQueries({
@NamedQuery(name = "DroolsPdpEntity.findAll", query = "SELECT e FROM DroolsPdpEntity e "),
@NamedQuery(name = "DroolsPdpEntity.deleteAll", query = "DELETE FROM DroolsPdpEntity WHERE 1=1")
-})
+ })
public class DroolsPdpEntity extends DroolsPdpObject implements Serializable {
private static final long serialVersionUID = 1L;
diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java
index 08592f2..fddf024 100644
--- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java
+++ b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java
@@ -637,7 +637,7 @@
* Sanitize designated list.
*
* @param listOfDesignated list of designated pdps
- * @return
+ * @return list of drools pdps
*/
public List<DroolsPdp> santizeDesignatedList(List<DroolsPdp> listOfDesignated) {
@@ -668,7 +668,7 @@
*
* @param pdps collection of pdps
* @param listOfDesignated list of designated pdps
- * @return
+ * @return drools pdp object
*/
public DroolsPdp computeMostRecentPrimary(Collection<DroolsPdp> pdps, List<DroolsPdp> listOfDesignated) {
boolean containsDesignated = false;
@@ -778,7 +778,7 @@
*
* @param listOfDesignated list of designated pdps
* @param mostRecentPrimary most recent primary pdpd
- * @return
+ * @return drools pdp object
*/
public DroolsPdp computeDesignatedPdp(List<DroolsPdp> listOfDesignated, DroolsPdp mostRecentPrimary) {
DroolsPdp designatedPdp = null;
diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PMStandbyStateChangeNotifier.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PMStandbyStateChangeNotifier.java
index 554376c..53f825d 100644
--- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PMStandbyStateChangeNotifier.java
+++ b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PMStandbyStateChangeNotifier.java
@@ -122,7 +122,7 @@
String pdpId = ActiveStandbyProperties.getProperty(ActiveStandbyProperties.NODE_NAME);
if (logger.isDebugEnabled()) {
- logger.debug("handleStateChange: previousStandbyStatus = {}" + "; standbyStatus = {}",
+ logger.debug("handleStateChange: previousStandbyStatus = {}; standbyStatus = {}",
previousStandbyStatus, standbyStatus);
}
@@ -201,7 +201,7 @@
} else if (standbyStatus.equals(StateManagement.PROVIDING_SERVICE)) {
if (logger.isDebugEnabled()) {
- logger.debug("handleStateChange: standbyStatus= {} " + "scheduling activation of PDP={}", standbyStatus,
+ logger.debug("handleStateChange: standbyStatus= {} scheduling activation of PDP={}", standbyStatus,
pdpId);
}
if (previousStandbyStatus.equals(StateManagement.PROVIDING_SERVICE)) {