MetaData: improve jDoc, fix deprecated

[fanfix.git] / src / be / nikiroo / fanfix / supported / BasicSupport.java

diff --git a/src/be/nikiroo/fanfix/supported/BasicSupport.java b/src/be/nikiroo/fanfix/supported/BasicSupport.java
index 388f57222cf41da10d24a354626cb6409195304a..092f89e2a35bba003761046e483ed7f5766a8844 100644 (file)
--- a/src/be/nikiroo/fanfix/supported/BasicSupport.java
+++ b/src/be/nikiroo/fanfix/supported/BasicSupport.java
@@ -38,13 +38,6 @@ public abstract class BasicSupport {
        private SupportType type;
        private URL currentReferer; // with only one 'r', as in 'HTTP'...
 
-       /**
-        * The name of this support class.
-        * 
-        * @return the name
-        */
-       protected abstract String getSourceName();
-
        /**
         * Check if the given resource is supported by this {@link BasicSupport}.
         * 
@@ -295,7 +288,7 @@ public abstract class BasicSupport {
                                                        getDesc(), isHtml(), null));
                }
 
-               pg.setProgress(100);
+               pg.done();
                return story;
        }
 
@@ -311,7 +304,7 @@ public abstract class BasicSupport {
         * @throws IOException
         *             in case of I/O error
         */
-       // ADD final when BasicSupport_Deprecated is gone
+       // TODO: ADD final when BasicSupport_Deprecated is gone
        public Story process(Progress pg) throws IOException {
                setCurrentReferer(source);
                login();
@@ -394,6 +387,7 @@ public abstract class BasicSupport {
                        }
 
                        pgChaps.setName("Extracting chapters");
+                       pgChaps.done();
                }
 
                pg.done();
@@ -401,6 +395,29 @@ public abstract class BasicSupport {
                return story;
        }
 
+       /**
+        * Create a chapter from the given data.
+        * 
+        * @param source
+        *            the source URL for this content, which can be used to try and
+        *            find images if images are present in the format [image-url]
+        * @param number
+        *            the chapter number (0 = description)
+        * @param name
+        *            the chapter name
+        * @param content
+        *            the content of the chapter
+        * @return the {@link Chapter}
+        * 
+        * @throws IOException
+        *             in case of I/O error
+        */
+       public Chapter makeChapter(URL source, int number, String name,
+                       String content) throws IOException {
+               return BasicSupportPara.makeChapter(this, source, number, name,
+                               content, isHtml(), null);
+       }
+
        /**
         * Return a {@link BasicSupport} implementation supporting the given
         * resource if possible.
@@ -440,10 +457,11 @@ public abstract class BasicSupport {
         * Return a {@link BasicSupport} implementation supporting the given type.
         * 
         * @param type
-        *            the type
+        *            the type, must not be NULL
         * @param url
         *            the {@link URL} to support (can be NULL to get an
-        *            "abstract support")
+        *            "abstract support"; if not NULL, will be used as the source
+        *            URL)
         * 
         * @return an implementation that supports it, or NULL
         */