You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-commits@db.apache.org by mb...@apache.org on 2023/01/08 18:04:02 UTC

[db-jdo] 04/18: JDO-823: String literals should not be duplicated

This is an automated email from the ASF dual-hosted git repository.

mbo pushed a commit to branch JDO-823-2
in repository https://gitbox.apache.org/repos/asf/db-jdo.git

commit 02151c2328827c247d340d2b57083de011b2aa4f
Author: Michael Bouschen <Mi...@akquinet.de>
AuthorDate: Sat Jan 7 20:36:24 2023 +0100

    JDO-823: String literals should not be duplicated
---
 api/src/main/java/javax/jdo/Enhancer.java          | 37 ++++++++++---------
 api/src/main/java/javax/jdo/JDOHelper.java         |  8 +++--
 api/src/main/java/javax/jdo/spi/JDOImplHelper.java |  8 +++--
 .../main/java/org/apache/jdo/exectck/Enhance.java  | 41 ++++++++++++++--------
 .../java/org/apache/jdo/exectck/InstallSchema.java |  8 +++--
 .../main/java/org/apache/jdo/exectck/RunTCK.java   | 14 ++++----
 6 files changed, 70 insertions(+), 46 deletions(-)

diff --git a/api/src/main/java/javax/jdo/Enhancer.java b/api/src/main/java/javax/jdo/Enhancer.java
index d8dd9c6c..2b3394d1 100644
--- a/api/src/main/java/javax/jdo/Enhancer.java
+++ b/api/src/main/java/javax/jdo/Enhancer.java
@@ -85,6 +85,11 @@ public class Enhancer {
   /** Class file suffix */
   private static final String CLASS_FILE_SUFFIX = ".class"; // NOI18N
 
+  private static final String MSG_ENHANCER_CLASS_PATH = "MSG_EnhancerClassPath";
+  private static final String MSG_ENHANCER_PROCESSING = "MSG_EnhancerProcessing";
+  private static final String MSG_ENHANCER_PROPERTY = "MSG_EnhancerProperty";
+  private static final String MSG_ENHANCER_USAGE = "MSG_EnhancerUsage";
+
   /** Error indicator */
   private boolean error = false;
   /** If set, process parameters, print usage, and exit. */
@@ -155,11 +160,11 @@ public class Enhancer {
       properties = enhancer.getProperties();
       addVerboseMessage("MSG_EnhancerClass", enhancer.getClass().getName()); // NOI18N
       addVerboseMessage(
-          "MSG_EnhancerProperty",
+          MSG_ENHANCER_PROPERTY,
           PROPERTY_ENHANCER_VENDOR_NAME, // NOI18N
           properties.getProperty(PROPERTY_ENHANCER_VENDOR_NAME));
       addVerboseMessage(
-          "MSG_EnhancerProperty",
+          MSG_ENHANCER_PROPERTY,
           PROPERTY_ENHANCER_VERSION_NUMBER, // NOI18N
           properties.getProperty(PROPERTY_ENHANCER_VERSION_NUMBER));
       Set<Entry<Object, Object>> props = properties.entrySet();
@@ -167,7 +172,7 @@ public class Enhancer {
         if (!(PROPERTY_ENHANCER_VENDOR_NAME.equals(entry.getKey())
             || PROPERTY_ENHANCER_VERSION_NUMBER.equals(entry.getKey()))) {
           addVerboseMessage(
-              "MSG_EnhancerProperty",
+              MSG_ENHANCER_PROPERTY,
               (String) entry.getKey(), // NOI18N
               (String) entry.getValue());
         }
@@ -222,11 +227,11 @@ public class Enhancer {
     parseFiles(fileNames.toArray(new String[fileNames.size()]), true, recurse);
     loader = prepareClassLoader(classPath);
     if (error) {
-      addErrorMessage(msg.msg("MSG_EnhancerUsage")); // NOI18N
+      addErrorMessage(msg.msg(MSG_ENHANCER_USAGE)); // NOI18N
       exit(ENHANCER_USAGE_ERROR); // error exit
     }
     if (printAndExit) {
-      addVerboseMessage("MSG_EnhancerUsage"); // NOI18N
+      addVerboseMessage(MSG_ENHANCER_USAGE); // NOI18N
       exit(0); // good exit
     }
   }
@@ -250,19 +255,19 @@ public class Enhancer {
         if (arg.startsWith("-")) { // NOI18N
           String option = arg.substring(1);
           if ("help".equals(option)) { // NOI18N
-            addVerboseMessage("MSG_EnhancerProcessing", "-help"); // NOI18N
+            addVerboseMessage(MSG_ENHANCER_PROCESSING, "-help"); // NOI18N
             setPrintAndExit();
           } else if ("h".equals(option)) { // NOI18N
-            addVerboseMessage("MSG_EnhancerProcessing", "-h"); // NOI18N
+            addVerboseMessage(MSG_ENHANCER_PROCESSING, "-h"); // NOI18N
             setPrintAndExit();
           } else if ("v".equals(option)) { // NOI18N
-            addVerboseMessage("MSG_EnhancerProcessing", "-v"); // NOI18N
+            addVerboseMessage(MSG_ENHANCER_PROCESSING, "-v"); // NOI18N
             verbose = true;
           } else if ("verbose".equals(option)) { // NOI18N
-            addVerboseMessage("MSG_EnhancerProcessing", "-verbose"); // NOI18N
+            addVerboseMessage(MSG_ENHANCER_PROCESSING, "-verbose"); // NOI18N
             verbose = true;
           } else if ("pu".equals(option)) { // NOI18N
-            if (hasNextArgument("MSG_EnhancerProcessing", "-pu", i, args.length)) { // NOI18N
+            if (hasNextArgument(MSG_ENHANCER_PROCESSING, "-pu", i, args.length)) { // NOI18N
               String puName = args[++i];
               addVerboseMessage("MSG_EnhancerPersistenceUnitName", puName); // NOI18N
               persistenceUnitNames.add(puName);
@@ -270,24 +275,24 @@ public class Enhancer {
               setError();
             }
           } else if ("cp".equals(option)) { // NOI18N
-            if (hasNextArgument("MSG_EnhancerProcessing", "-cp", i, args.length)) { // NOI18N
+            if (hasNextArgument(MSG_ENHANCER_PROCESSING, "-cp", i, args.length)) { // NOI18N
               classPath = args[++i];
-              addVerboseMessage("MSG_EnhancerClassPath", classPath); // NOI18N
+              addVerboseMessage(MSG_ENHANCER_CLASS_PATH, classPath); // NOI18N
             } else {
               setError();
             }
           } else if ("d".equals(option)) { // NOI18N
-            if (hasNextArgument("MSG_EnhancerProcessing", "-d", i, args.length)) { // NOI18N
+            if (hasNextArgument(MSG_ENHANCER_PROCESSING, "-d", i, args.length)) { // NOI18N
               directoryName = args[++i];
               addVerboseMessage("MSG_EnhancerOutputDirectory", directoryName); // NOI18N
             } else {
               setError();
             }
           } else if ("checkonly".equals(option)) { // NOI18N
-            addVerboseMessage("MSG_EnhancerProcessing", "-checkonly"); // NOI18N
+            addVerboseMessage(MSG_ENHANCER_PROCESSING, "-checkonly"); // NOI18N
             checkOnly = true;
           } else if ("r".equals(option)) { // NOI18N
-            addVerboseMessage("MSG_EnhancerProcessing", "-r"); // NOI18N
+            addVerboseMessage(MSG_ENHANCER_PROCESSING, "-r"); // NOI18N
             recurse = true;
           } else {
             setError();
@@ -386,7 +391,7 @@ public class Enhancer {
       URI uri = file.toURI();
       try {
         URL url = uri.toURL();
-        addVerboseMessage("MSG_EnhancerClassPath", url.toString());
+        addVerboseMessage(MSG_ENHANCER_CLASS_PATH, url.toString());
         urls.add(url);
       } catch (MalformedURLException e) {
         setError();
diff --git a/api/src/main/java/javax/jdo/JDOHelper.java b/api/src/main/java/javax/jdo/JDOHelper.java
index 87dd3fbc..e28bf1eb 100644
--- a/api/src/main/java/javax/jdo/JDOHelper.java
+++ b/api/src/main/java/javax/jdo/JDOHelper.java
@@ -87,6 +87,8 @@ public class JDOHelper implements Constants {
   /** The Internationalization message helper. */
   private static final I18NHelper MSG = I18NHelper.getInstance("javax.jdo.Bundle"); // NOI18N
 
+  private static final String EXC_GET_PMF_IOEXCEPTION_RSRC = "EXC_GetPMFIOExceptionRsrc";
+
   /**
    * Creates a map from jdoconfig.xsd element attributes to PMF properties.
    *
@@ -1098,7 +1100,7 @@ public class JDOHelper implements Constants {
         props.load(in);
       }
     } catch (IOException ioe) {
-      throw new JDOFatalUserException(MSG.msg("EXC_GetPMFIOExceptionRsrc", name), ioe); // NOI18N
+      throw new JDOFatalUserException(MSG.msg(EXC_GET_PMF_IOEXCEPTION_RSRC, name), ioe); // NOI18N
     } finally {
       if (in != null) {
         try {
@@ -1186,7 +1188,7 @@ public class JDOHelper implements Constants {
     } catch (FactoryConfigurationError e) {
       throw new JDOFatalUserException(MSG.msg("ERR_NoDocumentBuilderFactory"), e);
     } catch (IOException ioe) {
-      throw new JDOFatalUserException(MSG.msg("EXC_GetPMFIOExceptionRsrc", name), ioe); // NOI18N
+      throw new JDOFatalUserException(MSG.msg(EXC_GET_PMF_IOEXCEPTION_RSRC, name), ioe); // NOI18N
     }
 
     // done with reading all config resources;
@@ -1337,7 +1339,7 @@ public class JDOHelper implements Constants {
       return propertiesByName;
     } catch (IOException ioe) {
       throw new JDOFatalUserException(
-          MSG.msg("EXC_GetPMFIOExceptionRsrc", url.toString()), ioe); // NOI18N
+          MSG.msg(EXC_GET_PMF_IOEXCEPTION_RSRC, url.toString()), ioe); // NOI18N
     } catch (ParserConfigurationException e) {
       throw new JDOFatalInternalException(MSG.msg("EXC_ParserConfigException"), e);
     } catch (SAXParseException e) {
diff --git a/api/src/main/java/javax/jdo/spi/JDOImplHelper.java b/api/src/main/java/javax/jdo/spi/JDOImplHelper.java
index a6c84bef..022c92f0 100644
--- a/api/src/main/java/javax/jdo/spi/JDOImplHelper.java
+++ b/api/src/main/java/javax/jdo/spi/JDOImplHelper.java
@@ -96,6 +96,8 @@ public class JDOImplHelper extends java.lang.Object {
   /** The Internationalization message helper. */
   private static final I18NHelper msg = I18NHelper.getInstance("javax.jdo.Bundle"); // NOI18N
 
+  private static final String ERR_NULL_CLASS = "ERR_NullClass";
+
   /** The DateFormat pattern. */
   private static String dateFormatPattern;
 
@@ -402,7 +404,7 @@ public class JDOImplHelper extends java.lang.Object {
       byte[] fieldFlags,
       Class<?> persistenceCapableSuperclass,
       PersistenceCapable pc) {
-    if (pcClass == null) throw new NullPointerException(msg.msg("ERR_NullClass")); // NOI18N
+    if (pcClass == null) throw new NullPointerException(msg.msg(ERR_NULL_CLASS)); // NOI18N
     Meta meta = new Meta(fieldNames, fieldTypes, fieldFlags, persistenceCapableSuperclass, pc);
     registeredClasses.put(pcClass, meta);
 
@@ -468,7 +470,7 @@ public class JDOImplHelper extends java.lang.Object {
    * @since 1.0.2
    */
   public void unregisterClass(Class<?> pcClass) {
-    if (pcClass == null) throw new NullPointerException(msg.msg("ERR_NullClass")); // NOI18N
+    if (pcClass == null) throw new NullPointerException(msg.msg(ERR_NULL_CLASS)); // NOI18N
     SecurityManager sec = LegacyJava.getSecurityManager();
     if (sec != null) {
       // throws exception if caller is not authorized
@@ -556,7 +558,7 @@ public class JDOImplHelper extends java.lang.Object {
    */
   public static void registerAuthorizedStateManagerClass(Class<?> smClass)
       throws SecurityException {
-    if (smClass == null) throw new NullPointerException(msg.msg("ERR_NullClass")); // NOI18N
+    if (smClass == null) throw new NullPointerException(msg.msg(ERR_NULL_CLASS)); // NOI18N
     SecurityManager sm = LegacyJava.getSecurityManager();
     if (sm != null) {
       sm.checkPermission(JDOPermission.SET_STATE_MANAGER);
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java b/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java
index a76a509a..1a2abd31 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/Enhance.java
@@ -40,34 +40,40 @@ import org.apache.maven.plugins.annotations.Parameter;
 @Mojo(name = "enhance")
 public class Enhance extends AbstractTCKMojo {
 
+  private static final String APACHE_DIR_NAME = "apache";
+  private static final String JDO_DIR_NAME = "jdo";
+  private static final String ENHANCED_DIR_NAME = "enhanced";
+  private static final String ORG_DIR_NAME = "org";
+  private static final String TCK_DIR_NAME = "tck";
+
   private static final String[] PC_PKG_DIRS = {
-    "org"
+    ORG_DIR_NAME
         + File.separator
-        + "apache"
+        + APACHE_DIR_NAME
         + File.separator
-        + "jdo"
+        + JDO_DIR_NAME
         + File.separator
-        + "tck"
+        + TCK_DIR_NAME
         + File.separator
         + "api"
         + File.separator,
-    "org"
+    ORG_DIR_NAME
         + File.separator
-        + "apache"
+        + APACHE_DIR_NAME
         + File.separator
-        + "jdo"
+        + JDO_DIR_NAME
         + File.separator
-        + "tck"
+        + TCK_DIR_NAME
         + File.separator
         + "pc"
         + File.separator,
-    "org"
+    ORG_DIR_NAME
         + File.separator
-        + "apache"
+        + APACHE_DIR_NAME
         + File.separator
-        + "jdo"
+        + JDO_DIR_NAME
         + File.separator
-        + "tck"
+        + TCK_DIR_NAME
         + File.separator
         + "models"
         + File.separator
@@ -100,7 +106,7 @@ public class Enhance extends AbstractTCKMojo {
     resetFileContent(implLogFile);
 
     // Create directory for enhancer logs
-    String enhanceLogsDirName = logsDirectory + File.separator + "enhanced";
+    String enhanceLogsDirName = logsDirectory + File.separator + ENHANCED_DIR_NAME;
     File enhancerLogsDir = new File(enhanceLogsDirName);
     if (!(enhancerLogsDir.exists()) && !(enhancerLogsDir.mkdirs())) {
       throw new MojoExecutionException("Failed to create directory " + enhancerLogsDir);
@@ -114,7 +120,12 @@ public class Enhance extends AbstractTCKMojo {
 
     // Create directory for enhanced classes
     String enhancedDirName =
-        buildDirectory + File.separator + "enhanced" + File.separator + impl + File.separator;
+        buildDirectory
+            + File.separator
+            + ENHANCED_DIR_NAME
+            + File.separator
+            + impl
+            + File.separator;
     File enhancedDir = new File(enhancedDirName);
     if (!(enhancedDir.exists()) && !(enhancedDir.mkdirs())) {
       throw new MojoExecutionException("Failed to create directory " + enhancedDir);
@@ -261,7 +272,7 @@ public class Enhance extends AbstractTCKMojo {
       String testLogFilename =
           logsDirectory
               + File.separator
-              + "enhanced"
+              + ENHANCED_DIR_NAME
               + File.separator
               + idname
               + "-"
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java b/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java
index a4968728..08a3d7af 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/InstallSchema.java
@@ -32,6 +32,8 @@ import org.apache.maven.plugins.annotations.Parameter;
 @Mojo(name = "installSchema")
 public class InstallSchema extends AbstractTCKMojo {
 
+  private static final String DB_DIR_NAME = "database";
+
   /** Location of TCK generated output. */
   @Parameter(property = "jdo.tck.doInstallSchema", defaultValue = "true", required = true)
   private boolean doInstallSchema;
@@ -84,14 +86,14 @@ public class InstallSchema extends AbstractTCKMojo {
 
     for (String db : dbs) {
       // Create directory for db logs
-      String dbLogsDirName = logsDirectory + File.separator + "database";
+      String dbLogsDirName = logsDirectory + File.separator + DB_DIR_NAME;
       File dbLogsDir = new File(dbLogsDirName);
       if (!(dbLogsDir.exists()) && !(dbLogsDir.mkdirs())) {
         throw new MojoExecutionException("Failed to create directory " + dbLogsDir);
       }
 
       // Create database directory
-      String dbDirName = buildDirectory + File.separator + "database" + File.separator + db;
+      String dbDirName = buildDirectory + File.separator + DB_DIR_NAME + File.separator + db;
       File dbDir = new File(dbDirName);
       if (!(dbDir.exists()) && !(dbDir.mkdirs())) {
         throw new MojoExecutionException("Failed to create directory " + dbDir);
@@ -125,7 +127,7 @@ public class InstallSchema extends AbstractTCKMojo {
           String outFileName =
               logsDirectory
                   + File.separator
-                  + "database"
+                  + DB_DIR_NAME
                   + File.separator
                   + db
                   + "_"
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java b/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
index 551945f1..d8e773ac 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
@@ -45,6 +45,8 @@ public class RunTCK extends AbstractTCKMojo {
   private static final String TCK_PARAM_ON_FAILURE_FAIL_EVENTUALLY = "failGoal";
   private static final String TCK_PARAM_ON_FAILURE_LOG_ONLY = "logOnly";
 
+  private static final String CLASSES_DIR_NAME = "classes";
+
   private static final String TCK_LOG_FILE = "tck.txt";
 
   /** To skip running of TCK, set to false. */
@@ -208,14 +210,14 @@ public class RunTCK extends AbstractTCKMojo {
         "-DPMFProperties="
             + buildDirectory
             + File.separator
-            + "classes"
+            + CLASSES_DIR_NAME
             + File.separator
             + pmfProperties);
     propsString.add(
         "-DPMF2Properties="
             + buildDirectory
             + File.separator
-            + "classes"
+            + CLASSES_DIR_NAME
             + File.separator
             + pmfProperties);
     String excludeFile = confDirectory + File.separator + exclude;
@@ -246,7 +248,7 @@ public class RunTCK extends AbstractTCKMojo {
           new File(
               buildDirectory
                   + File.separator
-                  + "classes"
+                  + CLASSES_DIR_NAME
                   + File.separator
                   + "META-INF"
                   + File.separator
@@ -257,7 +259,7 @@ public class RunTCK extends AbstractTCKMojo {
           new File(
               buildDirectory
                   + File.separator
-                  + "classes"
+                  + CLASSES_DIR_NAME
                   + File.separator
                   + "META-INF"
                   + File.separator
@@ -316,7 +318,7 @@ public class RunTCK extends AbstractTCKMojo {
         try {
           URL url1 = enhancedDir.toURI().toURL();
           URL url2 =
-              new File(buildDirectory + File.separator + "classes" + File.separator)
+              new File(buildDirectory + File.separator + CLASSES_DIR_NAME + File.separator)
                   .toURI()
                   .toURL();
           if (runtckVerbose) {
@@ -390,7 +392,7 @@ public class RunTCK extends AbstractTCKMojo {
           propsFileData.append("\njavax.jdo.option.Mapping=standard" + mapping);
           propsFileData.append("\n");
           String pmfPropsWriteFileName =
-              buildDirectory + File.separator + "classes" + File.separator + pmfProperties;
+              buildDirectory + File.separator + CLASSES_DIR_NAME + File.separator + pmfProperties;
           try {
             BufferedWriter out = new BufferedWriter(new FileWriter(pmfPropsWriteFileName, false));
             out.write(defaultPropsContents + propsFileData.toString());