X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Freader%2FBasicReader.java;h=baf3c7dede9ebab876d7a4b3158d369e8224331d;hb=5dd985cf7d5e2bb88b07fd43e7b4a4eda4647181;hp=05e3e3df1124b6eae858e536e5b57adec2db78e2;hpb=b0e88ebd20f8b2950c382694e936da76ac3596b6;p=fanfix.git

diff --git a/src/be/nikiroo/fanfix/reader/BasicReader.java b/src/be/nikiroo/fanfix/reader/BasicReader.java
index 05e3e3d..baf3c7d 100644
--- a/src/be/nikiroo/fanfix/reader/BasicReader.java
+++ b/src/be/nikiroo/fanfix/reader/BasicReader.java
@@ -6,8 +6,9 @@ import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
 
+import be.nikiroo.fanfix.BasicLibrary;
 import be.nikiroo.fanfix.Instance;
-import be.nikiroo.fanfix.Library;
+import be.nikiroo.fanfix.LocalLibrary;
 import be.nikiroo.fanfix.bundles.Config;
 import be.nikiroo.fanfix.bundles.UiConfig;
 import be.nikiroo.fanfix.data.MetaData;
@@ -24,6 +25,11 @@ import be.nikiroo.utils.serial.SerialUtils;
  * @author niki
  */
 public abstract class BasicReader {
+	/**
+	 * A type of {@link BasicReader}.
+	 * 
+	 * @author niki
+	 */
 	public enum ReaderType {
 		/** Simple reader that outputs everything on the console */
 		CLI,
@@ -34,6 +40,12 @@ public abstract class BasicReader {
 
 		;
 
+		/**
+		 * Return the full class name of a type that implements said
+		 * {@link ReaderType}.
+		 * 
+		 * @return the class name
+		 */
 		public String getTypeName() {
 			String pkg = "be.nikiroo.fanfix.reader.";
 			switch (this) {
@@ -42,17 +54,17 @@ public abstract class BasicReader {
 			case TUI:
 				return pkg + "TuiReader";
 			case GUI:
-				return pkg + "LocalReader";
+				return pkg + "GuiReader";
 			}
 
 			return null;
 		}
 	}
 
-	private static Library defaultLibrary = Instance.getLibrary();
+	private static BasicLibrary defaultLibrary = Instance.getLibrary();
 	private static ReaderType defaultType = ReaderType.GUI;
 
-	private Library lib;
+	private BasicLibrary lib;
 	private Story story;
 	private ReaderType type;
 
@@ -85,6 +97,8 @@ public abstract class BasicReader {
 	 * 
 	 * @param type
 	 *            the new type
+	 * 
+	 * @return the type
 	 */
 	protected BasicReader setType(ReaderType type) {
 		this.type = type;
@@ -101,12 +115,12 @@ public abstract class BasicReader {
 	}
 
 	/**
-	 * The {@link Library} to load the stories from (by default, takes the
-	 * default {@link Library}).
+	 * The {@link LocalLibrary} to load the stories from (by default, takes the
+	 * default {@link LocalLibrary}).
 	 * 
-	 * @return the {@link Library}
+	 * @return the {@link LocalLibrary}
 	 */
-	public Library getLibrary() {
+	public BasicLibrary getLibrary() {
 		if (lib == null) {
 			lib = defaultLibrary;
 		}
@@ -115,19 +129,19 @@ public abstract class BasicReader {
 	}
 
 	/**
-	 * Change the {@link Library} that will be managed by this
+	 * Change the {@link LocalLibrary} that will be managed by this
 	 * {@link BasicReader}.
 	 * 
 	 * @param lib
-	 *            the new {@link Library}
+	 *            the new {@link LocalLibrary}
 	 */
-	public void setLibrary(Library lib) {
+	public void setLibrary(LocalLibrary lib) {
 		this.lib = lib;
 	}
 
 	/**
 	 * Create a new {@link BasicReader} for a {@link Story} in the
-	 * {@link Library}.
+	 * {@link LocalLibrary}.
 	 * 
 	 * @param luid
 	 *            the {@link Story} ID
@@ -195,9 +209,6 @@ public abstract class BasicReader {
 	 * Start the reader in browse mode for the given source (or pass NULL for
 	 * all sources).
 	 * 
-	 * @param library
-	 *            the library to browse
-	 * 
 	 * @param source
 	 *            the type of {@link Story} to take into account, or NULL for
 	 *            all
@@ -247,12 +258,13 @@ public abstract class BasicReader {
 	}
 
 	/**
-	 * Change the default {@link Library} to open with the {@link BasicReader}s.
+	 * Change the default {@link LocalLibrary} to open with the
+	 * {@link BasicReader}s.
 	 * 
 	 * @param lib
-	 *            the new {@link Library}
+	 *            the new {@link LocalLibrary}
 	 */
-	public static void setDefaultLibrary(Library lib) {
+	public static void setDefaultLibrary(BasicLibrary lib) {
 		BasicReader.defaultLibrary = lib;
 	}
 
@@ -284,15 +296,37 @@ public abstract class BasicReader {
 		return source;
 	}
 
-	// open with external player the related file
-	public static void open(Library lib, String luid) throws IOException {
+	/**
+	 * Open the {@link Story} with an external reader (the program will be
+	 * passed the main file associated with this {@link Story}).
+	 * 
+	 * @param lib
+	 *            the {@link BasicLibrary} to select the {@link Story} from
+	 * @param luid
+	 *            the {@link Story} LUID
+	 * 
+	 * @throws IOException
+	 *             in case of I/O error
+	 */
+	public static void open(BasicLibrary lib, String luid) throws IOException {
 		MetaData meta = lib.getInfo(luid);
 		File target = lib.getFile(luid);
 
 		open(meta, target);
 	}
 
-	// open with external player the related file
+	/**
+	 * Open the {@link Story} with an external reader (the program will be
+	 * passed the given target file).
+	 * 
+	 * @param meta
+	 *            the {@link Story} to load
+	 * @param target
+	 *            the target {@link File}
+	 * 
+	 * @throws IOException
+	 *             in case of I/O error
+	 */
 	protected static void open(MetaData meta, File target) throws IOException {
 		String program = null;
 		if (meta.isImageDocument()) {