use more template, use replace input stream
[nikiroo-utils.git] / src / be / nikiroo / fanfix / data / MetaData.java
index 586196a663fea88aa39fe45111445d76df0d5651..2e34ef98ad27bda10ff34a009fa3d3d314aaf6b2 100644 (file)
@@ -9,6 +9,12 @@ import be.nikiroo.utils.StringUtils;
 
 /**
  * The meta data associated to a {@link Story} object.
+ * <p>
+ * Note that some earlier version of the program did not save the resume as an
+ * external file; for those stories, the resume is not fetched until the story
+ * is.
+ * <p>
+ * The cover is never fetched until the story is.
  * 
  * @author niki
  */
@@ -34,6 +40,12 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
        private String creationDate;
        private boolean fakeCover;
 
+       /**
+        * Create an empty {@link MetaData}.
+        */
+       public MetaData() {
+       }
+       
        /**
         * The title of the story.
         * 
@@ -114,6 +126,10 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
         * The story resume (a.k.a. description).
         * <p>
         * This can be NULL if we don't have a resume for this {@link Story}.
+        * <p>
+        * Note that some earlier version of the program did not save the resume as
+        * an external file; for those stories, the resume is not fetched until the
+        * story is.
         * 
         * @return the resume
         */
@@ -123,6 +139,10 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
 
        /**
         * The story resume (a.k.a. description).
+        * <p>
+        * Note that some earlier version of the program did not save the resume as
+        * an external file; for those stories, the resume is not fetched until the
+        * story is.
         * 
         * @param resume
         *            the resume to set
@@ -133,6 +153,8 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
 
        /**
         * The cover image of the story if any (can be NULL).
+        * <p>
+        * The cover is not fetched until the story is.
         * 
         * @return the cover
         */
@@ -142,6 +164,8 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
 
        /**
         * The cover image of the story if any (can be NULL).
+        * <p>
+        * The cover is not fetched until the story is.
         * 
         * @param cover
         *            the cover to set
@@ -479,8 +503,9 @@ public class MetaData implements Cloneable, Comparable<MetaData>, Serializable {
                }
 
                return String.format(
-                               "Meta %s:\n\tTitle: [%s]\n\tAuthor: [%s]\n\tDate: [%s]\n\tTags: [%s]"
-                                               + "\n\tResume: [%s]\n\tCover: [%s]", luid, title,
-                               getAuthor(), getDate(), tags.toString(), resume, cover);
+                               "Meta %s:\n\tTitle: [%s]\n\tAuthor: [%s]\n\tDate: [%s]\n\tTags: [%s]\n\tWord count: [%s]"
+                                               + "\n\tResume: [%s]\n\tCover: [%s]",
+                               luid, title, getAuthor(), getDate(), tags.toString(),
+                               "" + words, resume, cover);
        }
 }