Add a method to comic filters to allow extracting image comments.
authorDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Mon, 25 Feb 2013 05:55:11 +0000 (06:55 +0100)
committerDavid ‘Bombe’ Roden <bombe@pterodactylus.net>
Mon, 25 Feb 2013 05:55:11 +0000 (06:55 +0100)
This will be used by the upcoming xkcd filter.

src/main/java/net/pterodactylus/rhynodge/filters/ComicSiteFilter.java
src/main/java/net/pterodactylus/rhynodge/filters/comics/SinfestComicFilter.java

index fb01349..fec856c 100644 (file)
@@ -86,4 +86,16 @@ public abstract class ComicSiteFilter implements Filter {
         */
        protected abstract List<String> extractImageUrls(Document document);
 
+       /**
+        * Extracts the image comments from the given document. The elements of this
+        * last and of the list returned by {@link #extractImageUrls(org.jsoup.nodes.Document)}
+        * are paired up and added as {@link Strip}s. If the list returned by this
+        * method has less elements, an empty string is used for the remaining images.
+        *
+        * @param document
+        *              The document to extract the image comments from
+        * @return The extracted image comments
+        */
+       protected abstract List<String> extractImageComments(Document document);
+
 }
index 600257f..76089e3 100644 (file)
@@ -67,4 +67,9 @@ public class SinfestComicFilter extends ComicSiteFilter {
                }).toList() : Collections.<String>emptyList();
        }
 
+       @Override
+       protected List<String> extractImageComments(Document document) {
+               return Collections.emptyList();
+       }
+
 }