util classes should be final with a private constructor

This commit is contained in:
Sebastian Sdorra
2013-01-31 10:26:16 +01:00
parent 2d5fa22ca4
commit 9adc65d9e5
34 changed files with 393 additions and 134 deletions

View File

@@ -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
*

View File

@@ -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

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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
*

View File

@@ -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

View File

@@ -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());

View File

@@ -50,9 +50,17 @@ import java.util.Locale;
*
* @author Sebastian Sdorra
*/
public class SearchUtil
public final class SearchUtil
{
/**
* Constructs ...
*
*/
private SearchUtil() {}
//~--- methods --------------------------------------------------------------
/**
* Method description
*

View File

@@ -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 ...
*
@@ -75,13 +73,6 @@ public class CipherUtil
}
}
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;
}

View File

@@ -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
*

View File

@@ -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
*

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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.
*

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -65,7 +65,7 @@ import java.util.Locale;
*
* @author Sebastian Sdorra
*/
public class IOUtil
public final class IOUtil
{
/** Field description */
@@ -103,6 +103,14 @@ public class IOUtil
private static final Logger logger =
LoggerFactory.getLogger(IOUtil.class.getName());
//~--- constructors ---------------------------------------------------------
/**
* Constructs ...
*
*/
private IOUtil() {}
//~--- methods --------------------------------------------------------------
/**

View File

@@ -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 ----------------------------------------------------------
/**

View File

@@ -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
*

View File

@@ -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
*

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 ----------------------------------------------------------
/**

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -48,9 +48,17 @@ import java.util.List;
*
* @author Sebastian Sdorra
*/
public class PluginUtil
public final class PluginUtil
{
/**
* Constructs ...
*
*/
private PluginUtil() {}
//~--- methods --------------------------------------------------------------
/**
* Method description
*

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 ----------------------------------------------------------
/**

View File

@@ -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())
{

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -56,7 +56,7 @@ import javax.xml.bind.Unmarshaller;
*
* @author Sebastian Sdorra
*/
public class ScmConfigurationUtil
public final class ScmConfigurationUtil
{
/** Field description */
@@ -72,7 +72,7 @@ public class ScmConfigurationUtil
* Constructs ...
*
*/
public ScmConfigurationUtil()
private ScmConfigurationUtil()
{
try
{

View File

@@ -45,9 +45,17 @@ import sonia.scm.SCMContext;
* @deprecated
*/
@Deprecated
public class SecurityUtil
public final class SecurityUtil
{
/**
* Constructs ...
*
*/
private SecurityUtil() {}
//~--- get methods ----------------------------------------------------------
/**
* Method description
*

View File

@@ -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 --------------------------------------------------------------
/**

View File

@@ -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
*