remove deprecated IndexAnalysisSettings (version 1)

fixes #2290

Author: Vladimir Kotal

opengrok-indexer/src/main/java/org/opengrok/indexer/index/IndexAnalysisSettings.java

@@ -29,17 +29,19 @@
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
 import java.io.Serializable;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Represents a serializable gathering of some top-level metadata concerning the
  * operation of {@link IndexDatabase} -- and persisted therein too -- which are
  * re-compared upon each indexing run since changes to them might require
  * re-indexing particular files or in certain cases all files.
  */
-@Deprecated
 public final class IndexAnalysisSettings implements Serializable {
 
-    private static final long serialVersionUID = 1005610724146719938L;
+    private static final long serialVersionUID = 1172403004716059609L;
 
     private String projectName;
 
@@ -57,6 +59,14 @@ public final class IndexAnalysisSettings implements Serializable {
      */
     private Long analyzerGuruVersion;
 
+    /**
+     * (nullable because otherwise custom de-serialization does not work, as a
+     * {@code final} initialized value may not actually happen because Java
+     * de-serialization circumvents normal construction.)
+     * @serial
+     */
+    private Map<String, Long> analyzersVersions = new HashMap<>();
+
     /**
      * Gets the project name to be used to distinguish different instances of
      * {@link IndexAnalysisSettings} that might be returned by a Lucene
@@ -93,6 +103,32 @@ public void setAnalyzerGuruVersion(Long value) {
         this.analyzerGuruVersion = value;
     }
 
+    /**
+     * Gets the version number for the specified file type name if it exists
+     * @return a defined value or {@code null} if unknown
+     */
+    public Long getAnalyzerVersion(String fileTypeName) {
+        return analyzersVersions.get(fileTypeName);
+    }
+
+    /**
+     * Gets an unmodifiable view of the map of file type names to version
+     * numbers.
+     * @return a defined instance
+     */
+    public Map<String, Long> getAnalyzersVersions() {
+        return Collections.unmodifiableMap(analyzersVersions);
+    }
+
+    /**
+     * Replaces the contents of the instance's map with the {@code values}.
+     * @param values a defined instance
+     */
+    public void setAnalyzersVersions(Map<String, Long> values) {
+        analyzersVersions.clear();
+        analyzersVersions.putAll(values);
+    }
+
     /**
      * Creates a binary representation of this object.
      * @return a byte array representing this object
@@ -137,6 +173,20 @@ private void readObject(ObjectInputStream in) throws ClassNotFoundException,
         hasValue = in.readBoolean();
         long vlong = in.readLong();
         analyzerGuruVersion = hasValue ? vlong : null;
+
+        /**
+         * De-serialization circumvents normal construction, so the following
+         * field could be null.
+         */
+        if (analyzersVersions == null) {
+            analyzersVersions = new HashMap<>();
+        }
+        int analyzerCount = in.readInt();
+        for (int i = 0; i < analyzerCount; ++i) {
+            vstring = in.readUTF();
+            vlong = in.readLong();
+            analyzersVersions.put(vstring, vlong);
+        }
     }
 
     private void writeObject(ObjectOutputStream out) throws IOException {
@@ -148,5 +198,16 @@ private void writeObject(ObjectOutputStream out) throws IOException {
 
         out.writeBoolean(analyzerGuruVersion != null); // hasValue
         out.writeLong(analyzerGuruVersion == null ? 0 : analyzerGuruVersion);
+
+        int analyzerCount = analyzersVersions.size();
+        out.writeInt(analyzerCount);
+        for (Map.Entry<String, Long> entry : analyzersVersions.entrySet()) {
+            out.writeUTF(entry.getKey());
+            out.writeLong(entry.getValue());
+            --analyzerCount;
+        }
+        if (analyzerCount != 0) {
+            throw new IllegalStateException("analyzersVersions were modified");
+        }
     }
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/index/IndexAnalysisSettings2.java

@@ -50,7 +50,7 @@ public class IndexAnalysisSettingsAccessor {
      * {@link QueryBuilder}-normalized value for UUID
      * 58859C75-F941-42E5-8D1A-FAF71DDEBBA7
      */
-    public static final String INDEX_ANALYSIS_SETTINGS_OBJUID =
+    static final String INDEX_ANALYSIS_SETTINGS_OBJUID =
         "uthuslvotkgltggqqjmurqojpjpjjkutkujktnkk";
 
     private static final int INDEX_ANALYSIS_SETTINGS_OBJVER = 2;
@@ -63,8 +63,8 @@ public class IndexAnalysisSettingsAccessor {
      * @return a defined instance or {@code null} if none could be found
      * @throws IOException if I/O error occurs while searching Lucene
      */
-    public IndexAnalysisSettings2 read(IndexReader reader) throws IOException {
-        IndexAnalysisSettings2[] res = read(reader, 1);
+    public IndexAnalysisSettings read(IndexReader reader) throws IOException {
+        IndexAnalysisSettings[] res = read(reader, 1);
         return res.length > 0 ? res[0] : null;
     }
 
@@ -77,7 +77,7 @@ public IndexAnalysisSettings2 read(IndexReader reader) throws IOException {
      * @return a defined instance, which is empty if none could be found
      * @throws IOException if I/O error occurs while searching Lucene
      */
-    public IndexAnalysisSettings2[] read(IndexReader reader, int n)
+    public IndexAnalysisSettings[] read(IndexReader reader, int n)
             throws IOException {
         IndexSearcher searcher = new IndexSearcher(reader);
         Query q;
@@ -91,17 +91,18 @@ public IndexAnalysisSettings2[] read(IndexReader reader, int n)
         TopDocs top = searcher.search(q, n);
 
         int nres = top.totalHits > n ? n : (int)top.totalHits;
-        IndexAnalysisSettings2[] res = new IndexAnalysisSettings2[nres];
+        IndexAnalysisSettings[] res = new IndexAnalysisSettings[nres];
 
-        IndexAnalysisSettingsUpgrader upgrader =
-                new IndexAnalysisSettingsUpgrader();
         for (int i = 0; i < nres; ++i) {
             Document doc = searcher.doc(top.scoreDocs[i].doc);
             IndexableField objser = doc.getField(QueryBuilder.OBJSER);
             int objver = readObjectVersion(doc);
+            if (objver != INDEX_ANALYSIS_SETTINGS_OBJVER) {
+                throw new IllegalArgumentException("Unknown version " + objver);
+            }
             try {
-                res[i] = objser == null ? null : upgrader.upgrade(
-                        objser.binaryValue().bytes, objver);
+                res[i] = objser == null ? null : IndexAnalysisSettings.deserialize(
+                        objser.binaryValue().bytes);
             } catch (ClassNotFoundException ex) {
                 // This is not expected, so translate to RuntimeException.
                 throw new RuntimeException(ex);
@@ -119,7 +120,7 @@ public IndexAnalysisSettings2[] read(IndexReader reader, int n)
      * @param settings a defined instance
      * @throws IOException if I/O error occurs while writing Lucene
      */
-    public void write(IndexWriter writer, IndexAnalysisSettings2 settings)
+    public void write(IndexWriter writer, IndexAnalysisSettings settings)
             throws IOException {
         byte[] objser = settings.serialize();