Revise LuceneLockName as enum per review

Author: idodeclare

src/org/opensolaris/opengrok/configuration/Configuration.java

@@ -19,7 +19,7 @@
 
  /*
  * Copyright (c) 2007, 2017, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.configuration;
 
@@ -179,7 +179,7 @@ public final class Configuration {
      */
     @Deprecated
     private boolean usingLuceneLocking;
-    private String luceneLocking = LuceneLockName.OFF;
+    private LuceneLockName luceneLocking = LuceneLockName.OFF;
     private boolean compressXref;
     private boolean indexVersionedFilesOnly;
     private int indexingParallelism;
@@ -407,6 +407,7 @@ public Configuration() {
         setIncludedNames(new Filter());
         setIndexVersionedFilesOnly(false);
         setLastEditedDisplayMode(true);
+        //luceneLocking default is OFF
         setMandoc(System.getProperty("org.opensolaris.opengrok.analysis.Mandoc", null));
         setMaxSearchThreadCount(2 * Runtime.getRuntime().availableProcessors());
         setMessageLimit(500);
@@ -942,15 +943,15 @@ public void setUsingLuceneLocking(boolean useLuceneLocking) {
             LuceneLockName.OFF);
     }
 
-    public String getLuceneLocking() {
+    public LuceneLockName getLuceneLocking() {
         return luceneLocking;
     }
 
     /**
      * @param value off|on|simple|native where "on" is an alias for "simple".
      * Any other value is a fallback alias for "off" (with a logged warning).
      */
-    public void setLuceneLocking(String value) {
+    public void setLuceneLocking(LuceneLockName value) {
         this.luceneLocking = value;
         // Set the following to default(boolean) regardless of `value'.
         this.usingLuceneLocking = false;

src/org/opensolaris/opengrok/configuration/LuceneLockName.java

@@ -18,24 +18,20 @@
  */
 
 /*
- * Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 
 package org.opensolaris.opengrok.configuration;
 
 /**
  * Represents a container for OpenGrok's names of Lucene lock modes.
  */
-public class LuceneLockName {
-    public static final String OFF = "off";
+public enum LuceneLockName {
+    OFF,
     /**
      * An alias for {@link #SIMPLE}
      */
-    public static final String ON = "on";
-    public static final String SIMPLE = "simple";
-    public static final String NATIVE = "native";
-
-    /** private to enforce static */
-    private LuceneLockName() {
-    }
+    ON,
+    SIMPLE,
+    NATIVE
 }

src/org/opensolaris/opengrok/configuration/RuntimeEnvironment.java

@@ -19,7 +19,7 @@
 
  /*
   * Copyright (c) 2006, 2017, Oracle and/or its affiliates. All rights reserved.
-  * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+  * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
   */
 package org.opensolaris.opengrok.configuration;
 
@@ -1047,7 +1047,7 @@ public void setOptimizeDatabase(boolean optimizeDatabase) {
         threadConfig.get().setOptimizeDatabase(optimizeDatabase);
     }
 
-    public String getLuceneLocking() {
+    public LuceneLockName getLuceneLocking() {
         return threadConfig.get().getLuceneLocking();
     }
 

src/org/opensolaris/opengrok/index/IndexDatabase.java

@@ -19,7 +19,7 @@
 
 /*
  * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.index;
 
@@ -1417,18 +1417,14 @@ private Writer getXrefWriter(FileAnalyzer fa, String path) throws IOException {
     }
 
     LockFactory pickLockFactory(RuntimeEnvironment env) {
-        String luceneLocking = env.getLuceneLocking();
-        switch (luceneLocking) {
-            case LuceneLockName.OFF:
-                return NoLockFactory.INSTANCE;
-            case LuceneLockName.ON:
-            case LuceneLockName.SIMPLE:
+        switch (env.getLuceneLocking()) {
+            case ON:
+            case SIMPLE:
                 return SimpleFSLockFactory.INSTANCE;
-            case LuceneLockName.NATIVE:
+            case NATIVE:
                 return NativeFSLockFactory.INSTANCE;
+            case OFF:
             default:
-                LOGGER.log(Level.WARNING, "Unknown Lucene locking mode: {0}",
-                    luceneLocking);
                 return NoLockFactory.INSTANCE;
         }
     }

src/org/opensolaris/opengrok/index/Indexer.java

@@ -20,7 +20,7 @@
 /*
  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright 2011 Jens Elkner.
- * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.index;
 
@@ -34,6 +34,7 @@
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
@@ -341,9 +342,7 @@ public static String[] parseOptions(String[] argv) throws ParseException {
         String program = "opengrok.jar";
         final String[] ON_OFF = {ON, OFF};
         final String[] REMOTE_REPO_CHOICES = {ON, OFF, DIRBASED, UIONLY};
-        final String[] LUCENE_LOCKS = {LuceneLockName.ON,
-            LuceneLockName.OFF, LuceneLockName.SIMPLE,
-            LuceneLockName.NATIVE};
+        final String[] LUCENE_LOCKS = {ON, OFF, "simple", "native"};
 
         if (argv.length == 0) {
             argv = usage;  // will force usage output
@@ -474,7 +473,15 @@ public static String[] parseOptions(String[] argv) throws ParseException {
                 "Set OpenGrok/Lucene locking mode of the Lucene database",
                 "during index generation. \"on\" is an alias for \"simple\".",
                 "Default is off.").Do( v -> {
-                cfg.setLuceneLocking((String)v);
+                try {
+                    if (v != null) {
+                        String vuc = v.toString().toUpperCase(Locale.ROOT);
+                        cfg.setLuceneLocking(LuceneLockName.valueOf(vuc));
+                    }
+                } catch (IllegalArgumentException e) {
+                    System.err.println(String.format(
+                        "`--lock %s' is invalid and ignored", v));
+                }
             });
 
             parser.on("--leadingWildCards", "=on|off", ON_OFF, Boolean.class,

test/org/opensolaris/opengrok/configuration/RuntimeEnvironmentTest.java

@@ -19,7 +19,7 @@
 
  /*
  * Copyright (c) 2008, 2017, Oracle and/or its affiliates. All rights reserved.
- * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ * Portions Copyright (c) 2017-2018, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.configuration;
 
@@ -439,7 +439,7 @@ public void testOptimizeDatabase() {
     @Test
     public void testUsingLuceneLocking() {
         RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
-        assertEquals("off", instance.getLuceneLocking());
+        assertEquals(LuceneLockName.OFF, instance.getLuceneLocking());
     }
 
     @Test