X-Git-Url: https://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Fdata%2FMetaData.java;h=5989604ce92f51edef0b631a45dcec1ff0200ab6;hb=878ec53820a09ab01397bfe74b3e0f3884e6f9cd;hp=bcebf754b7dc2b6ee71204d9aaf8a1efe2c20dbf;hpb=33c6a3f700ed10ce63a5601237c9072f25b825ef;p=fanfix.git diff --git a/src/be/nikiroo/fanfix/data/MetaData.java b/src/be/nikiroo/fanfix/data/MetaData.java index bcebf75..5989604 100644 --- a/src/be/nikiroo/fanfix/data/MetaData.java +++ b/src/be/nikiroo/fanfix/data/MetaData.java @@ -4,11 +4,18 @@ import java.io.Serializable; import java.util.ArrayList; import java.util.List; +import be.nikiroo.fanfix.supported.SupportType; import be.nikiroo.utils.Image; import be.nikiroo.utils.StringUtils; /** * The meta data associated to a {@link Story} object. + *
+ * 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. + *
+ * The cover is never fetched until the story is.
*
* @author niki
*/
@@ -79,7 +86,7 @@ public class MetaData implements Cloneable, Comparable
* This can be NULL if we don't have a resume for this {@link Story}.
+ *
+ * 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
*/
@@ -129,6 +140,10 @@ public class MetaData implements Cloneable, Comparable
+ * 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
@@ -138,7 +153,9 @@ public class MetaData implements Cloneable, Comparable
+ * The cover is not fetched until the story is.
*
* @return the cover
*/
@@ -147,7 +164,9 @@ public class MetaData implements Cloneable, Comparable
+ * The cover is not fetched until the story is.
*
* @param cover
* the cover to set
@@ -157,7 +176,7 @@ public class MetaData implements Cloneable, Comparable
+ * It is initialised with the same value as {@link MetaData#getPublisher()},
+ * but the user is allowed to change it into any value -- this is a sort of
+ * 'category'.
*
* @return the source
*/
@@ -189,7 +212,11 @@ public class MetaData implements Cloneable, Comparable
+ * It is initialised with the same value as {@link MetaData#getPublisher()},
+ * but the user is allowed to change it into any value -- this is a sort of
+ * 'category'.
*
* @param source
* the source to set
@@ -237,7 +264,14 @@ public class MetaData implements Cloneable, Comparable
+ * A NULL or empty luid represents an incomplete, corrupted or fake
+ * {@link Story}.
*
* @return the luid
*/
@@ -246,7 +280,14 @@ public class MetaData implements Cloneable, Comparable
+ * A NULL or empty luid represents an incomplete, corrupted or fake
+ * {@link Story}.
*
* @param luid
* the luid to set
@@ -275,7 +316,15 @@ public class MetaData implements Cloneable, Comparable
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change, even when re-imported.
+ *
+ * It's the user representation of the enum
+ * ({@link SupportType#getSourceName()}, not
+ * {@link SupportType#toString()}).
*
* @return the publisher
*/
@@ -284,7 +333,15 @@ public class MetaData implements Cloneable, Comparable
+ * It allows you to know where the {@link Story} comes from, and is not
+ * supposed to change, even when re-imported.
+ *
+ * It's the user representation of the enum
+ * ({@link SupportType#getSourceName()}, not
+ * {@link SupportType#toString()}).
*
* @param publisher
* the publisher to set
@@ -294,7 +351,14 @@ public class MetaData implements Cloneable, Comparable
+ * It allows you to know where the {@link Story} comes from, and is supposed
+ * to only change when it is imported anew.
+ *
+ * It's the direct representation of the enum
+ * ({@link SupportType#toString()}, not
+ * {@link SupportType#getSourceName()}).
*
* @return the type the type
*/
@@ -303,7 +367,14 @@ public class MetaData implements Cloneable, Comparable
+ * It allows you to know where the {@link Story} comes from, and is supposed
+ * to only change when it is imported anew.
+ *
+ * It's the direct representation of the enum
+ * ({@link SupportType#toString()}, not
+ * {@link SupportType#getSourceName()}).
*
* @param type
* the new type to set
@@ -314,6 +385,10 @@ public class MetaData implements Cloneable, Comparable
+ * I.E., this is a comics or a manga, not a textual story with actual words.
+ *
+ * In image documents, all the paragraphs are supposed to be images.
*
* @return the imageDocument state
*/
@@ -323,6 +398,10 @@ public class MetaData implements Cloneable, Comparable
+ * I.E., this is a comics or a manga, not a textual story with actual words.
+ *
+ * In image documents, all the paragraphs are supposed to be images.
*
* @param imageDocument
* the imageDocument state to set
@@ -332,45 +411,49 @@ public class MetaData implements Cloneable, Comparable