From d100854291559df1426ea1e64351872ae2d3867b Mon Sep 17 00:00:00 2001 From: liamfallon Date: Mon, 10 Sep 2018 17:05:36 +0100 Subject: Checkstyle changes for apex model Fix checkstyle warnings in the apex mode and knock on changes. Issue-ID: POLICY-1034 Change-Id: I10537e4288e9cad5ef18165ed2cdc1d3ab3139c1 Signed-off-by: liamfallon --- .../policy/apex/model/utilities/Assertions.java | 50 +-- .../apex/model/utilities/CollectionUtils.java | 12 +- .../utilities/DirectoryDeleteShutdownHook.java | 56 ++++ .../apex/model/utilities/DirectoryUtils.java | 46 +-- .../model/utilities/comparison/KeyComparer.java | 4 +- .../model/utilities/comparison/KeyDifference.java | 6 +- .../utilities/comparison/KeyedMapComparer.java | 10 +- .../utilities/comparison/KeyedMapDifference.java | 344 +++++++++++---------- .../apex/model/utilities/json/JSONHandler.java | 53 ---- .../apex/model/utilities/json/JsonHandler.java | 53 ++++ .../model/utilities/typeutils/ClassBuilder.java | 23 +- .../model/utilities/typeutils/TypeBuilder.java | 22 +- 12 files changed, 356 insertions(+), 323 deletions(-) create mode 100644 model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryDeleteShutdownHook.java delete mode 100644 model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JSONHandler.java create mode 100644 model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JsonHandler.java (limited to 'model/utilities/src/main') diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/Assertions.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/Assertions.java index 80a71f8aa..a3ecccebe 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/Assertions.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/Assertions.java @@ -41,18 +41,18 @@ public final class Assertions { * @param pattern The regular expression * @return null if the parameter is valid, the validation message otherwise */ - public static String getStringParameterValidationMessage(final String parameterName, final String parameterValue, final String pattern) { + public static String getStringParameterValidationMessage(final String parameterName, final String parameterValue, + final String pattern) { try { validateStringParameter(parameterName, parameterValue, pattern); - } - catch (IllegalArgumentException e) { + } catch (IllegalArgumentException e) { // This will cause a SONAR error but eliminates all SONAR messages in callers return e.getMessage(); } - + return null; } - + /** * Checks if a string parameter matches a regular expression. * @@ -61,7 +61,8 @@ public final class Assertions { * @param pattern The regular expression * @return the trimmed string */ - public static String validateStringParameter(final String parameterName, final String parameterValue, final String pattern) { + public static String validateStringParameter(final String parameterName, final String parameterValue, + final String pattern) { argumentNotNull(parameterName, "parameter name is null"); argumentNotNull(parameterValue, "parameter \"" + parameterName + "\" is null"); argumentNotNull(pattern, "parameter pattern is null"); @@ -69,10 +70,9 @@ public final class Assertions { final String trimmedValue = parameterValue.trim(); if (trimmedValue.matches(pattern)) { return trimmedValue; - } - else { - throw new IllegalArgumentException( - "parameter \"" + parameterName + "\": value \"" + parameterValue + "\", does not match regular expression \"" + pattern + "\""); + } else { + throw new IllegalArgumentException("parameter \"" + parameterName + "\": value \"" + parameterValue + + "\", does not match regular expression \"" + pattern + "\""); } } @@ -102,7 +102,8 @@ public final class Assertions { } /** - * Used as a shorthand to check that method arguments are not null, throws an exception of the specified type on error. + * Used as a shorthand to check that method arguments are not null, throws an exception of the specified type on + * error. * * @param the generic type of the argument to check * @param the exception to throw if incoming value is null @@ -111,20 +112,21 @@ public final class Assertions { * @param message the error message to issue * @throws E an instance of the passed Exception Class */ - public static void argumentNotNull(final T value, final Class exceptionClass, final String message) throws E { + public static void argumentOfClassNotNull(final T value, final Class exceptionClass, + final String message) throws E { if (value == null) { // Instantiate the exception and throw it try { throw exceptionClass.getConstructor(String.class).newInstance(message); - } - catch (final Exception errorException) { + } catch (final Exception errorException) { throw new IllegalArgumentException(message, errorException); } } } /** - * Used as a shorthand to check that method argument is not false, throws an exception of the specified type on error. + * Used as a shorthand to check that method argument is not false, throws an exception of the specified type on + * error. * * @param the exception to throw if incoming value is false * @param value the value to check if false @@ -132,20 +134,21 @@ public final class Assertions { * @param message the error message to issue * @throws E an instance of the passed Exception Class */ - public static void argumentNotFalse(final boolean value, final Class exceptionClass, final String message) throws E { + public static void argumentOfClassNotFalse(final boolean value, final Class exceptionClass, + final String message) throws E { if (!value) { // Instantiate the exception and throw it try { throw exceptionClass.getConstructor(String.class).newInstance(message); - } - catch (final Exception errorException) { + } catch (final Exception errorException) { throw new IllegalArgumentException(message, errorException); } } } /** - * Used as a shorthand to check that an object is an instance of a given class, throws IllegalArgumentException on error. + * Used as a shorthand to check that an object is an instance of a given class, throws IllegalArgumentException on + * error. * * @param the generic type of the argument to check * @param objectInstance the object instance for which to check the class @@ -154,12 +157,14 @@ public final class Assertions { */ public static void instanceOf(final Object objectInstance, final Class requiredClass) { if (!requiredClass.isAssignableFrom(objectInstance.getClass())) { - throw new IllegalArgumentException(objectInstance.getClass().getCanonicalName() + " is not an instance of " + requiredClass.getCanonicalName()); + throw new IllegalArgumentException(objectInstance.getClass().getCanonicalName() + " is not an instance of " + + requiredClass.getCanonicalName()); } } /** - * Used as a shorthand to check that an instance of a class can be an instance of a given class, throws IllegalArgumentException on error. + * Used as a shorthand to check that an instance of a class can be an instance of a given class, throws + * IllegalArgumentException on error. * * @param the generic type of the argument to check * @param checkClass the class to check @@ -168,7 +173,8 @@ public final class Assertions { */ public static void assignableFrom(final Class checkClass, final Class requiredClass) { if (!requiredClass.isAssignableFrom(checkClass)) { - throw new IllegalArgumentException(checkClass.getCanonicalName() + " is not an instance of " + requiredClass.getCanonicalName()); + throw new IllegalArgumentException(checkClass.getCanonicalName() + " is not an instance of " + + requiredClass.getCanonicalName()); } } } diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/CollectionUtils.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/CollectionUtils.java index 7ca50a613..0d90d8ceb 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/CollectionUtils.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/CollectionUtils.java @@ -43,7 +43,8 @@ public abstract class CollectionUtils { * @param rightList The rightmost list * @return an integer indicating how different the lists are */ - public static int compareLists(final List> leftList, final List> rightList) { + public static int compareLists(final List> leftList, + final List> rightList) { // Check for nulls if (leftList == null && rightList == null) { return 0; @@ -59,7 +60,7 @@ public abstract class CollectionUtils { if (leftList.equals(rightList)) { return 0; } - + return compareListEntries(leftList, rightList); } @@ -71,8 +72,9 @@ public abstract class CollectionUtils { * @param rightList The rightmost list * @return an integer indicating how different the lists are */ - private static int compareListEntries(final List> leftList, final List> rightList) { - + private static int compareListEntries(final List> leftList, + final List> rightList) { + // Iterate down the lists till we find a difference final ListIterator leftIterator = leftList.listIterator(); final ListIterator rightIterator = rightList.listIterator(); @@ -104,5 +106,5 @@ public abstract class CollectionUtils { return comparisonResult; } } - } + } } diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryDeleteShutdownHook.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryDeleteShutdownHook.java new file mode 100644 index 000000000..5f9b8aaf8 --- /dev/null +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryDeleteShutdownHook.java @@ -0,0 +1,56 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2018 Ericsson. 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========================================================= + */ + +package org.onap.policy.apex.model.utilities; + +import java.io.File; + +/** + * The Class DirectoryShutdownHook removes the contents of a directory and the directory itself at shutdown. + * + * @author Liam Fallon (liam.fallon@ericsson.com) + */ +final class DirectoryDeleteShutdownHook extends Thread { + // The directory we are acting on + private final File tempDir; + + /** + * Constructor that defines the directory to act on at shutdown. + * + * @param tempDir The temporary directory to delete + */ + DirectoryDeleteShutdownHook(final File tempDir) { + this.tempDir = tempDir; + } + + /* + * (non-Javadoc) + * + * @see java.lang.Runnable#run() + */ + @Override + public void run() { + if (tempDir.exists()) { + // Empty and delete the directory + DirectoryUtils.emptyDirectory(tempDir); + tempDir.delete(); + } + } +} diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryUtils.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryUtils.java index 00e5cb4cf..7cd5228cc 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryUtils.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/DirectoryUtils.java @@ -26,8 +26,8 @@ import org.slf4j.ext.XLogger; import org.slf4j.ext.XLoggerFactory; /** - * This is common utility class with static methods for handling directories. It is an abstract class to prevent any direct instantiation and private - * constructor to prevent extending this class. + * This is common utility class with static methods for handling directories. It is an abstract class to prevent any + * direct instantiation and private constructor to prevent extending this class. * * @author Liam Fallon (liam.fallon@ericsson.com) */ @@ -42,9 +42,11 @@ public abstract class DirectoryUtils { } /** - * Method to get an empty temporary directory in the system temporary directory on the local machine that will be deleted on (normal) shutdown. + * Method to get an empty temporary directory in the system temporary directory on the local machine that will be + * deleted on (normal) shutdown. * - * @param nameprefix The prefix of the filename. System.nanoTime() will be appended to the pattern to create a unique file pattern + * @param nameprefix The prefix of the filename. System.nanoTime() will be appended to the pattern to create a + * unique file pattern * @return The temporary directory */ public static File getLocalTempDirectory(final String nameprefix) { @@ -66,8 +68,7 @@ public abstract class DirectoryUtils { LOGGER.trace("creating temp directory\"{}\" : ", tempDir.getAbsolutePath()); return tempDir; - } - catch (final Exception e) { + } catch (final Exception e) { LOGGER.debug("error creating temp directory\"{}\" : " + e.getMessage(), e); return null; } @@ -103,36 +104,3 @@ public abstract class DirectoryUtils { return true; } } - -/** - * The Class DirectoryShutdownHook removes the contents of a directory and the directory itself at shutdown. - * - * @author Liam Fallon (liam.fallon@ericsson.com) - */ -final class DirectoryDeleteShutdownHook extends Thread { - // The directory we are acting on - private final File tempDir; - - /** - * Constructor that defines the directory to act on at shutdown. - * - * @param tempDir The temporary directory to delete - */ - DirectoryDeleteShutdownHook(final File tempDir) { - this.tempDir = tempDir; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Runnable#run() - */ - @Override - public void run() { - if (tempDir.exists()) { - // Empty and delete the directory - DirectoryUtils.emptyDirectory(tempDir); - tempDir.delete(); - } - } -} diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyComparer.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyComparer.java index 8903ea803..f4d628405 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyComparer.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyComparer.java @@ -21,8 +21,8 @@ package org.onap.policy.apex.model.utilities.comparison; /** - * This class compares two keys and returns their differences. It is used in bulk comparisons in models where maps of keys are being compared. The - * {@link KeyComparer} that is returned does the actual comparison + * This class compares two keys and returns their differences. It is used in bulk comparisons in models where maps of + * keys are being compared. The {@link KeyComparer} that is returned does the actual comparison * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the type of key being compared diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyDifference.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyDifference.java index 43c44aefe..2eb6af894 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyDifference.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyDifference.java @@ -21,7 +21,8 @@ package org.onap.policy.apex.model.utilities.comparison; /** - * This class is used to template key differences for bulk key comparisons in models. It performs a difference check between two keys. + * This class is used to template key differences for bulk key comparisons in models. It performs a difference check + * between two keys. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the generic type @@ -86,8 +87,7 @@ public class KeyDifference { builder.append(rightKey); builder.append('\n'); } - } - else { + } else { builder.append("left key "); builder.append(leftKey); builder.append(" and right key "); diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapComparer.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapComparer.java index b11f77a0f..24ff55263 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapComparer.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapComparer.java @@ -27,9 +27,10 @@ import java.util.Set; import java.util.TreeSet; /** - * Compare two maps and returns their differences. The types of the keys and the values in the two maps being comapred must be the same. The class returns - * entries that are only in the left map, only in the right map, entries that have identical keys and different values and entries that have different keys and - * different values in a {@link KeyedMapDifference} instance. + * Compare two maps and returns their differences. The types of the keys and the values in the two maps being comapred + * must be the same. The class returns entries that are only in the left map, only in the right map, entries that have + * identical keys and different values and entries that have different keys and different values in a + * {@link KeyedMapDifference} instance. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the type of the keys in the maps being compared @@ -79,8 +80,7 @@ public class KeyedMapComparer { // Store as appropriate if (leftValue.equals(rightValue)) { result.getIdenticalValues().put(key, leftValue); - } - else { + } else { // Store the two values List valueList = new ArrayList<>(); valueList.add(leftValue); diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapDifference.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapDifference.java index 0f9d6ca50..a7022d84d 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapDifference.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/comparison/KeyedMapDifference.java @@ -26,181 +26,183 @@ import java.util.Map.Entry; import java.util.TreeMap; /** - * This class holds the result of a difference check between two keyed maps. Four results are returned in the class. The {@code leftOnly} result is the entries - * that appear only in the left map. the {@code rightOnly} result is the entries that appear only in the right map. The {@code differentValues} result are the - * entries that have the same key but different values in the maps being compared. The {@code identicalValues} result are the entries with identical keys and - * values in both maps being compared. + * This class holds the result of a difference check between two keyed maps. Four results are returned in the class. The + * {@code leftOnly} result is the entries that appear only in the left map. the {@code rightOnly} result is the entries + * that appear only in the right map. The {@code differentValues} result are the entries that have the same key but + * different values in the maps being compared. The {@code identicalValues} result are the entries with identical keys + * and values in both maps being compared. * * @author Liam Fallon (liam.fallon@ericsson.com) * @param the generic type * @param the generic type */ public class KeyedMapDifference { - private static final String KEY = "key="; - private static final String VALUE = ",value="; - - // Three maps to hold the comparison result - private Map leftOnly = new TreeMap<>(); - private Map rightOnly = new TreeMap<>(); - private Map identicalValues = new TreeMap<>(); - private Map> differentValues = new TreeMap<>(); - - /** - * Gets the entries that were found only in the left map. - * - * @return the entries only in the left map - */ - public Map getLeftOnly() { - return leftOnly; - } - - /** - * Gets the entries that were found only in the right map. - * - * @return the entries only in the right map - */ - public Map getRightOnly() { - return rightOnly; - } - - /** - * Gets the entries that were identical (keys and values the same) in both maps. - * - * @return the identical entries - */ - public Map getIdenticalValues() { - return identicalValues; - } - - /** - * Gets the entries that had the same key but different values in both maps. - * - * @return the entries that were different. There are two values in the list of values for each entry. The first value is the value that was in the left map - * and the second value is the value that was in the right map. - */ - public Map> getDifferentValues() { - return differentValues; - } - - /** - * Return a string representation of the differences. - * - * @param diffsOnly if set, then a blank string is returned if the maps are equal - * @param keysOnly if set, then a terse string that prints only the keys is returned, otherwise both keys and values are printed - * @return the string - */ - public String asString(final boolean diffsOnly, final boolean keysOnly) { - StringBuilder builder = new StringBuilder(); - - if (leftOnly.isEmpty()) { - if (!diffsOnly) { - builder.append("*** all left keys in right\n"); - } - } - else { - builder.append(getInOneSideOnlyAsString(leftOnly, "left", keysOnly)); - } - - if (leftOnly.isEmpty()) { - if (!diffsOnly) { - builder.append("*** all right keys in left\n"); - } - } - else { - builder.append(getInOneSideOnlyAsString(rightOnly, "right", keysOnly)); - } - - if (differentValues.isEmpty()) { - if (!diffsOnly) { - builder.append("*** all values in left and right are identical\n"); - } - } - else { - builder.append(getDifferencesAsString(keysOnly)); - } - - if (!diffsOnly) { - builder.append(getIdenticalsAsString(keysOnly)); - } - - return builder.toString(); - } - - /** - * Output the entries in a map with entries that are in one side only as a string - * @param sideMap the map for the side being checked - * @param sideMapString the string that represents the map in output strings - * @param keysOnly if true, just add key information and not entries - * @return the entries as a string - */ - private Object getInOneSideOnlyAsString(final Map sideMap, final String sideMapString, final boolean keysOnly) { - StringBuilder builder = new StringBuilder(); - - builder.append("*** list of keys on " + sideMapString + " only\n"); - for (Entry leftEntry : sideMap.entrySet()) { - builder.append(KEY); - builder.append(leftEntry.getKey()); - if (!keysOnly) { - builder.append(VALUE); - builder.append(leftEntry.getValue()); - } - builder.append('\n'); - } - - return builder.toString(); - } - - /** - * Output the differences between two the maps as a string - * @param keysOnly if true, just add key information and not entries - * @return the differences as a string - */ - private String getDifferencesAsString(final boolean keysOnly) { - StringBuilder builder = new StringBuilder(); - - builder.append("*** list of differing entries between left and right\n"); - for (Entry> differentEntry : differentValues.entrySet()) { - builder.append(KEY); - builder.append(differentEntry.getKey()); - if (!keysOnly) { - builder.append(",values={"); - boolean first = true; - for (V differentEntryValue : differentEntry.getValue()) { - builder.append(differentEntryValue); - if (first) { - first = false; - } - else { - builder.append(','); - } - } - builder.append("}"); - } - builder.append('\n'); - } - - return builder.toString(); - } - - /** - * Output the identical entries in the maps as a string - * @param keysOnly if true, just add key information and not entries - * @return the identical entries as a string - */ - private String getIdenticalsAsString(final boolean keysOnly) { - StringBuilder builder = new StringBuilder(); - - builder.append("*** list of identical entries in left and right\n"); - for (Entry identicalEntry : identicalValues.entrySet()) { - builder.append(KEY); - builder.append(identicalEntry.getKey()); - if (!keysOnly) { - builder.append(VALUE); - builder.append(identicalEntry.getValue()); - } - builder.append('\n'); - } - - return builder.toString(); - } + private static final String KEY = "key="; + private static final String VALUE = ",value="; + + // Three maps to hold the comparison result + private Map leftOnly = new TreeMap<>(); + private Map rightOnly = new TreeMap<>(); + private Map identicalValues = new TreeMap<>(); + private Map> differentValues = new TreeMap<>(); + + /** + * Gets the entries that were found only in the left map. + * + * @return the entries only in the left map + */ + public Map getLeftOnly() { + return leftOnly; + } + + /** + * Gets the entries that were found only in the right map. + * + * @return the entries only in the right map + */ + public Map getRightOnly() { + return rightOnly; + } + + /** + * Gets the entries that were identical (keys and values the same) in both maps. + * + * @return the identical entries + */ + public Map getIdenticalValues() { + return identicalValues; + } + + /** + * Gets the entries that had the same key but different values in both maps. + * + * @return the entries that were different. There are two values in the list of values for each entry. The first + * value is the value that was in the left map and the second value is the value that was in the right map. + */ + public Map> getDifferentValues() { + return differentValues; + } + + /** + * Return a string representation of the differences. + * + * @param diffsOnly if set, then a blank string is returned if the maps are equal + * @param keysOnly if set, then a terse string that prints only the keys is returned, otherwise both keys and values + * are printed + * @return the string + */ + public String asString(final boolean diffsOnly, final boolean keysOnly) { + StringBuilder builder = new StringBuilder(); + + if (leftOnly.isEmpty()) { + if (!diffsOnly) { + builder.append("*** all left keys in right\n"); + } + } else { + builder.append(getInOneSideOnlyAsString(leftOnly, "left", keysOnly)); + } + + if (leftOnly.isEmpty()) { + if (!diffsOnly) { + builder.append("*** all right keys in left\n"); + } + } else { + builder.append(getInOneSideOnlyAsString(rightOnly, "right", keysOnly)); + } + + if (differentValues.isEmpty()) { + if (!diffsOnly) { + builder.append("*** all values in left and right are identical\n"); + } + } else { + builder.append(getDifferencesAsString(keysOnly)); + } + + if (!diffsOnly) { + builder.append(getIdenticalsAsString(keysOnly)); + } + + return builder.toString(); + } + + /** + * Output the entries in a map with entries that are in one side only as a string. + * + * @param sideMap the map for the side being checked + * @param sideMapString the string that represents the map in output strings + * @param keysOnly if true, just add key information and not entries + * @return the entries as a string + */ + private Object getInOneSideOnlyAsString(final Map sideMap, final String sideMapString, + final boolean keysOnly) { + StringBuilder builder = new StringBuilder(); + + builder.append("*** list of keys on " + sideMapString + " only\n"); + for (Entry leftEntry : sideMap.entrySet()) { + builder.append(KEY); + builder.append(leftEntry.getKey()); + if (!keysOnly) { + builder.append(VALUE); + builder.append(leftEntry.getValue()); + } + builder.append('\n'); + } + + return builder.toString(); + } + + /** + * Output the differences between two the maps as a string. + * + * @param keysOnly if true, just add key information and not entries + * @return the differences as a string + */ + private String getDifferencesAsString(final boolean keysOnly) { + StringBuilder builder = new StringBuilder(); + + builder.append("*** list of differing entries between left and right\n"); + for (Entry> differentEntry : differentValues.entrySet()) { + builder.append(KEY); + builder.append(differentEntry.getKey()); + if (!keysOnly) { + builder.append(",values={"); + boolean first = true; + for (V differentEntryValue : differentEntry.getValue()) { + builder.append(differentEntryValue); + if (first) { + first = false; + } else { + builder.append(','); + } + } + builder.append("}"); + } + builder.append('\n'); + } + + return builder.toString(); + } + + /** + * Output the identical entries in the maps as a string. + * + * @param keysOnly if true, just add key information and not entries + * @return the identical entries as a string + */ + private String getIdenticalsAsString(final boolean keysOnly) { + StringBuilder builder = new StringBuilder(); + + builder.append("*** list of identical entries in left and right\n"); + for (Entry identicalEntry : identicalValues.entrySet()) { + builder.append(KEY); + builder.append(identicalEntry.getKey()); + if (!keysOnly) { + builder.append(VALUE); + builder.append(identicalEntry.getValue()); + } + builder.append('\n'); + } + + return builder.toString(); + } } diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JSONHandler.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JSONHandler.java deleted file mode 100644 index eb42a4efa..000000000 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JSONHandler.java +++ /dev/null @@ -1,53 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2016-2018 Ericsson. 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========================================================= - */ - -package org.onap.policy.apex.model.utilities.json; - -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.Reader; - -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; - -/** - * This class reads objects of the given class from an input stream. - * - * @author Liam Fallon (liam.fallon@ericsson.com) - * @param the generic type - */ -public class JSONHandler { - - /** - * This method reads objects of a given class from an input stream. - * - * @param inputClass The class to read - * @param inputStream the input stream to read from - * @return the object read - */ - public TYPE read(final Class inputClass, final InputStream inputStream) { - // Register the adapters for our carrier technologies and event protocols with GSON - final GsonBuilder gsonBuilder = new GsonBuilder(); - - final Gson gson = gsonBuilder.serializeNulls().create(); - final Reader jsonResourceReader = new InputStreamReader(inputStream); - return gson.fromJson(jsonResourceReader, inputClass); - } -} diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JsonHandler.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JsonHandler.java new file mode 100644 index 000000000..9ec5f590e --- /dev/null +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/JsonHandler.java @@ -0,0 +1,53 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. 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========================================================= + */ + +package org.onap.policy.apex.model.utilities.json; + +import com.google.gson.Gson; +import com.google.gson.GsonBuilder; + +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.Reader; + +/** + * This class reads objects of the given class from an input stream. + * + * @author Liam Fallon (liam.fallon@ericsson.com) + * @param

the generic type + */ +public class JsonHandler

{ + + /** + * This method reads objects of a given class from an input stream. + * + * @param inputClass The class to read + * @param inputStream the input stream to read from + * @return the object read + */ + public P read(final Class

inputClass, final InputStream inputStream) { + // Register the adapters for our carrier technologies and event protocols with GSON + final GsonBuilder gsonBuilder = new GsonBuilder(); + + final Gson gson = gsonBuilder.serializeNulls().create(); + final Reader jsonResourceReader = new InputStreamReader(inputStream); + return gson.fromJson(jsonResourceReader, inputClass); + } +} diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/ClassBuilder.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/ClassBuilder.java index e806bd7a0..ffebc405f 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/ClassBuilder.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/ClassBuilder.java @@ -29,9 +29,9 @@ import sun.reflect.generics.reflectiveObjects.ParameterizedTypeImpl; //CHECKSTYLE:ON: checkstyle:IllegalImport /** - * This class is a utility class that builds a class with a set of user defined fields. It is used to get the Type of fields in Java schemas
- * For more information see:
- * + * This class is a utility class that builds a class with a set of user defined fields. It is used to get the Type of + * fields in Java schemas
For more information see:
 * http://stackoverflow.com/questions/39401083/class-forname-equivalent-for-creating-parameterizedtypes-from-string
* * https://github.com/KetothXupack/stackoverflow-answers/tree/master/q39401083
@@ -59,13 +59,12 @@ public class ClassBuilder { public static ClassBuilder parse(final String className) { try { return new ClassBuilder(Class.forName(className)); - } - catch (ClassNotFoundException e) { + } catch (ClassNotFoundException e) { try { return new ClassBuilder(Class.forName("java.lang." + className)); - } - catch (Exception ignore) { - throw new IllegalArgumentException("Class '" + className + "' not found. Also looked for a class called 'java.lang." + className + "'", e); + } catch (Exception ignore) { + throw new IllegalArgumentException("Class '" + className + + "' not found. Also looked for a class called 'java.lang." + className + "'", e); } } } @@ -89,11 +88,11 @@ public class ClassBuilder { if (parameters.isEmpty()) { return clazz; } - Type[] paramtypes = new Type[parameters.size()]; - int i = 0; + Type[] paramTypes = new Type[parameters.size()]; + int paramTypeIndex = 0; for (ClassBuilder classBuilder : parameters) { - paramtypes[i++] = classBuilder.build(); + paramTypes[paramTypeIndex++] = classBuilder.build(); } - return ParameterizedTypeImpl.make(clazz, paramtypes, null); + return ParameterizedTypeImpl.make(clazz, paramTypes, null); } } diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/TypeBuilder.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/TypeBuilder.java index 0e3851519..ecda86f59 100644 --- a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/TypeBuilder.java +++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/typeutils/TypeBuilder.java @@ -47,7 +47,8 @@ public final class TypeBuilder { */ public static Type build(final String type) { if (type == null || type.length() == 0) { - throw new IllegalArgumentException("Blank type string passed to " + TypeBuilder.class.getCanonicalName() + ".build(String type)"); + throw new IllegalArgumentException("Blank type string passed to " + TypeBuilder.class.getCanonicalName() + + ".build(String type)"); } try { @@ -59,8 +60,7 @@ public final class TypeBuilder { parser.setErrorHandler(new BailErrorStrategy()); parser.setBuildParseTree(true); return parser.type().value.build(); - } - catch (final Exception e) { + } catch (final Exception e) { throw new IllegalArgumentException("Failed to build type '" + type + "': " + e, e); } } @@ -84,16 +84,16 @@ public final class TypeBuilder { public static Class getJavaTypeClass(final Type type) { if (type instanceof Class) { return (Class) type; - } - else if (type instanceof ParameterizedType) { + } else if (type instanceof ParameterizedType) { final Type raw = ((ParameterizedType) type).getRawType(); if (!(raw instanceof Class)) { - throw new IllegalArgumentException( - "The Parameterised javatype " + type + " with base type " + raw + " is not a Java 'Class' that can be instantiated"); + throw new IllegalArgumentException("The Parameterised javatype " + type + " with base type " + raw + + " is not a Java 'Class' that can be instantiated"); } return (Class) raw; } - throw new IllegalArgumentException("The Parameterised javatype " + type + " is not a Java 'Type' that has a 'Class'"); + throw new IllegalArgumentException( + "The Parameterised javatype " + type + " is not a Java 'Type' that has a 'Class'"); } /** @@ -105,10 +105,10 @@ public final class TypeBuilder { public static Type[] getJavaTypeParameters(final Type type) { if (type instanceof Class) { return new Type[0]; - } - else if (type instanceof ParameterizedType) { + } else if (type instanceof ParameterizedType) { return ((ParameterizedType) type).getActualTypeArguments(); } - throw new IllegalArgumentException("\"The Parameterised javatype \" + type + \" is not a Java 'Type' that has parameter types"); + throw new IllegalArgumentException( + "\"The Parameterised javatype \" + type + \" is not a Java 'Type' that has parameter types"); } } -- cgit 1.2.3-korg