Added some javadocs

Author: blootsvoets

src/main/java/org/radarcns/OffsetRangeFile.java

@@ -16,6 +16,10 @@
 import java.io.Flushable;
 import java.io.IOException;
 
+/**
+ * Accesses a OffsetRange file using the CSV format. On construction, this will create the file if
+ * not present.
+ */
 public class OffsetRangeFile implements Flushable, Closeable {
     private final CsvMapper mapper;
     private final CsvSchema schema;

src/main/java/org/radarcns/OffsetRangeSet.java

@@ -73,6 +73,7 @@ public String toString() {
         return "OffsetRangeSet" + ranges;
     }
 
+    /** Whether the stored offsets is empty. */
     public boolean isEmpty() {
         return ranges.isEmpty();
     }

src/main/java/org/radarcns/util/CsvAvroConverter.java

@@ -17,6 +17,11 @@
 import org.apache.avro.generic.GenericFixed;
 import org.apache.avro.generic.GenericRecord;
 
+/**
+ * Converts deep hierarchical Avro records into flat CSV format. It uses a simple dot syntax in the
+ * column names to indicate hierarchy. After the first data record is added, all following
+ * records need to have exactly the same hierarchy (or at least a subset of it.)
+ */
 public class CsvAvroConverter implements RecordConverter {
 
     public static RecordConverterFactory getFactory() {

src/main/java/org/radarcns/util/FileCache.java

@@ -34,12 +34,11 @@ public FileCache(RecordConverterFactory converterFactory, int maxFiles) {
     }
 
     /**
-     * Append a line to given file. This will append a line ending to given data.
-     * If the file handle and writer are already open in this cache,
+     * Append a record to given file. If the file handle and writer are already open in this cache,
      * those will be used. Otherwise, the file will be opened and the file handle cached.
      *
      * @param file file to append data to
-     * @param record data without line ending
+     * @param record data
      * @return true if the cache was used, false if a new file was opened.
      * @throws IOException when failing to open a file or writing to it.
      */

src/main/java/org/radarcns/util/JsonAvroConverter.java

@@ -18,6 +18,9 @@
 import org.apache.avro.generic.GenericFixed;
 import org.apache.avro.generic.GenericRecord;
 
+/**
+ * Writes an Avro record to JSON format.
+ */
 public final class JsonAvroConverter implements RecordConverter {
 
     public static RecordConverterFactory getFactory() {

src/main/java/org/radarcns/util/RecordConverter.java

@@ -6,6 +6,7 @@
 import java.util.Map;
 import org.apache.avro.generic.GenericRecord;
 
+/** Converts a GenericRecord to Java primitives or writes it to file. */
 public interface RecordConverter extends Flushable, Closeable {
     void writeRecord(GenericRecord record) throws IOException;
     Map<String, Object> convertRecord(GenericRecord record);