Add docs

Author: yatharthranjan

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

@@ -30,6 +30,7 @@
 import java.io.IOException;
 import java.io.Writer;
 import java.nio.ByteBuffer;
+import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -59,7 +60,7 @@ public boolean hasHeader() {
     private final ObjectWriter csvWriter;
     private final Map<String, Object> map;
     private final CsvGenerator generator;
-    private int numOfColumns;
+    private final int numOfColumns;
 
     public CsvAvroConverter(CsvFactory factory, Writer writer, GenericRecord record, boolean writeHeader)
             throws IOException {
@@ -78,6 +79,12 @@ public CsvAvroConverter(CsvFactory factory, Writer writer, GenericRecord record,
         csvWriter = new CsvMapper(factory).writer(schema);
     }
 
+    /**
+     * Write AVRO record to CSV file.
+     * @param record the AVRO record to be written to CSV file
+     * @return true if write was successful, false if cannot write record to the current CSV file
+     * @throws IOException for other IO and Mapping errors
+     */
     @Override
     public boolean writeRecord(GenericRecord record) throws IOException {
         Map<String, Object> localMap = convertRecord(record);

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

@@ -76,7 +76,12 @@ public FileCache(RecordConverterFactory converterFactory, Path path,
         }
     }
 
-    /** Write a record to the cache. */
+    /**
+     * Write a record to the cache.
+     * @param record AVRO record
+     * @return true or false based on {@link RecordConverter} write result
+     * @throws IOException
+     */
     public boolean writeRecord(GenericRecord record) throws IOException {
         boolean result = this.recordConverter.writeRecord(record);
         lastUse = System.nanoTime();

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

@@ -61,7 +61,7 @@ public FileCacheStore(RecordConverterFactory converterFactory, int maxFiles, boo
      *
      * @param path file to append data to
      * @param record data
-     * @return integer according to one of the response codes.
+     * @return Integer value according to one of the response codes.
      * @throws IOException when failing to open a file or writing to it.
      */
     public int writeRecord(Path path, GenericRecord record) throws IOException {