From 8529175bc79783c1464b671b72f352d67c9f8c81 Mon Sep 17 00:00:00 2001 From: smisger Date: Tue, 16 Feb 2016 19:50:53 +0530 Subject: [PATCH] Fixing squid:S1118 - Utility classes should not have public constructors --- src/main/java/org/audit4j/core/Configurations.java | 4 ++-- src/main/java/org/audit4j/core/CoreConstants.java | 4 ++++ src/main/java/org/audit4j/core/ErrorGuide.java | 9 ++++++++- src/main/java/org/audit4j/core/TroubleshootManager.java | 7 +++++++ .../java/org/audit4j/core/annotation/DeIdentifyUtil.java | 8 ++++++++ src/main/java/org/audit4j/core/dto/AuditLevel.java | 7 +++++++ .../core/extra/scannotation/ClasspathUrlFinder.java | 7 +++++++ .../audit4j/core/extra/scannotation/IteratorFactory.java | 8 ++++++++ .../core/handler/file/archive/FTPArchiveClient.java | 7 +++++++ src/main/java/org/audit4j/core/jmx/JMXUtils.java | 7 +++++++ src/main/java/org/audit4j/core/schedule/TaskUtils.java | 8 ++++++++ .../java/org/audit4j/core/schedule/util/ClassUtils.java | 7 +++++++ .../java/org/audit4j/core/schedule/util/StringUtils.java | 7 +++++++ src/main/java/org/audit4j/core/util/EnvUtil.java | 8 ++++++++ src/main/java/org/audit4j/core/util/Log.java | 6 ++++++ .../java/org/audit4j/core/web/ContextConfigParams.java | 6 ++++++ 16 files changed, 107 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/audit4j/core/Configurations.java b/src/main/java/org/audit4j/core/Configurations.java index 3c42379..209d3b2 100644 --- a/src/main/java/org/audit4j/core/Configurations.java +++ b/src/main/java/org/audit4j/core/Configurations.java @@ -52,9 +52,9 @@ public class Configurations { static final String ENVIRONMENT_CONFIG_VARIABLE_NAME = "AUDIT4J_CONF_FILE_PATH"; /** - * Instantiates a new configurations. + * */ - public Configurations() { + private Configurations() { } diff --git a/src/main/java/org/audit4j/core/CoreConstants.java b/src/main/java/org/audit4j/core/CoreConstants.java index fa2d321..495dd07 100644 --- a/src/main/java/org/audit4j/core/CoreConstants.java +++ b/src/main/java/org/audit4j/core/CoreConstants.java @@ -147,5 +147,9 @@ public final class CoreConstants { /** The Constant ENCODE_UTF8. */ public static final String ENCODE_UTF8 = "UTF-8"; + + private CoreConstants(){ + + } } diff --git a/src/main/java/org/audit4j/core/ErrorGuide.java b/src/main/java/org/audit4j/core/ErrorGuide.java index 16af373..62d4a65 100644 --- a/src/main/java/org/audit4j/core/ErrorGuide.java +++ b/src/main/java/org/audit4j/core/ErrorGuide.java @@ -59,7 +59,14 @@ public final class ErrorGuide { /** The Constant LAYOUT_ERROR. */ public static final String OPTION_ERROR = ERROR_URL + "optionError"; - + + /** + * private constructor to avoid instantiation of this class + */ + private ErrorGuide(){ + + } + /** * Gets the guide. * diff --git a/src/main/java/org/audit4j/core/TroubleshootManager.java b/src/main/java/org/audit4j/core/TroubleshootManager.java index ab348f6..0463740 100644 --- a/src/main/java/org/audit4j/core/TroubleshootManager.java +++ b/src/main/java/org/audit4j/core/TroubleshootManager.java @@ -38,6 +38,13 @@ public final class TroubleshootManager { /** The Constant MAX_PORT_NUMBER. */ public static final int MAX_PORT_NUMBER = 49151; + + /** + * private constructor to avoid instantiation of this class + */ + private TroubleshootManager(){ + + } /** * Troubleshoot event. diff --git a/src/main/java/org/audit4j/core/annotation/DeIdentifyUtil.java b/src/main/java/org/audit4j/core/annotation/DeIdentifyUtil.java index d6d9d6e..1d259ae 100644 --- a/src/main/java/org/audit4j/core/annotation/DeIdentifyUtil.java +++ b/src/main/java/org/audit4j/core/annotation/DeIdentifyUtil.java @@ -29,6 +29,14 @@ */ public class DeIdentifyUtil { + + /** + * private constructor to avoid instantiation of this class + */ + private DeIdentifyUtil(){ + + } + /** * Deidentify left. * diff --git a/src/main/java/org/audit4j/core/dto/AuditLevel.java b/src/main/java/org/audit4j/core/dto/AuditLevel.java index 240756f..0cdd051 100644 --- a/src/main/java/org/audit4j/core/dto/AuditLevel.java +++ b/src/main/java/org/audit4j/core/dto/AuditLevel.java @@ -29,5 +29,12 @@ public class AuditLevel { /** The Constant DEFAULT_LEVEL. */ public static final String DEFAULT_LEVEL = "default"; + + /** + * private constructor to avoid instantiation of this class + */ + private AuditLevel(){ + + } } diff --git a/src/main/java/org/audit4j/core/extra/scannotation/ClasspathUrlFinder.java b/src/main/java/org/audit4j/core/extra/scannotation/ClasspathUrlFinder.java index 91352c9..bedfa19 100644 --- a/src/main/java/org/audit4j/core/extra/scannotation/ClasspathUrlFinder.java +++ b/src/main/java/org/audit4j/core/extra/scannotation/ClasspathUrlFinder.java @@ -18,6 +18,13 @@ public class ClasspathUrlFinder { + /** + * private constructor to avoid instantiation of this class + */ + private ClasspathUrlFinder(){ + + } + /** * Find the classpath URLs for a specific classpath resource. The classpath URL is extracted * from loader.getResources() using the baseResource. diff --git a/src/main/java/org/audit4j/core/extra/scannotation/IteratorFactory.java b/src/main/java/org/audit4j/core/extra/scannotation/IteratorFactory.java index 3026cd2..c1338d2 100644 --- a/src/main/java/org/audit4j/core/extra/scannotation/IteratorFactory.java +++ b/src/main/java/org/audit4j/core/extra/scannotation/IteratorFactory.java @@ -6,6 +6,14 @@ public class IteratorFactory { private static final ConcurrentHashMap registry = new ConcurrentHashMap(); + + /** + * private constructor to avoid instantiation of this class + */ + private IteratorFactory(){ + + } + static { registry.put("file", new FileProtocolIteratorFactory()); } diff --git a/src/main/java/org/audit4j/core/handler/file/archive/FTPArchiveClient.java b/src/main/java/org/audit4j/core/handler/file/archive/FTPArchiveClient.java index 8755295..a10797a 100644 --- a/src/main/java/org/audit4j/core/handler/file/archive/FTPArchiveClient.java +++ b/src/main/java/org/audit4j/core/handler/file/archive/FTPArchiveClient.java @@ -32,6 +32,13 @@ * @author Janith Bandara */ public final class FTPArchiveClient { + + /** + * private constructor to avoid instantiation of this class + */ + private FTPArchiveClient(){ + + } /** The Constant USAGE. */ public static final String USAGE = "Usage: ftp [options] [ []]\n" diff --git a/src/main/java/org/audit4j/core/jmx/JMXUtils.java b/src/main/java/org/audit4j/core/jmx/JMXUtils.java index 6718ba6..9a8063a 100644 --- a/src/main/java/org/audit4j/core/jmx/JMXUtils.java +++ b/src/main/java/org/audit4j/core/jmx/JMXUtils.java @@ -10,6 +10,13 @@ * @since 2.4.0 */ public class JMXUtils { + + /** + * private constructor to avoid instantiation of this class + */ + private JMXUtils(){ + + } /** * Gets the object name. diff --git a/src/main/java/org/audit4j/core/schedule/TaskUtils.java b/src/main/java/org/audit4j/core/schedule/TaskUtils.java index 7cc34fd..b2431fa 100644 --- a/src/main/java/org/audit4j/core/schedule/TaskUtils.java +++ b/src/main/java/org/audit4j/core/schedule/TaskUtils.java @@ -16,6 +16,14 @@ * @since 3.0 */ public abstract class TaskUtils { + + /** + * private constructor to avoid instantiation of this class + */ + private TaskUtils(){ + + } + /** * An ErrorHandler strategy that will log the Exception but perform no * further handling. This will suppress the error so that subsequent diff --git a/src/main/java/org/audit4j/core/schedule/util/ClassUtils.java b/src/main/java/org/audit4j/core/schedule/util/ClassUtils.java index 5210eee..6c6165b 100644 --- a/src/main/java/org/audit4j/core/schedule/util/ClassUtils.java +++ b/src/main/java/org/audit4j/core/schedule/util/ClassUtils.java @@ -5,6 +5,13 @@ import java.util.Set; public class ClassUtils { + + /** + * private constructor to avoid instantiation of this class + */ + private ClassUtils(){ + + } /** * Determine whether the given class has a public method with the given diff --git a/src/main/java/org/audit4j/core/schedule/util/StringUtils.java b/src/main/java/org/audit4j/core/schedule/util/StringUtils.java index d4c1079..84b36a9 100644 --- a/src/main/java/org/audit4j/core/schedule/util/StringUtils.java +++ b/src/main/java/org/audit4j/core/schedule/util/StringUtils.java @@ -21,6 +21,13 @@ public class StringUtils { private static final String TOP_PATH = ".."; private static final String CURRENT_PATH = "."; private static final char EXTENSION_SEPARATOR = '.'; + + /** + * private constructor to avoid instantiation of this class + */ + private StringUtils(){ + + } // --------------------------------------------------------------------- // General convenience methods for working with Strings diff --git a/src/main/java/org/audit4j/core/util/EnvUtil.java b/src/main/java/org/audit4j/core/util/EnvUtil.java index 8db7989..bc8e4d6 100644 --- a/src/main/java/org/audit4j/core/util/EnvUtil.java +++ b/src/main/java/org/audit4j/core/util/EnvUtil.java @@ -33,6 +33,14 @@ */ public class EnvUtil { + + /** + * private constructor to avoid instantiation of this class + */ + private EnvUtil(){ + + } + /** * Checks if is jD k_ n_ or higher. * diff --git a/src/main/java/org/audit4j/core/util/Log.java b/src/main/java/org/audit4j/core/util/Log.java index 38e122a..ba44312 100644 --- a/src/main/java/org/audit4j/core/util/Log.java +++ b/src/main/java/org/audit4j/core/util/Log.java @@ -51,6 +51,12 @@ public class Log { /** The error stream. */ private static PrintStream errorStream = System.err; + /** + * private constructor to avoid instantiation of this class + */ + private Log(){ + + } /** * Write information in the console. * diff --git a/src/main/java/org/audit4j/core/web/ContextConfigParams.java b/src/main/java/org/audit4j/core/web/ContextConfigParams.java index 48f8ad2..13ff044 100644 --- a/src/main/java/org/audit4j/core/web/ContextConfigParams.java +++ b/src/main/java/org/audit4j/core/web/ContextConfigParams.java @@ -44,4 +44,10 @@ class ContextConfigParams { /** The Constant PARAM_PROPERTIES. */ static final String PARAM_PROPERTIES = "properties"; + /** + * private constructor to avoid instantiation of this class + */ + private ContextConfigParams(){ + + } }