errorprone :: MissingSummary (#757)

src/main/java/emissary/core/IBaseDataObject.java

@@ -870,6 +870,8 @@ enum MergePolicy {
     int getExtractedRecordCount();
 
     /**
+     * Test if tree is outputable
+     *
      * @return true if this tree is not able to be output, false otherwise
      */
     boolean isOutputable();
@@ -882,6 +884,8 @@ enum MergePolicy {
     void setOutputable(boolean outputable);
 
     /**
+     * Get ID
+     *
      * @return the unique identifier of the IBaseDataObject
      */
     String getId();
@@ -894,6 +898,8 @@ enum MergePolicy {
     void setId(String id);
 
     /**
+     * Get the Work Bundle ID
+     *
      * @return the unique identifier of the {@link emissary.pickup.WorkBundle}
      */
     String getWorkBundleId();
@@ -906,6 +912,8 @@ enum MergePolicy {
     void setWorkBundleId(String workBundleId);
 
     /**
+     * Get the Transaction ID
+     *
      * @return the unique identifier of the transaction
      */
     String getTransactionId();

src/main/java/emissary/output/DropOffUtil.java

@@ -600,6 +600,8 @@ protected Object nvl(@Nullable final Object a, final Object b) {
     }
 
     /**
+     * Format string to date path (yyyy-mm-dd/hh/(mm%10))
+     *
      * @param dtg expected format yyyymmddhhmmss
      * @return yyyy-mm-dd/hh/(mm%10)
      */

src/main/java/emissary/output/roller/ICoalescer.java

@@ -18,7 +18,8 @@ public interface ICoalescer {
     void coalesce() throws IOException;
 
     /**
-     * @see ICoalescer#coalesce()
+     * Combine files into a single output file
+     *
      * @param journals the paths to the journal files
      * @throws IOException If there is some I/O problem.
      */

src/main/java/emissary/output/roller/journal/JournalWriter.java

@@ -62,7 +62,8 @@ private void checkJournal() throws IOException {
     }
 
     /**
-     * 
+     * Write to journal
+     *
      * @return position difference between last entry and current
      */
     public long write(JournalEntry e) throws IOException {

src/main/java/emissary/parser/DecomposedSession.java

@@ -129,6 +129,8 @@ public void setClassification(String s) {
     }
 
     /**
+     * Get the classification
+     *
      * @return the classification entry or null if none
      */
     public String getClassification() {
@@ -162,6 +164,8 @@ public Multimap<String, Object> getMultimap() {
     }
 
     /**
+     * Test for header presence
+     *
      * @return true if there is a header entry
      */
     public boolean hasHeader() {

src/main/java/emissary/pool/MoveSpool.java

@@ -453,27 +453,35 @@ public Method getMethod() {
     }
 
     /**
+     * Get the lookupCount
+     *
      * @return the lookupCount
      */
     public static long getLookupCount() {
         return lookupCount;
     }
 
     /**
+     * Get the dequeCount
+     *
      * @return the dequeCount
      */
     public long getDequeCount() {
         return dequeCount;
     }
 
     /**
+     * Get the enqueCount
+     *
      * @return the enqueCount
      */
     public long getEnqueCount() {
         return enqueCount;
     }
 
     /**
+     * Get the highWaterMark
+     *
      * @return the highWaterMark
      */
     public int getHighWaterMark() {

src/main/java/emissary/util/ByteUtil.java

@@ -27,6 +27,8 @@ public class ByteUtil {
     public static final String HEX = "0123456789abcdefABCDEF";
 
     /**
+     * Check if byte is hexadecimal
+     *
      * @param b a byte
      * @return true if b is a hexadecimal
      */
@@ -35,6 +37,7 @@ public static boolean isHexadecimal(byte b) {
     }
 
     /**
+     * Check if all bytes in array are hexadecimal
      *
      * @param array a byte array
      * @return true if all bytes in array are hexadecimal
@@ -49,6 +52,7 @@ public static boolean isHexadecimal(byte[] array) {
     }
 
     /**
+     * Check if character is hexadecimal
      *
      * @param c a char
      * @return true if c is a hexadecimal
@@ -58,6 +62,7 @@ public static boolean isHexadecimal(char c) {
     }
 
     /**
+     * Check if all bytes are alphabetical
      *
      * @param array a byte array
      * @return true if all bytes in array are alpha
@@ -72,6 +77,7 @@ public static boolean isAlpha(byte[] array) {
     }
 
     /**
+     * Check if byte is alphabetical
      *
      * @param b a byte
      * @return true if b is alphabetical
@@ -81,6 +87,7 @@ public static boolean isAlpha(byte b) {
     }
 
     /**
+     * Check if byte is alphanumeric
      *
      * @param b a byte
      * @return true if b is alphanumeric
@@ -90,16 +97,18 @@ public static boolean isAlNum(byte b) {
     }
 
     /**
+     * Check if byte is a digit
      *
      * @param b a byte
-     * @return true if b is a digt
+     * @return true if b is a digit
      */
     public static boolean isDigit(byte b) {
         // check ascii value of b for digit-ness
         return (b >= '0' && b <= '9');
     }
 
     /**
+     * Check if all bytes are digits
      *
      * @param array a byte array
      * @return true if all bytes in array are digits
@@ -114,6 +123,7 @@ public static boolean isDigit(byte[] array) {
     }
 
     /**
+     * Check if byte at position in array is a control or blank space byte
      *
      * @param b a byte array
      * @param pos a position in the byte array

src/main/java/emissary/util/shell/ProcessReader.java

@@ -10,11 +10,6 @@
 
 import java.util.Map;
 
-/**
- *
- * @author ce
- * @version 1.0
- */
 public abstract class ProcessReader extends Thread {
 
     private Map<String, String> contextMap;

src/main/java/emissary/util/shell/ReadOutputLogger.java

@@ -14,11 +14,6 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 
-/**
- *
- * @author ce
- * @version 1.0
- */
 public class ReadOutputLogger extends ProcessReader {
 
     private static Logger logger = LoggerFactory.getLogger(ReadOutputLogger.class);

src/test/java/emissary/test/core/junit5/RegressionTestUtil.java

@@ -117,9 +117,6 @@ public static Path getTestResx() {
         return pathBuilder.resolve("test/resources");
     }
 
-    /**
-     * @see ExtractionTest#checkAnswers(Document, IBaseDataObject, List, String)
-     */
     public static void checkAnswers(final Document answers, final IBaseDataObject payload, final List<SimplifiedLogEvent> actualSimplifiedLogEvents,
             final List<IBaseDataObject> attachments, final String placeName, final ElementDecoders decoders) {
         final Element root = answers.getRootElement();