aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/main
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2018-08-13 14:39:43 -0400
committerPamela Dragosh <pdragosh@research.att.com>2018-08-13 14:39:50 -0400
commit2d381afcd78b61d8791ace22b676e88271b3bdce (patch)
treebfddd966d78d1683ca01124d00b1799389ade500 /utils/src/main
parent269e543ba89dbf553fc66227f7123a302f56b5b4 (diff)
Fix checkstyle in utils
Cleared all the checkstyle in these 2 submodules. Issue-ID: POLICY-881 Change-Id: I248e1894aebf549d5a4f8669a6466ec227d40b55 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'utils/src/main')
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/network/NetworkUtil.java8
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/PropertyConfiguration.java40
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/SpecProperties.java2
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAccessException.java4
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAnnotationException.java4
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyException.java9
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyInvalidException.java4
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyMissingException.java1
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/time/CurrentTime.java7
9 files changed, 55 insertions, 24 deletions
diff --git a/utils/src/main/java/org/onap/policy/common/utils/network/NetworkUtil.java b/utils/src/main/java/org/onap/policy/common/utils/network/NetworkUtil.java
index c9afa19e..ae70ba44 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/network/NetworkUtil.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/network/NetworkUtil.java
@@ -30,14 +30,14 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Network Utilities
+ * Network Utilities.
*/
public class NetworkUtil {
public static final Logger logger = LoggerFactory.getLogger(NetworkUtil.class.getName());
/**
- * IPv4 Wildcard IP address
+ * IPv4 Wildcard IP address.
*/
public static final String IPv4_WILDCARD_ADDRESS = "0.0.0.0";
@@ -73,7 +73,7 @@ public class NetworkUtil {
}
/**
- * gets host name
+ * Gets host name.
*
* @return host name
*/
@@ -95,7 +95,7 @@ public class NetworkUtil {
}
/**
- * gets host's IP
+ * Gets host's IP.
*
* @return host IP
*/
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/PropertyConfiguration.java b/utils/src/main/java/org/onap/policy/common/utils/properties/PropertyConfiguration.java
index e72ebaba..653fe484 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/PropertyConfiguration.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/PropertyConfiguration.java
@@ -41,8 +41,8 @@ import org.onap.policy.common.utils.properties.exception.PropertyMissingExceptio
* subclass. The values of the fields are set via <i>setXxx()</i> methods. As a result, if
* a field is annotated and there is no corresponding <i>setXxx()</i> method, then an
* exception will be thrown.
- * <p>
- * It is possible that an invalid <i>defaultValue</i> is specified via the
+ *
+ * <p>It is possible that an invalid <i>defaultValue</i> is specified via the
* {@link Property} annotation. This could remain undetected until an optional property is
* left out of the {@link Properties}. Consequently, this class will always validate a
* {@link Property}'s default value, if the <i>defaultValue</i> is not empty or if
@@ -120,23 +120,6 @@ public class PropertyConfiguration {
}
/**
- * @param field field whose value is to be set
- * @param prop property of interest
- * @return the method to be used to set the field's value
- * @throws PropertyAccessException if a "set" method cannot be identified
- */
- private Method getSetter(Field field, Property prop) throws PropertyAccessException {
- String nm = "set" + StringUtils.capitalize(field.getName());
-
- try {
- return this.getClass().getMethod(nm, field.getType());
-
- } catch (NoSuchMethodException | SecurityException e) {
- throw new PropertyAccessException(prop.name(), nm, e);
- }
- }
-
- /**
* Sets a field's value from a particular property.
*
* @param setter method to be used to set the field's value
@@ -167,6 +150,25 @@ public class PropertyConfiguration {
}
/**
+ * Get the setter.
+ *
+ * @param field field whose value is to be set
+ * @param prop property of interest
+ * @return the method to be used to set the field's value
+ * @throws PropertyAccessException if a "set" method cannot be identified
+ */
+ private Method getSetter(Field field, Property prop) throws PropertyAccessException {
+ String nm = "set" + StringUtils.capitalize(field.getName());
+
+ try {
+ return this.getClass().getMethod(nm, field.getType());
+
+ } catch (NoSuchMethodException | SecurityException e) {
+ throw new PropertyAccessException(prop.name(), nm, e);
+ }
+ }
+
+ /**
* Gets a property value, coercing it to the field's type.
*
* @param field field whose value is to be set
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/SpecProperties.java b/utils/src/main/java/org/onap/policy/common/utils/properties/SpecProperties.java
index 0f416c3a..17009a83 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/SpecProperties.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/SpecProperties.java
@@ -39,6 +39,7 @@ public class SpecProperties extends Properties {
private final String specPrefix;
/**
+ * Constructor.
*
* @param prefix the property name prefix that appears before any specialization, may
* be ""
@@ -50,6 +51,7 @@ public class SpecProperties extends Properties {
}
/**
+ * Constructor.
*
* @param prefix the property name prefix that appears before any specialization, may
* be ""
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAccessException.java b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAccessException.java
index 568a8a79..b416cd0f 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAccessException.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAccessException.java
@@ -28,6 +28,7 @@ public class PropertyAccessException extends PropertyException {
private static final long serialVersionUID = 1L;
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -37,6 +38,7 @@ public class PropertyAccessException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -47,6 +49,7 @@ public class PropertyAccessException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -57,6 +60,7 @@ public class PropertyAccessException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAnnotationException.java b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAnnotationException.java
index 2803ddfe..f068e158 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAnnotationException.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyAnnotationException.java
@@ -27,6 +27,7 @@ public class PropertyAnnotationException extends PropertyException {
private static final long serialVersionUID = 1L;
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -36,6 +37,7 @@ public class PropertyAnnotationException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -46,6 +48,7 @@ public class PropertyAnnotationException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -56,6 +59,7 @@ public class PropertyAnnotationException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyException.java b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyException.java
index 8df4fb8e..44edd428 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyException.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyException.java
@@ -37,6 +37,7 @@ public class PropertyException extends Exception {
private final String fieldName;
/**
+ * Constructor.
*
* @param propName name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -49,6 +50,7 @@ public class PropertyException extends Exception {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -62,6 +64,7 @@ public class PropertyException extends Exception {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -75,6 +78,7 @@ public class PropertyException extends Exception {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -89,6 +93,7 @@ public class PropertyException extends Exception {
}
/**
+ * Get the property name.
*
* @return name of the property for which the exception was thrown, or {@code null} if
* no name was provided
@@ -98,6 +103,7 @@ public class PropertyException extends Exception {
}
/**
+ * Get the field name.
*
* @return name of the field for which the exception was thrown, or {@code null} if no
* field was provided
@@ -107,6 +113,8 @@ public class PropertyException extends Exception {
}
/**
+ * Make the message.
+ *
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
* @param message error message, never {@code null}
@@ -117,6 +125,7 @@ public class PropertyException extends Exception {
}
/**
+ * Make the message.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyInvalidException.java b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyInvalidException.java
index da1b6ae8..aad44318 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyInvalidException.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyInvalidException.java
@@ -28,6 +28,7 @@ public class PropertyInvalidException extends PropertyException {
private static final long serialVersionUID = 1L;
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -37,6 +38,7 @@ public class PropertyInvalidException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -47,6 +49,7 @@ public class PropertyInvalidException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
@@ -57,6 +60,7 @@ public class PropertyInvalidException extends PropertyException {
}
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
diff --git a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyMissingException.java b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyMissingException.java
index de542e6a..ccbe5f9a 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyMissingException.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/properties/exception/PropertyMissingException.java
@@ -27,6 +27,7 @@ public class PropertyMissingException extends PropertyException {
private static final long serialVersionUID = 1L;
/**
+ * Constructor.
*
* @param propnm name of the property causing the exception, or {@code null}
* @param fieldName name of the field causing the exception, or {@code null}
diff --git a/utils/src/main/java/org/onap/policy/common/utils/time/CurrentTime.java b/utils/src/main/java/org/onap/policy/common/utils/time/CurrentTime.java
index cab469e5..857b69b6 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/time/CurrentTime.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/time/CurrentTime.java
@@ -29,6 +29,7 @@ import java.util.Date;
public class CurrentTime {
/**
+ * Constructor.
*
*/
public CurrentTime() {
@@ -36,6 +37,8 @@ public class CurrentTime {
}
/**
+ * Get the millisecond time.
+ *
* @return the current time, in milliseconds
*/
public long getMillis() {
@@ -43,6 +46,8 @@ public class CurrentTime {
}
/**
+ * Get the current date.
+ *
* @return the current Date
*/
public Date getDate() {
@@ -53,7 +58,7 @@ public class CurrentTime {
* Sleeps for a period of time.
*
* @param sleepMs amount of time to sleep, in milliseconds
- * @throws InterruptedException
+ * @throws InterruptedException can be interrupted
*/
public void sleep(long sleepMs) throws InterruptedException {
Thread.sleep(sleepMs);