Hit must take a filename

- path, filename, and directory are now immutable,
  so require initialization

Author: idodeclare

opengrok-indexer/src/main/java/org/opengrok/indexer/search/Hit.java

@@ -21,6 +21,7 @@
  * Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
  * portions copyright 2005 Trond Norbye.  All rights reserved.
  * Use is subject to license terms.
+ * Portions Copyright (c) 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.search;
 
@@ -31,16 +32,16 @@
  *
  * @author Trond Norbye
  */
-public class Hit implements Comparable<Hit> {
+public class Hit {
     /**
      * Holds value of property filename.
      */
-    private String filename;
+    private final String filename;
 
     /**
      * Holds value of property directory.
      */
-    private String directory;
+    private final String directory;
 
     /**
      * Holds value of property line.
@@ -65,17 +66,19 @@ public class Hit implements Comparable<Hit> {
     /**
      * path relative to source root.
      */
-    private String path;
+    private final String path;
 
     /**
-     * Creates a new instance of Hit.
+     * Creates a new, possibly-defined instance.
+     *
+     * @param filename The name of the file this hit represents
      */
-    public Hit() {
-        this(null, null, null, false, false);
+    public Hit(String filename) {
+        this(filename, null, null, false, false);
     }
 
     /**
-     * Creates a new instance of Hit.
+     * Creates a new, possibly-defined instance.
      *
      * @param filename The name of the file this hit represents
      * @param line The line containing the match
@@ -88,115 +91,55 @@ public Hit(String filename, String line, String lineno, boolean binary, boolean
             File file = new File(filename);
             this.path = filename;
             this.filename = file.getName();
-            this.directory = file.getParent();
-            if (directory == null) {
+            final String parent = file.getParent();
+            if (parent == null) {
                 directory = "";
+            } else {
+                directory = parent;
             }
+        } else {
+            this.path = "";
+            this.filename = "";
+            this.directory = "";
         }
         this.line = line;
         this.lineno = lineno;
         this.binary = binary;
         this.alt = alt;
     }
 
-    /**
-     * Getter for property filename.
-     *
-     * @return Value of property filename.
-     */
     public String getFilename() {
         return this.filename;
     }
 
-    /**
-     * Getter for property path.
-     *
-     * @return Value of property path.
-     */
     public String getPath() {
         return this.path;
     }
 
-    /**
-     * Getter for property directory.
-     *
-     * @return Value of property directory
-     */
     public String getDirectory() {
         return this.directory;
     }
 
-    /**
-     * Setter for property filename.
-     *
-     * @param filename New value of property filename.
-     */
-    public void setFilename(String filename) {
-        this.filename = filename;
-    }
-
-    /**
-     * Getter for property line.
-     *
-     * @return Value of property line.
-     */
     public String getLine() {
         return this.line;
     }
 
-    /**
-     * Setter for property line.
-     *
-     * @param line New value of property line.
-     */
     public void setLine(String line) {
         this.line = line;
     }
 
-    /**
-     * Getter for property line no.
-     *
-     * @return Value of property line no.
-     */
     public String getLineno() {
         return this.lineno;
     }
 
-    /**
-     * Setter for property line no.
-     *
-     * @param lineno New value of property line no.
-     */
     public void setLineno(String lineno) {
         this.lineno = lineno;
     }
 
-    /**
-     * Compare this object to another hit (in order to implement the comparable interface).
-     *
-     * @param o The object to compare this object with
-     *
-     * @return the result of a toString().compareTo() of the filename
-     */
-    @Override
-    public int compareTo(Hit o) throws ClassCastException {
-        return filename.compareTo(o.filename);
-    }
-
-    /**
-     * Getter for property binary.
-     *
-     * @return Value of property binary.
-     */
     public boolean isBinary() {
         return this.binary;
     }
 
-    /**
-     * Setter for property binary.
-     *
-     * @param binary New value of property binary.
-     */
     public void setBinary(boolean binary) {
         this.binary = binary;
     }
@@ -206,19 +149,11 @@ public void setBinary(boolean binary) {
      */
     private String tag;
 
-    /**
-     * Getter for property tag.
-     * @return Value of property tag.
-     */
     public String getTag() {
 
         return this.tag;
     }
 
-    /**
-     * Setter for property tag.
-     * @param tag New value of property tag.
-     */
     public void setTag(String tag) {
 
         this.tag = tag;
@@ -231,23 +166,4 @@ public void setTag(String tag) {
     public boolean getAlt() {
         return alt;
     }
-
-    /**
-     * Check if two objects are equal. Only consider the {@code filename} field
-     * to match the return value of the {@link #compareTo(Hit)} method.
-     * @param o the object to compare with
-     * @return true if the filenames are equal
-     */
-    @Override
-    public boolean equals(Object o) {
-        if (o instanceof Hit) {
-            return compareTo((Hit) o) == 0;
-        }
-        return false;
-    }
-
-    @Override
-    public int hashCode() {
-        return filename.hashCode();
-    }
 }

opengrok-indexer/src/test/java/org/opengrok/indexer/search/HitTest.java

@@ -19,15 +19,18 @@
 
 /*
  * Copyright (c) 2008, 2018 Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.search;
 
-import org.junit.Test;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
 
+import org.junit.Test;
 import java.io.File;
 
-import static org.junit.Assert.*;
-
 /**
  * Do basic sanity testing of the Hit class
  *
@@ -37,10 +40,8 @@ public class HitTest {
 
     @Test
     public void testFilename() {
-        Hit instance = new Hit();
-        assertNull(instance.getFilename());
+        Hit instance = new Hit("a/b/foobar");
         String expResult = "foobar";
-        instance.setFilename(expResult);
         assertEquals(expResult, instance.getFilename());
     }
 
@@ -53,7 +54,7 @@ public void testPath() {
 
     @Test
     public void testLine() {
-        Hit instance = new Hit();
+        Hit instance = new Hit("a/b/c");
         assertNull(instance.getLine());
         String expResult = "This is a line of text";
         instance.setLine(expResult);
@@ -62,33 +63,24 @@ public void testLine() {
 
     @Test
     public void testLineno() {
-        Hit instance = new Hit();
+        Hit instance = new Hit("a/b");
         assertNull(instance.getLineno());
         String expResult = "12";
         instance.setLineno(expResult);
         assertEquals(expResult, instance.getLineno());
     }
 
-    @Test
-    public void testCompareTo() {
-        Hit o1 = new Hit("/foo", null, null, false, false);
-        Hit o2 = new Hit("/foo", "hi", "there", false, false);
-        assertEquals(o2.compareTo(o1), o1.compareTo(o2));
-        o1.setFilename("bar");
-        assertFalse(o2.compareTo(o1) == o1.compareTo(o2));
-    }
-
     @Test
     public void testBinary() {
-        Hit instance = new Hit();
+        Hit instance = new Hit("abc");
         assertFalse(instance.isBinary());
         instance.setBinary(true);
         assertTrue(instance.isBinary());
     }
 
     @Test
     public void testTag() {
-        Hit instance = new Hit();
+        Hit instance = new Hit("def");
         assertNull(instance.getTag());
         String expResult = "foobar";
         instance.setTag(expResult);
@@ -98,27 +90,9 @@ public void testTag() {
 
     @Test
     public void testAlt() {
-        Hit instance = new Hit();
+        Hit instance = new Hit("ghi/d");
         assertFalse(instance.getAlt());
         Hit o2 = new Hit(null, null, null, false, true);
         assertTrue(o2.getAlt());
     }
-
-    @Test
-    public void testEquals() {
-        Hit o1 = new Hit("/foo", null, null, false, false);
-        Hit o2 = new Hit("/foo", "hi", "there", false, false);
-        assertEquals(o2.equals(o1), o1.equals(o2));
-        o1.setFilename("bar");
-        assertFalse(o2.equals(o1));
-        assertFalse(o1.equals(o2));
-        assertFalse(o1.equals(new Object()));        
-    }
-
-    @Test
-    public void testHashCode() {
-        String filename = "bar";
-        Hit instance = new Hit(filename, null, null, false, false);
-        assertEquals(filename.hashCode(), instance.hashCode());
-    }
 }