Javadocs

Author: Konloch

src/main/java/com/konloch/disklib/DiskWriter.java

@@ -73,6 +73,7 @@ public static void append(File file, boolean appendNewLine) throws IOException
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @throws IOException if an I/O error occurs
 	 */
 	public static void append(String file, String line) throws IOException
@@ -85,6 +86,7 @@ public static void append(String file, String line) throws IOException
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @throws IOException if an I/O error occurs
 	 */
 	public static void append(File file, String line) throws IOException
@@ -97,6 +99,7 @@ public static void append(File file, String line) throws IOException
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @param appendNewLine true to append a new line
 	 * @throws IOException if an I/O error occurs
 	 */
@@ -110,6 +113,7 @@ public static void append(String file, String line, boolean appendNewLine) throw
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @param appendNewLine true to append a new line
 	 * @throws IOException if an I/O error occurs
 	 */
@@ -232,6 +236,7 @@ public static void write(File file, boolean appendNewLine) throws IOException
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @throws IOException if an I/O error occurs
 	 */
 	public static void write(String file, String line) throws IOException
@@ -244,6 +249,7 @@ public static void write(String file, String line) throws IOException
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @throws IOException if an I/O error occurs
 	 */
 	public static void write(File file, String line) throws IOException
@@ -256,6 +262,7 @@ public static void write(File file, String line) throws IOException
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @param appendNewLine true to append a new line
 	 * @throws IOException if an I/O error occurs
 	 */
@@ -269,6 +276,7 @@ public static void write(String file, String line, boolean appendNewLine) throws
 	 * If the file doesn't exist it will automatically create it.
 	 *
 	 * @param file any valid file path to open
+	 * @param line String to write
 	 * @param appendNewLine true to append a new line
 	 * @throws IOException if an I/O error occurs
 	 */

src/main/java/com/konloch/disklib/GZipDiskReader.java

@@ -23,7 +23,7 @@ public class GZipDiskReader
 	 * @param file any valid file path to open
 	 * @return String Array with the file content lines
 	 * @throws IOException if an I/O error occurs reading from the stream
-	 * @throws DataFormatException
+	 * @throws DataFormatException if the compressed data format is invalid
 	 */
 	public static String[] readLines(String file) throws IOException, DataFormatException
 	{
@@ -36,7 +36,7 @@ public static String[] readLines(String file) throws IOException, DataFormatExce
 	 * @param file the file object to open
 	 * @return String Array with the file content lines
 	 * @throws IOException if an I/O error occurs reading from the stream
-	 * @throws DataFormatException
+	 * @throws DataFormatException if the compressed data format is invalid
 	 */
 	public static String[] readLines(File file) throws IOException, DataFormatException
 	{
@@ -49,7 +49,7 @@ public static String[] readLines(File file) throws IOException, DataFormatExcept
 	 * @param file any valid file path to open
 	 * @return byte Array with the file content lines
 	 * @throws IOException if an I/O error occurs reading from the stream
-	 * @throws DataFormatException
+	 * @throws DataFormatException if the compressed data format is invalid
 	 */
 	public static byte[] readBytes(String file) throws IOException, DataFormatException
 	{
@@ -62,7 +62,7 @@ public static byte[] readBytes(String file) throws IOException, DataFormatExcept
 	 * @param file the file object to open
 	 * @return byte Array with the file content lines
 	 * @throws IOException if an I/O error occurs reading from the stream
-	 * @throws DataFormatException
+	 * @throws DataFormatException if the compressed data format is invalid
 	 */
 	public static byte[] readBytes(File file) throws IOException, DataFormatException
 	{
@@ -75,7 +75,7 @@ public static byte[] readBytes(File file) throws IOException, DataFormatExceptio
 	 * @param file any valid file path to open
 	 * @return String ArrayList with the file content lines
 	 * @throws IOException if an I/O error occurs reading from the stream
-	 * @throws DataFormatException
+	 * @throws DataFormatException if the compressed data format is invalid
 	 */
 	public static ArrayList<String> read(String file) throws IOException, DataFormatException
 	{
@@ -88,7 +88,7 @@ public static ArrayList<String> read(String file) throws IOException, DataFormat
 	 * @param file the file object to open
 	 * @return String ArrayList with the file content lines
 	 * @throws IOException if an I/O error occurs reading from the stream
-	 * @throws DataFormatException
+	 * @throws DataFormatException if the compressed data format is invalid
 	 */
 	public static ArrayList<String> read(File file) throws IOException, DataFormatException
 	{

src/main/java/com/konloch/disklib/GZipDiskWriter.java

@@ -73,6 +73,7 @@ public static void append(File file, boolean appendNewLine) throws IOException
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @throws IOException if an I/O error occurs
      */
     public static void append(String file, String line) throws IOException
@@ -85,6 +86,7 @@ public static void append(String file, String line) throws IOException
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @throws IOException if an I/O error occurs
      */
     public static void append(File file, String line) throws IOException
@@ -97,6 +99,7 @@ public static void append(File file, String line) throws IOException
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @param appendNewLine true to append a new line
      * @throws IOException if an I/O error occurs
      */
@@ -110,6 +113,7 @@ public static void append(String file, String line, boolean appendNewLine) throw
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @param appendNewLine true to append a new line
      * @throws IOException if an I/O error occurs
      */
@@ -232,6 +236,7 @@ public static void write(File file, boolean appendNewLine) throws IOException
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @throws IOException if an I/O error occurs
      */
     public static void write(String file, String line) throws IOException
@@ -244,6 +249,7 @@ public static void write(String file, String line) throws IOException
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @throws IOException if an I/O error occurs
      */
     public static void write(File file, String line) throws IOException
@@ -256,6 +262,7 @@ public static void write(File file, String line) throws IOException
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @param appendNewLine true to append a new line
      * @throws IOException if an I/O error occurs
      */
@@ -269,6 +276,7 @@ public static void write(String file, String line, boolean appendNewLine) throws
      * If the file doesn't exist it will automatically create it.
      *
      * @param file any valid file path to open
+     * @param line String to write
      * @param appendNewLine true to append a new line
      * @throws IOException if an I/O error occurs
      */