Merge pull request #12 from ceefour/patch-tostring

toString() helpers for easier logging
JDaren · Mar 2, 2015 · 26f3a0d · 26f3a0d
2 parents 8ea003c + 36f251e
commit 26f3a0d
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 6 deletions.
diff --git a/src/main/java/subtitleFile/Caption.java b/src/main/java/subtitleFile/Caption.java
@@ -10,4 +10,11 @@ public class Caption {
 
 	public String content="";
 
+    @Override
+    public String toString() {
+        return "Caption{" +
+                start + ".." + end +
+                ", " + (style != null ? style.iD : null) + ", " + region + ": " + content +
+                '}';
+    }
 }
diff --git a/src/main/java/subtitleFile/Style.java b/src/main/java/subtitleFile/Style.java
@@ -134,5 +134,18 @@ protected static String defaultID() {
 		return "default"+styleCounter++;
 	}
 
-
+    @Override
+    public String toString() {
+        return "Style{" +
+                "id='" + iD + '\'' +
+                ", font='" + font + '\'' +
+                ", fontSize='" + fontSize + '\'' +
+                ", color='" + color + '\'' +
+                ", backgroundColor='" + backgroundColor + '\'' +
+                ", textAlign='" + textAlign + '\'' +
+                ", italic=" + italic +
+                ", bold=" + bold +
+                ", underline=" + underline +
+                '}';
+    }
 }
diff --git a/src/main/java/subtitleFile/Time.java b/src/main/java/subtitleFile/Time.java
@@ -186,7 +186,14 @@ protected String getTime(String format) {
 
 		return time.toString();
 	}
-
-
+
+    /**
+     * ASS/SSA time format.
+     * @return ASS/SSA time format.
+     */
+    @Override
+    public String toString() {
+        return getTime("h:mm:ss.cs");
+    }
 
 }
diff --git a/src/main/java/subtitleFile/TimedTextFileFormat.java b/src/main/java/subtitleFile/TimedTextFileFormat.java
@@ -5,7 +5,7 @@
 
 /**
  * This class specifies the interface for any format supported by the converter, these formats must
- * create a {@link TimedTextObject} from an {@link InputStream} (so it can process files form standard In or uploads)
+ * create a {@link TimedTextObject} from an {@link java.io.InputStream} (so it can process files form standard In or uploads)
  * and return a String array for text formats, or byte array for binary formats.
  * <br><br>
  * Copyright (c) 2012 J. David Requejo <br>
@@ -37,7 +37,7 @@ public interface TimedTextFileFormat {
 	 * 
 	 * @param path String that contains the path to the file
 	 * @return TimedTextObject representing the parsed file
-	 * @throws IOException when having trouble reading the file from the given path
+	 * @throws java.io.IOException when having trouble reading the file from the given path
 	 */
 	TimedTextObject parseFile(String fileName, InputStream is) throws IOException, FatalParsingException;
 

diff --git a/src/main/java/subtitleFile/TimedTextObject.java b/src/main/java/subtitleFile/TimedTextObject.java
@@ -5,7 +5,7 @@
 import java.util.TreeMap;
 
 /**
- * These objects can (should) only be created through the implementations of parseFile() in the {@link TimedTextFileFormat} interface
+ * These objects can (should) only be created through the implementations of parseFile() in the {@link subtitleFile.TimedTextFileFormat} interface
  * They are an object representation of a subtitle file and contain all the captions and associated styles.
  * <br><br>
  * Copyright (c) 2012 J. David Requejo <br>