From 9adc65d9e5df41d2f8884e9f6f92d640db0c2207 Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Thu, 31 Jan 2013 10:26:16 +0100 Subject: [PATCH] util classes should be final with a private constructor --- .../src/main/java/sonia/scm/maven/Util.java | 10 +++- .../sonia/scm/cli/wrapper/WrapperUtil.java | 13 ++++- .../java/sonia/scm/client/ClientUtil.java | 10 +++- .../sonia/scm/client/it/ClientTestUtil.java | 9 ++- .../java/sonia/scm/repository/EscapeUtil.java | 10 +++- .../sonia/scm/repository/PermissionUtil.java | 12 +++- .../sonia/scm/repository/RepositoryUtil.java | 56 ++++++++++--------- .../java/sonia/scm/search/SearchUtil.java | 16 ++++-- .../java/sonia/scm/security/CipherUtil.java | 27 +++++---- .../src/main/java/sonia/scm/url/UrlUtil.java | 10 +++- .../main/java/sonia/scm/util/AssertUtil.java | 11 +++- .../java/sonia/scm/util/ChecksumUtil.java | 12 +++- .../main/java/sonia/scm/util/GlobUtil.java | 8 ++- .../main/java/sonia/scm/util/HttpUtil.java | 15 ++++- .../src/main/java/sonia/scm/util/IOUtil.java | 40 +++++++------ .../java/sonia/scm/util/RegistryUtil.java | 12 +++- .../java/sonia/scm/util/SecurityUtil.java | 10 +++- .../main/java/sonia/scm/util/ServiceUtil.java | 10 +++- .../main/java/sonia/scm/util/SystemUtil.java | 13 ++++- .../src/main/java/sonia/scm/util/Util.java | 36 +++++++----- .../java/sonia/scm/util/ValidationUtil.java | 12 +++- .../src/main/java/sonia/scm/util/WebUtil.java | 20 +++++-- .../java/sonia/scm/orientdb/OrientDBUtil.java | 25 ++++++--- .../java/sonia/scm/plugin/PluginUtil.java | 10 +++- .../java/sonia/scm/repository/GitUtil.java | 10 +++- .../src/main/java/sonia/scm/web/HgUtil.java | 10 +++- .../java/sonia/scm/repository/HgTestUtil.java | 12 +++- .../java/sonia/scm/repository/SvnUtil.java | 10 +++- .../main/java/sonia/scm/util/MockUtil.java | 10 +++- .../java/sonia/scm/boot/BootstrapUtil.java | 14 ++++- .../sonia/scm/util/ScmConfigurationUtil.java | 6 +- .../sonia/scm/web/security/SecurityUtil.java | 14 ++++- .../sonia/scm/it/IntegrationTestUtil.java | 20 +++++-- .../java/sonia/scm/it/RepositoryITUtil.java | 14 ++++- 34 files changed, 393 insertions(+), 134 deletions(-) diff --git a/maven/scm-maven-plugin/src/main/java/sonia/scm/maven/Util.java b/maven/scm-maven-plugin/src/main/java/sonia/scm/maven/Util.java index 08f983c5cc..63853934af 100644 --- a/maven/scm-maven-plugin/src/main/java/sonia/scm/maven/Util.java +++ b/maven/scm-maven-plugin/src/main/java/sonia/scm/maven/Util.java @@ -48,9 +48,17 @@ import java.util.zip.ZipFile; * * @author Sebastian Sdorra */ -public class Util +public final class Util { + /** + * Constructs ... + * + */ + private Util() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/wrapper/WrapperUtil.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/wrapper/WrapperUtil.java index f508b45039..0c87424fe6 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/wrapper/WrapperUtil.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/wrapper/WrapperUtil.java @@ -50,9 +50,17 @@ import java.util.List; * * @author Sebastian Sdorra */ -public class WrapperUtil +public final class WrapperUtil { + /** + * Constructs ... + * + */ + private WrapperUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * @@ -78,7 +86,6 @@ public class WrapperUtil * * * - * @param baseUrl * * @param config * @param repositories @@ -86,7 +93,7 @@ public class WrapperUtil * @return */ public static List wrapRepositories(ServerConfig config, - Collection repositories) + Collection repositories) { List wrappers = new ArrayList(); diff --git a/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/ClientUtil.java b/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/ClientUtil.java index e02fafc1fc..e297405026 100644 --- a/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/ClientUtil.java +++ b/scm-clients/scm-client-impl/src/main/java/sonia/scm/client/ClientUtil.java @@ -49,13 +49,21 @@ import com.sun.jersey.api.client.filter.LoggingFilter; * * @author Sebastian Sdorra */ -public class ClientUtil +public final class ClientUtil { /** the logger for ClientUtil */ private static final Logger logger = LoggerFactory.getLogger(ClientUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private ClientUtil() {} + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-clients/scm-client-impl/src/test/java/sonia/scm/client/it/ClientTestUtil.java b/scm-clients/scm-client-impl/src/test/java/sonia/scm/client/it/ClientTestUtil.java index a9caf9d50e..c567ff0e86 100644 --- a/scm-clients/scm-client-impl/src/test/java/sonia/scm/client/it/ClientTestUtil.java +++ b/scm-clients/scm-client-impl/src/test/java/sonia/scm/client/it/ClientTestUtil.java @@ -50,7 +50,7 @@ import com.sun.jersey.api.client.WebResource; * * @author Sebastian Sdorra */ -public class ClientTestUtil +public final class ClientTestUtil { /** Field description */ @@ -68,6 +68,13 @@ public class ClientTestUtil /** Field description */ public static final boolean REQUEST_LOGGING = false; + private ClientTestUtil() + { + } + + + + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-core/src/main/java/sonia/scm/repository/EscapeUtil.java b/scm-core/src/main/java/sonia/scm/repository/EscapeUtil.java index b4e85faac0..a06472256d 100644 --- a/scm-core/src/main/java/sonia/scm/repository/EscapeUtil.java +++ b/scm-core/src/main/java/sonia/scm/repository/EscapeUtil.java @@ -50,9 +50,17 @@ import java.util.List; * @author Sebastian Sdorra * @since 1.15 */ -public class EscapeUtil +public final class EscapeUtil { + /** + * Constructs ... + * + */ + private EscapeUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * diff --git a/scm-core/src/main/java/sonia/scm/repository/PermissionUtil.java b/scm-core/src/main/java/sonia/scm/repository/PermissionUtil.java index 6d77ed8617..afd1d1e681 100644 --- a/scm-core/src/main/java/sonia/scm/repository/PermissionUtil.java +++ b/scm-core/src/main/java/sonia/scm/repository/PermissionUtil.java @@ -58,7 +58,7 @@ import java.util.List; * * @author Sebastian Sdorra */ -public class PermissionUtil +public final class PermissionUtil { /** @@ -67,6 +67,14 @@ public class PermissionUtil private static final Logger logger = LoggerFactory.getLogger(PermissionUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private PermissionUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -105,7 +113,6 @@ public class PermissionUtil * * * @param repository - * @param securityContextProvider * @param pt * * @since 1.21 @@ -238,7 +245,6 @@ public class PermissionUtil * * @param configuration SCM-Manager main configuration * @param repository repository to check - * @param securityContext current user security context * * @return true if the repository is writable * @since 1.21 diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryUtil.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryUtil.java index d44e7e50b1..c10318759f 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryUtil.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryUtil.java @@ -59,13 +59,21 @@ import javax.servlet.http.HttpServletRequest; * @author Sebastian Sdorra * @since 1.11 */ -public class RepositoryUtil +public final class RepositoryUtil { /** the logger for RepositoryUtil */ private static final Logger logger = LoggerFactory.getLogger(RepositoryUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private RepositoryUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -79,8 +87,7 @@ public class RepositoryUtil * @since 1.16 */ public static void appendUrl(ScmConfiguration configuration, - RepositoryManager repositoryManager, - Repository repository) + RepositoryManager repositoryManager, Repository repository) { RepositoryHandler handler = repositoryManager.getHandler(repository.getType()); @@ -106,8 +113,7 @@ public class RepositoryUtil * @since 1.16 */ public static void appendUrl(HttpServletRequest request, - RepositoryManager repositoryManager, - Repository repository) + RepositoryManager repositoryManager, Repository repository) { RepositoryHandler handler = repositoryManager.getHandler(repository.getType()); @@ -131,7 +137,7 @@ public class RepositoryUtil * @return */ public static List searchRepositoryDirectories(File directory, - String... names) + String... names) { List repositories = new ArrayList(); @@ -154,11 +160,11 @@ public class RepositoryUtil * @throws IOException */ public static String getRepositoryName(AbstractRepositoryHandler handler, - String directoryPath) - throws IOException + String directoryPath) + throws IOException { return getRepositoryName(handler.getConfig().getRepositoryDirectory(), - new File(directoryPath)); + new File(directoryPath)); } /** @@ -173,11 +179,11 @@ public class RepositoryUtil * @throws IOException */ public static String getRepositoryName(SimpleRepositoryConfig config, - String directoryPath) - throws IOException + String directoryPath) + throws IOException { return getRepositoryName(config.getRepositoryDirectory(), - new File(directoryPath)); + new File(directoryPath)); } /** @@ -192,11 +198,11 @@ public class RepositoryUtil * @throws IOException */ public static String getRepositoryName(AbstractRepositoryHandler handler, - File directory) - throws IOException + File directory) + throws IOException { return getRepositoryName(handler.getConfig().getRepositoryDirectory(), - directory); + directory); } /** @@ -211,8 +217,8 @@ public class RepositoryUtil * @throws IOException */ public static String getRepositoryName(SimpleRepositoryConfig config, - File directory) - throws IOException + File directory) + throws IOException { return getRepositoryName(config.getRepositoryDirectory(), directory); } @@ -229,7 +235,7 @@ public class RepositoryUtil * @throws IOException */ public static String getRepositoryName(File baseDirectory, File directory) - throws IOException + throws IOException { String name = null; String path = directory.getCanonicalPath(); @@ -262,8 +268,8 @@ public class RepositoryUtil * @throws IOException */ public static List getRepositoryNames( - AbstractRepositoryHandler handler, String... directoryNames) - throws IOException + AbstractRepositoryHandler handler, String... directoryNames) + throws IOException { return getRepositoryNames(handler.getConfig(), directoryNames); } @@ -280,8 +286,8 @@ public class RepositoryUtil * @throws IOException */ public static List getRepositoryNames(SimpleRepositoryConfig config, - String... directoryNames) - throws IOException + String... directoryNames) + throws IOException { return getRepositoryNames(config.getRepositoryDirectory(), directoryNames); } @@ -298,8 +304,8 @@ public class RepositoryUtil * @throws IOException */ public static List getRepositoryNames(File baseDirectory, - String... directoryNames) - throws IOException + String... directoryNames) + throws IOException { List repositories = new ArrayList(); List repositoryFiles = searchRepositoryDirectories(baseDirectory, @@ -329,7 +335,7 @@ public class RepositoryUtil * @param names */ private static void searchRepositoryDirectories(List repositories, - File directory, List names) + File directory, List names) { boolean found = false; diff --git a/scm-core/src/main/java/sonia/scm/search/SearchUtil.java b/scm-core/src/main/java/sonia/scm/search/SearchUtil.java index 730aa3f257..2a4d4aa8f5 100644 --- a/scm-core/src/main/java/sonia/scm/search/SearchUtil.java +++ b/scm-core/src/main/java/sonia/scm/search/SearchUtil.java @@ -50,9 +50,17 @@ import java.util.Locale; * * @author Sebastian Sdorra */ -public class SearchUtil +public final class SearchUtil { + /** + * Constructs ... + * + */ + private SearchUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * @@ -64,7 +72,7 @@ public class SearchUtil * @return */ public static boolean matchesAll(SearchRequest request, String value, - String... other) + String... other) { boolean result = false; String query = createStringQuery(request); @@ -101,7 +109,7 @@ public class SearchUtil * @return */ public static boolean matchesOne(SearchRequest request, String value, - String... other) + String... other) { boolean result = false; String query = createStringQuery(request); @@ -141,7 +149,7 @@ public class SearchUtil * @return */ public static Collection search(SearchRequest searchRequest, - Collection collection, TransformFilter filter) + Collection collection, TransformFilter filter) { List items = new ArrayList(); int index = 0; diff --git a/scm-core/src/main/java/sonia/scm/security/CipherUtil.java b/scm-core/src/main/java/sonia/scm/security/CipherUtil.java index c516cc7a8f..4de0b95946 100644 --- a/scm-core/src/main/java/sonia/scm/security/CipherUtil.java +++ b/scm-core/src/main/java/sonia/scm/security/CipherUtil.java @@ -43,7 +43,7 @@ import sonia.scm.util.ServiceUtil; * @author Sebastian Sdorra * @since 1.7 */ -public class CipherUtil +public final class CipherUtil { /** Field description */ @@ -51,8 +51,6 @@ public class CipherUtil //~--- constructors --------------------------------------------------------- - private KeyGenerator keyGenerator; - /** * Constructs ... * @@ -71,17 +69,10 @@ public class CipherUtil if (cipherHandler == null) { cipherHandler = new DefaultCipherHandler(SCMContext.getContext(), - keyGenerator); + keyGenerator); } } - public KeyGenerator getKeyGenerator() - { - return keyGenerator; - } - - - //~--- get methods ---------------------------------------------------------- /** @@ -147,8 +138,22 @@ public class CipherUtil return cipherHandler; } + /** + * Method description + * + * + * @return + */ + public KeyGenerator getKeyGenerator() + { + return keyGenerator; + } + //~--- fields --------------------------------------------------------------- /** Field description */ private CipherHandler cipherHandler; + + /** Field description */ + private KeyGenerator keyGenerator; } diff --git a/scm-core/src/main/java/sonia/scm/url/UrlUtil.java b/scm-core/src/main/java/sonia/scm/url/UrlUtil.java index a46b9252f4..0d90da10b6 100644 --- a/scm-core/src/main/java/sonia/scm/url/UrlUtil.java +++ b/scm-core/src/main/java/sonia/scm/url/UrlUtil.java @@ -42,9 +42,17 @@ import sonia.scm.util.Util; * @author Sebastian Sdorra * @since 1.11 */ -public class UrlUtil +public final class UrlUtil { + /** + * Constructs ... + * + */ + private UrlUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * diff --git a/scm-core/src/main/java/sonia/scm/util/AssertUtil.java b/scm-core/src/main/java/sonia/scm/util/AssertUtil.java index b53037a023..56b30986db 100644 --- a/scm-core/src/main/java/sonia/scm/util/AssertUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/AssertUtil.java @@ -35,7 +35,6 @@ package sonia.scm.util; //~--- non-JDK imports -------------------------------------------------------- -import sonia.scm.ArgumentIsInvalidException; import sonia.scm.Validateable; //~--- JDK imports ------------------------------------------------------------ @@ -46,9 +45,17 @@ import java.util.Collection; * * @author Sebastian Sdorra */ -public class AssertUtil +public final class AssertUtil { + /** + * Constructs ... + * + */ + private AssertUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * diff --git a/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java b/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java index a0d22deebb..0e87748ffe 100644 --- a/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/ChecksumUtil.java @@ -48,12 +48,20 @@ import java.security.NoSuchAlgorithmException; * * @author Sebastian Sdorra */ -public class ChecksumUtil +public final class ChecksumUtil { /** Field description */ private static final String DIGEST_TYPE = "SHA-1"; + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private ChecksumUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -143,7 +151,7 @@ public class ChecksumUtil * @return * * @throws IOException - * + * * @since 1.12 */ public static String createChecksum(byte[] content) throws IOException diff --git a/scm-core/src/main/java/sonia/scm/util/GlobUtil.java b/scm-core/src/main/java/sonia/scm/util/GlobUtil.java index 95bd06fda6..5386f4a048 100644 --- a/scm-core/src/main/java/sonia/scm/util/GlobUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/GlobUtil.java @@ -40,9 +40,15 @@ package sonia.scm.util; * @author Sebastian Sdorra * @since 1.8 */ -public class GlobUtil +public final class GlobUtil { + private GlobUtil() + { + } + + + /** * Converts the given glob string to a regular expression string. * diff --git a/scm-core/src/main/java/sonia/scm/util/HttpUtil.java b/scm-core/src/main/java/sonia/scm/util/HttpUtil.java index 9be8522691..8400ebeee6 100644 --- a/scm-core/src/main/java/sonia/scm/util/HttpUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/HttpUtil.java @@ -61,7 +61,7 @@ import javax.servlet.http.HttpServletResponse; * * @author Sebastian Sdorra */ -public class HttpUtil +public final class HttpUtil { /** authentication realm for basic authentication */ @@ -160,10 +160,21 @@ public class HttpUtil /** the logger for HttpUtil */ private static final Logger logger = LoggerFactory.getLogger(HttpUtil.class); - /** Field description */ + /** + * Pattern for url normalization + * @sincee 1.26 + */ private static final Pattern PATTERN_URLNORMALIZE = Pattern.compile("(?:(http://[^:]+):80(/.+)?|(https://[^:]+):443(/.+)?)"); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private HttpUtil() {} + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-core/src/main/java/sonia/scm/util/IOUtil.java b/scm-core/src/main/java/sonia/scm/util/IOUtil.java index ee1148f6f9..cf2a8a28dc 100644 --- a/scm-core/src/main/java/sonia/scm/util/IOUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/IOUtil.java @@ -65,7 +65,7 @@ import java.util.Locale; * * @author Sebastian Sdorra */ -public class IOUtil +public final class IOUtil { /** Field description */ @@ -93,16 +93,24 @@ public class IOUtil /** Field description */ private static final String[] EXTENSION_SCRIPT_UNIX = { ".sh", ".csh", - ".bsh" }; + ".bsh" }; /** Field description */ private static final String[] EXTENSION_SCRIPT_WINDOWS = { ".bat", ".cmd", - ".exe" }; + ".exe" }; /** Field description */ private static final Logger logger = LoggerFactory.getLogger(IOUtil.class.getName()); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private IOUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -137,7 +145,7 @@ public class IOUtil * @throws IOException */ public static void copy(Reader reader, Writer writer, int bufferSize) - throws IOException + throws IOException { char[] buffer = new char[bufferSize]; @@ -186,7 +194,7 @@ public class IOUtil * @throws IOException */ public static void copy(InputStream in, OutputStream out, int bufferSize) - throws IOException + throws IOException { byte[] buffer = new byte[bufferSize]; @@ -210,8 +218,8 @@ public class IOUtil * @throws IOException */ public static void copy(InputStream in, OutputStream out, int bufferSize, - int byteCount) - throws IOException + int byteCount) + throws IOException { byte buffer[] = new byte[bufferSize]; int len = bufferSize; @@ -221,8 +229,8 @@ public class IOUtil while (byteCount > 0) { int max = (byteCount < bufferSize) - ? (int) byteCount - : bufferSize; + ? (int) byteCount + : bufferSize; len = in.read(buffer, 0, max); @@ -343,7 +351,7 @@ public class IOUtil * @param bufferSize */ public static void copyThread(InputStream input, OutputStream output, - int bufferSize) + int bufferSize) { new Thread(new IOStreamCopyThread(input, output, bufferSize)).start(); } @@ -410,7 +418,7 @@ public class IOUtil * @throws IOException */ public static void extract(File archive, File outputDirectory) - throws IOException + throws IOException { String name = archive.getName().toLowerCase(Locale.ENGLISH); @@ -428,7 +436,7 @@ public class IOUtil * @throws IOException */ public static void extract(File archive, File outputDirectory, String type) - throws IOException + throws IOException { if (type.endsWith(ZipUnArchiver.EXTENSION)) { @@ -451,7 +459,7 @@ public class IOUtil if (!directory.exists() &&!directory.mkdirs()) { throw new IllegalStateException( - "could not create directory ".concat(directory.getPath())); + "could not create directory ".concat(directory.getPath())); } } @@ -569,7 +577,7 @@ public class IOUtil * @return */ public static List searchAll(String[] path, String cmd, - String checkParameter) + String checkParameter) { List cmds = new ArrayList(); @@ -737,7 +745,7 @@ public class IOUtil * @return */ private static File findFileByExtension(String parentPath, String cmd, - List potentialExtensions) + List potentialExtensions) { File file = null; @@ -942,7 +950,7 @@ public class IOUtil * @param bufferSize */ public IOStreamCopyThread(InputStream input, OutputStream output, - int bufferSize) + int bufferSize) { this.input = input; this.output = output; diff --git a/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java b/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java index 7e787c042c..bfd4a0d085 100644 --- a/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/RegistryUtil.java @@ -51,13 +51,21 @@ import java.util.Scanner; * * @author Sebastian Sdorra */ -public class RegistryUtil +public final class RegistryUtil { /** the logger for RegistryUtil */ private static final Logger logger = LoggerFactory.getLogger(RegistryUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private RegistryUtil() {} + //~--- get methods ---------------------------------------------------------- /** @@ -98,7 +106,7 @@ public class RegistryUtil * @return */ public static String getRegistryValue(String key, String subKey, - String defaultValue) + String defaultValue) { String value = defaultValue; SimpleCommand command = null; diff --git a/scm-core/src/main/java/sonia/scm/util/SecurityUtil.java b/scm-core/src/main/java/sonia/scm/util/SecurityUtil.java index d8bf4c40d7..dd41afd9d5 100644 --- a/scm-core/src/main/java/sonia/scm/util/SecurityUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/SecurityUtil.java @@ -50,9 +50,17 @@ import sonia.scm.user.User; * * @author Sebastian Sdorra */ -public class SecurityUtil +public final class SecurityUtil { + /** + * Constructs ... + * + */ + private SecurityUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * diff --git a/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java b/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java index 3d87256eb6..138345bb05 100644 --- a/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/ServiceUtil.java @@ -44,9 +44,17 @@ import java.util.ServiceLoader; * * @author Sebastian Sdorra */ -public class ServiceUtil +public final class ServiceUtil { + /** + * Constructs ... + * + */ + private ServiceUtil() {} + + //~--- get methods ---------------------------------------------------------- + /** * Method description * diff --git a/scm-core/src/main/java/sonia/scm/util/SystemUtil.java b/scm-core/src/main/java/sonia/scm/util/SystemUtil.java index f41479c80e..df30ca77f6 100644 --- a/scm-core/src/main/java/sonia/scm/util/SystemUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/SystemUtil.java @@ -43,7 +43,7 @@ import sonia.scm.ServletContainerDetector; * * @author Sebastian Sdorra */ -public class SystemUtil +public final class SystemUtil { /** Field description */ @@ -58,13 +58,20 @@ public class SystemUtil /** Field description */ private static Platform platform = new Platform(System.getProperty(PROPERTY_OSNAME), - System.getProperty(PROPERTY_ARCH), - System.getProperty(PROPERTY_OSARCH)); + System.getProperty(PROPERTY_ARCH), System.getProperty(PROPERTY_OSARCH)); /** Field description */ private static ServletContainer servletContainer = ServletContainerDetector.detect(); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private SystemUtil() {} + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-core/src/main/java/sonia/scm/util/Util.java b/scm-core/src/main/java/sonia/scm/util/Util.java index bfa109f4ec..5dd6ac4a6a 100644 --- a/scm-core/src/main/java/sonia/scm/util/Util.java +++ b/scm-core/src/main/java/sonia/scm/util/Util.java @@ -55,7 +55,7 @@ import java.util.TimeZone; * * @author Sebastian Sdorra */ -public class Util +public final class Util { /** Field description */ @@ -64,6 +64,14 @@ public class Util /** Field description */ public static final String EMPTY_STRING = ""; + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private Util() {} + //~--- methods -------------------------------------------------------------- /** @@ -107,7 +115,7 @@ public class Util * @return */ public static boolean containsOne(Collection collection, - Collection other) + Collection other) { boolean result = false; @@ -198,7 +206,7 @@ public class Util * @since 1.4 */ public static Collection createSubCollection(Collection values, - Comparator comparator, int start, int limit) + Comparator comparator, int start, int limit) { return createSubCollection(values, comparator, null, start, limit); } @@ -216,7 +224,7 @@ public class Util * @since 1.4 */ public static Collection createSubCollection(Collection values, - int start, int limit) + int start, int limit) { return createSubCollection(values, null, null, start, limit); } @@ -235,7 +243,7 @@ public class Util * @since 1.4 */ public static Collection createSubCollection(Collection values, - CollectionAppender appender, int start, int limit) + CollectionAppender appender, int start, int limit) { return createSubCollection(values, null, appender, start, limit); } @@ -256,8 +264,8 @@ public class Util * @since 1.4 */ public static Collection createSubCollection(Collection values, - Comparator comparator, CollectionAppender appender, int start, - int limit) + Comparator comparator, CollectionAppender appender, int start, + int limit) { List result = new ArrayList(); List valueList = new ArrayList(values); @@ -356,8 +364,8 @@ public class Util public static String nonNull(Object value) { return (value != null) - ? value.toString() - : ""; + ? value.toString() + : ""; } /** @@ -372,7 +380,7 @@ public class Util * @throws ParseException */ public static Date parseDate(String dateString, TimeZone tz) - throws ParseException + throws ParseException { SimpleDateFormat sdf = new SimpleDateFormat(DATE_PATTERN); @@ -407,13 +415,13 @@ public class Util * @param start * * @return - * + * * @since 1.17 */ public static boolean startWithIgnoreCase(String value, String start) { return (value != null) && (start != null) - && value.toUpperCase(Locale.ENGLISH).startsWith(start); + && value.toUpperCase(Locale.ENGLISH).startsWith(start); } /** @@ -584,8 +592,8 @@ public class Util public static boolean isEquals(Object object, Object other) { return (object == null) - ? other == null - : object.equals(other); + ? other == null + : object.equals(other); } /** diff --git a/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java b/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java index 7456a1232a..0b1a23f7bb 100644 --- a/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/ValidationUtil.java @@ -47,7 +47,7 @@ import java.util.regex.Pattern; * * @author Sebastian Sdorra */ -public class ValidationUtil +public final class ValidationUtil { /** Field description */ @@ -65,6 +65,14 @@ public class ValidationUtil private static final String REGEX_USERNAME = "^[A-z0-9\\.\\-_@]|[^ ]([A-z0-9\\.\\-_@ ]*[A-z0-9\\.\\-_@]|[^ ])?$"; + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private ValidationUtil() {} + //~--- get methods ---------------------------------------------------------- /** @@ -116,7 +124,7 @@ public class ValidationUtil * @return */ public static boolean isNotContaining(String value, - String... notAllowedStrings) + String... notAllowedStrings) { boolean result = Util.isNotEmpty(value); diff --git a/scm-core/src/main/java/sonia/scm/util/WebUtil.java b/scm-core/src/main/java/sonia/scm/util/WebUtil.java index fad065ef66..352170c76a 100644 --- a/scm-core/src/main/java/sonia/scm/util/WebUtil.java +++ b/scm-core/src/main/java/sonia/scm/util/WebUtil.java @@ -29,6 +29,8 @@ * */ + + package sonia.scm.util; //~--- non-JDK imports -------------------------------------------------------- @@ -56,7 +58,7 @@ import javax.servlet.http.HttpServletResponse; * @author Sebastian Sdorra * @since 1.15 */ -public class WebUtil +public final class WebUtil { /** Field description */ @@ -110,6 +112,14 @@ public class WebUtil /** Field description */ private static final Logger logger = LoggerFactory.getLogger(WebUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private WebUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -146,7 +156,7 @@ public class WebUtil * @param seconds */ public static void addStaticCacheControls(HttpServletResponse response, - long seconds) + long seconds) { long time = new Date().getTime(); @@ -199,7 +209,7 @@ public class WebUtil public static String getETag(File file) { return new StringBuilder("W/\"").append(file.length()).append( - file.lastModified()).append("\"").toString(); + file.lastModified()).append("\"").toString(); } /** @@ -280,7 +290,7 @@ public class WebUtil Date modifiedSince = getIfModifiedSinceDate(request); if ((modifiedSince != null) - && (modifiedSince.getTime() == file.lastModified())) + && (modifiedSince.getTime() == file.lastModified())) { result = false; } @@ -290,7 +300,7 @@ public class WebUtil String inmEtag = request.getHeader(HEADER_INM); if ((inmEtag != null) && (inmEtag.length() > 0) - && inmEtag.equals(getETag(file))) + && inmEtag.equals(getETag(file))) { result = false; } diff --git a/scm-dao-orientdb/src/main/java/sonia/scm/orientdb/OrientDBUtil.java b/scm-dao-orientdb/src/main/java/sonia/scm/orientdb/OrientDBUtil.java index 030be2ba97..02ccb6066b 100644 --- a/scm-dao-orientdb/src/main/java/sonia/scm/orientdb/OrientDBUtil.java +++ b/scm-dao-orientdb/src/main/java/sonia/scm/orientdb/OrientDBUtil.java @@ -30,6 +30,7 @@ */ + package sonia.scm.orientdb; //~--- non-JDK imports -------------------------------------------------------- @@ -54,7 +55,7 @@ import java.util.List; * * @author Sebastian Sdorra */ -public class OrientDBUtil +public final class OrientDBUtil { /** Field description */ @@ -66,6 +67,14 @@ public class OrientDBUtil private static final Logger logger = LoggerFactory.getLogger(OrientDBUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private OrientDBUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -93,7 +102,7 @@ public class OrientDBUtil * @return */ public static List executeListResultQuery( - ODatabaseDocumentTx connection, String query, Object... parameters) + ODatabaseDocumentTx connection, String query, Object... parameters) { if (logger.isTraceEnabled()) { @@ -118,7 +127,7 @@ public class OrientDBUtil * @return */ public static ODocument executeSingleResultQuery( - ODatabaseDocumentTx connection, String query, Object... parameters) + ODatabaseDocumentTx connection, String query, Object... parameters) { if (logger.isTraceEnabled()) { @@ -152,7 +161,7 @@ public class OrientDBUtil * @return */ public static List transformToDocuments( - Converter converter, List items) + Converter converter, List items) { List docs = null; @@ -175,14 +184,14 @@ public class OrientDBUtil * @return */ public static List transformToItems(Converter converter, - List docs) + List docs) { List items = null; if (Util.isNotEmpty(docs)) { items = Lists.transform(docs, - new DocumentConverterFunction(converter)); + new DocumentConverterFunction(converter)); } return items; @@ -200,7 +209,7 @@ public class OrientDBUtil * @author Enter your name here... */ private static class DocumentConverterFunction - implements Function + implements Function { /** @@ -248,7 +257,7 @@ public class OrientDBUtil * @author Enter your name here... */ private static class ItemConverterFunction - implements Function + implements Function { /** diff --git a/scm-plugin-backend/src/main/java/sonia/scm/plugin/PluginUtil.java b/scm-plugin-backend/src/main/java/sonia/scm/plugin/PluginUtil.java index 098577f9dc..4d536e28c2 100644 --- a/scm-plugin-backend/src/main/java/sonia/scm/plugin/PluginUtil.java +++ b/scm-plugin-backend/src/main/java/sonia/scm/plugin/PluginUtil.java @@ -48,9 +48,17 @@ import java.util.List; * * @author Sebastian Sdorra */ -public class PluginUtil +public final class PluginUtil { + /** + * Constructs ... + * + */ + private PluginUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * diff --git a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java index 6cd837e6b3..68dd877d39 100644 --- a/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java +++ b/scm-plugins/scm-git-plugin/src/main/java/sonia/scm/repository/GitUtil.java @@ -63,7 +63,7 @@ import java.util.Map; * * @author Sebastian Sdorra */ -public class GitUtil +public final class GitUtil { /** Field description */ @@ -84,6 +84,14 @@ public class GitUtil /** the logger for GitUtil */ private static final Logger logger = LoggerFactory.getLogger(GitUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private GitUtil() {} + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java index aa86779b7c..dc2793a8a0 100644 --- a/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java +++ b/scm-plugins/scm-hg-plugin/src/main/java/sonia/scm/web/HgUtil.java @@ -48,12 +48,20 @@ import java.io.File; * * @author Sebastian Sdorra */ -public class HgUtil +public final class HgUtil { /** Field description */ public static final String REVISION_TIP = "tip"; + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private HgUtil() {} + //~--- get methods ---------------------------------------------------------- /** diff --git a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java index 60e9876ff8..bccdac50e3 100644 --- a/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java +++ b/scm-plugins/scm-hg-plugin/src/test/java/sonia/scm/repository/HgTestUtil.java @@ -30,6 +30,7 @@ */ + package sonia.scm.repository; //~--- non-JDK imports -------------------------------------------------------- @@ -40,9 +41,17 @@ import org.junit.Assume; * * @author Sebastian Sdorra */ -public class HgTestUtil +public final class HgTestUtil { + /** + * Constructs ... + * + */ + private HgTestUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * @@ -51,6 +60,7 @@ public class HgTestUtil */ public static void checkForSkip(HgRepositoryHandler handler) { + // skip tests if hg not in path if (!handler.isConfigured()) { diff --git a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java index ec28b8eff4..a303f86ade 100644 --- a/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java +++ b/scm-plugins/scm-svn-plugin/src/main/java/sonia/scm/repository/SvnUtil.java @@ -57,7 +57,7 @@ import java.util.Map; * * @author Sebastian Sdorra */ -public class SvnUtil +public final class SvnUtil { /** @@ -65,6 +65,14 @@ public class SvnUtil */ private static final Logger logger = LoggerFactory.getLogger(SvnUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private SvnUtil() {} + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-test/src/main/java/sonia/scm/util/MockUtil.java b/scm-test/src/main/java/sonia/scm/util/MockUtil.java index ab663d360a..a53c9feaba 100644 --- a/scm-test/src/main/java/sonia/scm/util/MockUtil.java +++ b/scm-test/src/main/java/sonia/scm/util/MockUtil.java @@ -67,13 +67,21 @@ import javax.servlet.http.HttpServletResponse; * * @author Sebastian Sdorra */ -public class MockUtil +public final class MockUtil { /** Field description */ private static final User ADMIN = new User("scmadmin", "SCM Admin", "scmadmin@scm.org"); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private MockUtil() {} + //~--- methods -------------------------------------------------------------- /** diff --git a/scm-webapp/src/main/java/sonia/scm/boot/BootstrapUtil.java b/scm-webapp/src/main/java/sonia/scm/boot/BootstrapUtil.java index f7cf02cd94..24cd21efd0 100644 --- a/scm-webapp/src/main/java/sonia/scm/boot/BootstrapUtil.java +++ b/scm-webapp/src/main/java/sonia/scm/boot/BootstrapUtil.java @@ -46,7 +46,7 @@ import javax.servlet.ServletContext; * * @author Sebastian Sdorra */ -public class BootstrapUtil +public final class BootstrapUtil { /** Field description */ @@ -56,6 +56,14 @@ public class BootstrapUtil private static final Logger logger = LoggerFactory.getLogger(BootstrapUtil.class); + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private BootstrapUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -96,7 +104,7 @@ public class BootstrapUtil * @return */ public static T loadClass(ClassLoader classLoader, Class clazz, - String className) + String className) { T instance = null; @@ -164,7 +172,7 @@ public class BootstrapUtil * @param classLoader */ public static void setClassLoader(ServletContext context, - ClassLoader classLoader) + ClassLoader classLoader) { context.setAttribute(CLASSLOADER, classLoader); } diff --git a/scm-webapp/src/main/java/sonia/scm/util/ScmConfigurationUtil.java b/scm-webapp/src/main/java/sonia/scm/util/ScmConfigurationUtil.java index 1c4fd46d7e..1a75bdacdc 100644 --- a/scm-webapp/src/main/java/sonia/scm/util/ScmConfigurationUtil.java +++ b/scm-webapp/src/main/java/sonia/scm/util/ScmConfigurationUtil.java @@ -56,7 +56,7 @@ import javax.xml.bind.Unmarshaller; * * @author Sebastian Sdorra */ -public class ScmConfigurationUtil +public final class ScmConfigurationUtil { /** Field description */ @@ -72,13 +72,13 @@ public class ScmConfigurationUtil * Constructs ... * */ - public ScmConfigurationUtil() + private ScmConfigurationUtil() { try { context = JAXBContext.newInstance(ScmConfiguration.class); file = new File(SCMContext.getContext().getBaseDirectory(), - ScmConfiguration.PATH); + ScmConfiguration.PATH); } catch (JAXBException ex) { diff --git a/scm-webapp/src/main/java/sonia/scm/web/security/SecurityUtil.java b/scm-webapp/src/main/java/sonia/scm/web/security/SecurityUtil.java index e5b7f72e7e..1528eabc8e 100644 --- a/scm-webapp/src/main/java/sonia/scm/web/security/SecurityUtil.java +++ b/scm-webapp/src/main/java/sonia/scm/web/security/SecurityUtil.java @@ -42,12 +42,20 @@ import sonia.scm.SCMContext; /** * * @author Sebastian Sdorra - * @deprecated + * @deprecated */ @Deprecated -public class SecurityUtil +public final class SecurityUtil { + /** + * Constructs ... + * + */ + private SecurityUtil() {} + + //~--- get methods ---------------------------------------------------------- + /** * Method description * @@ -57,7 +65,7 @@ public class SecurityUtil * @return */ public static String getUsername( - Provider securityContextProvider) + Provider securityContextProvider) { return getUsername(securityContextProvider.get()); } diff --git a/scm-webapp/src/test/java/sonia/scm/it/IntegrationTestUtil.java b/scm-webapp/src/test/java/sonia/scm/it/IntegrationTestUtil.java index 8dc9a1b19d..5d4b1fbe48 100644 --- a/scm-webapp/src/test/java/sonia/scm/it/IntegrationTestUtil.java +++ b/scm-webapp/src/test/java/sonia/scm/it/IntegrationTestUtil.java @@ -68,7 +68,7 @@ import javax.ws.rs.core.MultivaluedMap; * * @author Sebastian Sdorra */ -public class IntegrationTestUtil +public final class IntegrationTestUtil { /** Field description */ @@ -83,6 +83,14 @@ public class IntegrationTestUtil /** Field description */ public static final String EXTENSION = ".xml"; + //~--- constructors --------------------------------------------------------- + + /** + * Constructs ... + * + */ + private IntegrationTestUtil() {} + //~--- methods -------------------------------------------------------------- /** @@ -96,7 +104,7 @@ public class IntegrationTestUtil * @return */ public static ClientResponse authenticate(Client client, String username, - String password) + String password) { WebResource wr = createResource(client, "authentication/login"); MultivaluedMap formData = new MultivaluedMapImpl(); @@ -105,7 +113,7 @@ public class IntegrationTestUtil formData.add("password", password); return wr.type("application/x-www-form-urlencoded").post( - ClientResponse.class, formData); + ClientResponse.class, formData); } /** @@ -165,7 +173,7 @@ public class IntegrationTestUtil DefaultApacheHttpClientConfig config = new DefaultApacheHttpClientConfig(); config.getProperties().put(ApacheHttpClientConfig.PROPERTY_HANDLE_COOKIES, - true); + true); return ApacheHttpClient.create(config); } @@ -181,7 +189,7 @@ public class IntegrationTestUtil * @throws RepositoryClientException */ public static void createRandomFile(RepositoryClient client) - throws IOException, RepositoryClientException + throws IOException, RepositoryClientException { String uuid = UUID.randomUUID().toString(); String name = "file-" + uuid + ".uuid"; @@ -257,7 +265,7 @@ public class IntegrationTestUtil public static File createTempDirectory() { File directory = new File(System.getProperty("java.io.tmpdir"), - UUID.randomUUID().toString()); + UUID.randomUUID().toString()); IOUtil.mkdirs(directory); diff --git a/scm-webapp/src/test/java/sonia/scm/it/RepositoryITUtil.java b/scm-webapp/src/test/java/sonia/scm/it/RepositoryITUtil.java index bc80e98546..70d53ff296 100644 --- a/scm-webapp/src/test/java/sonia/scm/it/RepositoryITUtil.java +++ b/scm-webapp/src/test/java/sonia/scm/it/RepositoryITUtil.java @@ -51,9 +51,17 @@ import com.sun.jersey.api.client.WebResource; * * @author Sebastian Sdorra */ -public class RepositoryITUtil +public final class RepositoryITUtil { + /** + * Constructs ... + * + */ + private RepositoryITUtil() {} + + //~--- methods -------------------------------------------------------------- + /** * Method description * @@ -62,7 +70,7 @@ public class RepositoryITUtil * @param other */ public static void assertRepositoriesEquals(Repository repository, - Repository other) + Repository other) { assertEquals(repository.getName(), other.getName()); assertEquals(repository.getDescription(), other.getDescription()); @@ -82,7 +90,7 @@ public class RepositoryITUtil * @return */ public static Repository createRepository(Client client, - Repository repository) + Repository repository) { WebResource wr = createResource(client, "repositories"); ClientResponse response = wr.post(ClientResponse.class, repository);