Remove or move java.awt dependencies

[nikiroo-utils.git] / src / be / nikiroo / fanfix / output / BasicOutput.java

diff --git a/src/be/nikiroo/fanfix/output/BasicOutput.java b/src/be/nikiroo/fanfix/output/BasicOutput.java
index 1ac6101d5852b57b0759b30294b4b87b1db4081f..5109cce61637a067bb6fc2bfaf38272f54c37c33 100644 (file)
--- a/src/be/nikiroo/fanfix/output/BasicOutput.java
+++ b/src/be/nikiroo/fanfix/output/BasicOutput.java
@@ -45,6 +45,7 @@ public abstract class BasicOutput {
 
                ;
 
+               @Override
                public String toString() {
                        return super.toString().toLowerCase();
                }
@@ -85,7 +86,7 @@ public abstract class BasicOutput {
                 * @return the extension
                 */
                public String getDefaultExtension(boolean readerTarget) {
-                       BasicOutput output = BasicOutput.getOutput(this, false);
+                       BasicOutput output = BasicOutput.getOutput(this, false, false);
                        if (output != null) {
                                return output.getDefaultExtension(readerTarget);
                        }
@@ -94,7 +95,8 @@ public abstract class BasicOutput {
                }
 
                /**
-                * Call {@link OutputType#valueOf(String.toUpperCase())}.
+                * Call {@link OutputType#valueOf(String)} after conversion to upper
+                * case.
                 * 
                 * @param typeName
                 *            the possible type name
@@ -107,36 +109,41 @@ public abstract class BasicOutput {
                }
 
                /**
-                * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
-                * for NULL and empty instead of raising an exception.
+                * Call {@link OutputType#valueOf(String)} after conversion to upper
+                * case but return def for NULL and empty instead of raising an
+                * exception.
                 * 
                 * @param typeName
                 *            the possible type name
+                * @param def
+                *            the default value
                 * 
                 * @return NULL or the type
                 */
-               public static OutputType valueOfNullOkUC(String typeName) {
+               public static OutputType valueOfNullOkUC(String typeName, OutputType def) {
                        if (typeName == null || typeName.isEmpty()) {
-                               return null;
+                               return def;
                        }
 
                        return OutputType.valueOfUC(typeName);
                }
 
                /**
-                * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
-                * in case of error instead of raising an exception.
+                * Call {@link OutputType#valueOf(String)} after conversion to upper
+                * case but return def in case of error instead of raising an exception.
                 * 
                 * @param typeName
                 *            the possible type name
+                * @param def
+                *            the default value
                 * 
                 * @return NULL or the type
                 */
-               public static OutputType valueOfAllOkUC(String typeName) {
+               public static OutputType valueOfAllOkUC(String typeName, OutputType def) {
                        try {
                                return OutputType.valueOfUC(typeName);
                        } catch (Exception e) {
-                               return null;
+                               return def;
                        }
                }
        }
@@ -233,22 +240,42 @@ public abstract class BasicOutput {
                return type;
        }
 
+       /**
+        * Enable the creation of a .info file next to the resulting processed file.
+        * 
+        * @return TRUE to enable it
+        */
+       protected boolean isWriteInfo() {
+               return writeInfo;
+       }
+
+       /**
+        * Enable the creation of a cover file next to the resulting processed file
+        * if possible.
+        * 
+        * @return TRUE to enable it
+        */
+       protected boolean isWriteCover() {
+               return writeCover;
+       }
+
        /**
         * The output type.
         * 
         * @param type
         *            the new type
-        * @param infoCover
-        *            TRUE to enable the creation of a .info file and a cover if
-        *            possible
+        * @param writeCover
+        *            TRUE to enable the creation of a cover if possible
+        * @param writeInfo
+        *            TRUE to enable the creation of a .info file
         * 
         * @return this
         */
-       protected BasicOutput setType(OutputType type, boolean writeCover,
-                       boolean writeInfo) {
+       protected BasicOutput setType(OutputType type, boolean writeInfo,
+                       boolean writeCover) {
                this.type = type;
-               this.writeCover = writeCover;
                this.writeInfo = writeInfo;
+               this.writeCover = writeCover;
 
                return this;
        }
@@ -263,25 +290,32 @@ public abstract class BasicOutput {
         * 
         * @return the extension
         */
-       public String getDefaultExtension(boolean readerTarget) {
+       public String getDefaultExtension(
+                       @SuppressWarnings("unused") boolean readerTarget) {
                return "";
        }
 
+       @SuppressWarnings("unused")
        protected void writeStoryHeader(Story story) throws IOException {
        }
 
+       @SuppressWarnings("unused")
        protected void writeChapterHeader(Chapter chap) throws IOException {
        }
 
+       @SuppressWarnings("unused")
        protected void writeParagraphHeader(Paragraph para) throws IOException {
        }
 
+       @SuppressWarnings("unused")
        protected void writeStoryFooter(Story story) throws IOException {
        }
 
+       @SuppressWarnings("unused")
        protected void writeChapterFooter(Chapter chap) throws IOException {
        }
 
+       @SuppressWarnings("unused")
        protected void writeParagraphFooter(Paragraph para) throws IOException {
        }
 
@@ -342,13 +376,13 @@ public abstract class BasicOutput {
 
                int num = 0;
                String paragraphNumber = String.format("%04d", num++);
-               imageName = chapterNameNum + "_" + paragraphNumber + ".png";
+               imageName = chapterNameNum + "_" + paragraphNumber;
 
                writeChapterHeader(chap);
                int i = 1;
                for (Paragraph para : chap) {
                        paragraphNumber = String.format("%04d", num++);
-                       imageName = chapterNameNum + "_" + paragraphNumber + ".png";
+                       imageName = chapterNameNum + "_" + paragraphNumber;
                        writeParagraph(para);
                        if (chapPg != null) {
                                chapPg.setProgress(i++);
@@ -363,6 +397,7 @@ public abstract class BasicOutput {
                writeParagraphFooter(para);
        }
 
+       @SuppressWarnings("unused")
        protected void writeTextLine(ParagraphType type, String line)
                        throws IOException {
        }
@@ -479,29 +514,33 @@ public abstract class BasicOutput {
         * 
         * @param type
         *            the type
-        * @param infoCover
-        *            force the <tt>.info</tt> file and the cover to be saved next
+        * @param writeCover
+        *            TRUE to enable the creation of a cover if possible to be saved
+        *            next to the main target file
+        * @param writeInfo
+        *            TRUE to enable the creation of a .info file to be saved next
         *            to the main target file
         * 
         * @return the {@link BasicOutput}
         */
-       public static BasicOutput getOutput(OutputType type, boolean infoCover) {
+       public static BasicOutput getOutput(OutputType type, boolean writeInfo,
+                       boolean writeCover) {
                if (type != null) {
                        switch (type) {
                        case EPUB:
-                               return new Epub().setType(type, infoCover, infoCover);
+                               return new Epub().setType(type, writeInfo, writeCover);
                        case TEXT:
-                               return new Text().setType(type, true, infoCover);
+                               return new Text().setType(type, writeInfo, true);
                        case INFO_TEXT:
                                return new InfoText().setType(type, true, true);
                        case SYSOUT:
                                return new Sysout().setType(type, false, false);
                        case CBZ:
-                               return new Cbz().setType(type, infoCover, infoCover);
+                               return new Cbz().setType(type, writeInfo, writeCover);
                        case LATEX:
-                               return new LaTeX().setType(type, infoCover, infoCover);
+                               return new LaTeX().setType(type, writeInfo, writeCover);
                        case HTML:
-                               return new Html().setType(type, infoCover, infoCover);
+                               return new Html().setType(type, writeInfo, writeCover);
                        }
                }