tmf: Fix some javadoc warnings in tmf.core

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / io / BufferedRandomAccessFile.java

diff --git a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/io/BufferedRandomAccessFile.java b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/io/BufferedRandomAccessFile.java
index 1e41dcac1a67db28b382b9ecbf5597fc85d2dd77..cc70b168e0a7b1bad5dc6e66c59bdeaada54819b 100644 (file)
--- a/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/io/BufferedRandomAccessFile.java
+++ b/org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/io/BufferedRandomAccessFile.java
@@ -36,14 +36,55 @@ public class BufferedRandomAccessFile extends RandomAccessFile {
        long real_pos = 0;\r
        StringBuilder sb = new StringBuilder();\r
 \r
+    /**\r
+     * Constructor using the default buffer size\r
+     *\r
+     * @param name\r
+     *            File path. This is passed as-is to the RandomeAccessFile's\r
+     *            constructor.\r
+     * @param mode\r
+     *            File open mode ("r", "rw", etc.). This is passed as-is to\r
+     *            RandomAccessFile's constructor.\r
+     * @throws IOException\r
+     *             If the file was not found or couldn't be opened with the\r
+     *             request permissions\r
+     */\r
        public BufferedRandomAccessFile(String name, String mode) throws IOException {\r
                this(name, mode, DEFAULT_BUF_SIZE);\r
        }\r
 \r
+    /**\r
+     * Constructor using the default buffer size\r
+     *\r
+     * @param file\r
+     *            File object. This is passed as-is to the RandomeAccessFile's\r
+     *            constructor.\r
+     * @param mode\r
+     *            File open mode ("r", "rw", etc.). This is passed as-is to\r
+     *            RandomAccessFile's constructor.\r
+     * @throws IOException\r
+     *             If the file was not found or couldn't be opened with the\r
+     *             request permissions\r
+     */\r
        public BufferedRandomAccessFile(File file, String mode) throws IOException {\r
                this(file, mode, DEFAULT_BUF_SIZE);\r
        }\r
 \r
+    /**\r
+     * Standard constructor.\r
+     *\r
+     * @param name\r
+     *            File path. This is passed as-is to the RandomeAccessFile's\r
+     *            constructor.\r
+     * @param mode\r
+     *            File open mode ("r", "rw", etc.). This is passed as-is to\r
+     *            RandomAccessFile's constructor.\r
+     * @param bufsize\r
+     *            Buffer size to use, in bytes\r
+     * @throws IOException\r
+     *             If the file was not found or couldn't be opened with the\r
+     *             request permissions\r
+     */\r
        public BufferedRandomAccessFile(String name, String mode, int bufsize) throws IOException {\r
            super(name, mode);\r
            invalidate();\r
@@ -51,6 +92,21 @@ public class BufferedRandomAccessFile extends RandomAccessFile {
            buffer = new byte[BUF_SIZE];\r
     }\r
 \r
+    /**\r
+     * Standard constructor.\r
+     *\r
+     * @param file\r
+     *            File object. This is passed as-is to the RandomeAccessFile's\r
+     *            constructor.\r
+     * @param mode\r
+     *            File open mode ("r", "rw", etc.). This is passed as-is to\r
+     *            RandomAccessFile's constructor.\r
+     * @param bufsize\r
+     *            Buffer size to use, in bytes\r
+     * @throws IOException\r
+     *             If the file was not found or couldn't be opened with the\r
+     *             request permissions\r
+     */\r
        public BufferedRandomAccessFile(File file, String mode, int bufsize) throws IOException {\r
            super(file, mode);\r
            invalidate();\r
@@ -107,6 +163,14 @@ public class BufferedRandomAccessFile extends RandomAccessFile {
                }\r
        }\r
 \r
+    /**\r
+     * Read the next line from the buffer (ie, until the next '\n'). The bytes\r
+     * are interpreted as UTF-8 characters.\r
+     *\r
+     * @return The String that was read\r
+     * @throws IOException\r
+     *             If we failed reading the file\r
+     */\r
        public final String getNextLine() throws IOException {\r
                String str = null;\r
                if (buf_end - buf_pos <= 0) {\r