Revize 967b6b05

re #7893

Refactoring defaultního a IO package + Javadoc.

project/Deserializer/src/CLI.java

@@ -5 +5 @@
 import io.FileWorker;
 import javafx.application.Application;
 
+/**
+ * Command-line user interface.
+ */
 public class CLI implements IConversionResults {
 
+	/**
+	 * Instances of this class define options for running the application.
+	 */
 	private static class Option {
+
+		/**
+		 * Abbreviation for the option name.
+		 */
 		String abbr;
+
+		/**
+		 * Text describing the activity for the option.
+		 */
 		String about;
 
+		/**
+		 * Converts an input argument to the option for comparison with options in the
+		 * list.
+		 * 
+		 * @param abbr input argument.
+		 */
 		public Option(String abbr) {
-			// Convert input argument to option.
 			this.abbr = abbr;
 			this.about = null;
 		}
-		
+
+		/**
+		 * Creates an option to the option list.
+		 * 
+		 * @param abbr  option abbreviation.
+		 * @param about option description.
+		 */
 		public Option(String abbr, String about) {
 			this.abbr = abbr;
 			this.about = about;
 		}
-		
+
 		@Override
 		public String toString() {
 			return abbr + "\t" + about;
@@ -48 +73 @@
 		}
 	}
 
-	
-	
+	/**
+	 * The list of options for running the application.
+	 */
 	private static HashMap<Option, Runnable> options;
+
+	/**
+	 * Whether the resulting JSON should be written to the command line.
+	 */
 	private static boolean printJSON;
+
+	/**
+	 * Where to save the resulting JSON.
+	 */
 	private static File outputFile;
 
+	/**
+	 * Initialization of static variables.
+	 */
 	static {
 		options = new HashMap<Option, Runnable>();
 		options.put(new Option("-?", "\tPrint this help message."), () -> {
@@ -68 +105 @@
 		printJSON = false;
 	}
 
+	/**
+	 * Prints help for running the application.
+	 */
 	private static void help() {
-		System.out.println("\n"
-				+ "Usage:" + "\n"
-				+ "    java ... -jar JOU_Deserializer.jar [-options] [args...]" + "\n"
-				+ "\n"
-				+ "...:" + "\n"
+		System.out.println("\n" + "Usage:" + "\n" + "    java ... -jar JOU_Deserializer.jar [-options] [args...]" + "\n"
+				+ "\n" + "...:" + "\n"
 				+ "    When running the app in the JVM 11, the following VM arguments may be required:" + "\n"
-				+ "        --module-path libs\\javafx-sdk-11.0.2\\lib --add-modules=javafx.controls" + "\n"
-				+ "\n"
-				+ "-options:" + "\n"
-				+ printOptions()
-				+ "\n"
-				+ "args...:" + "\n"
+				+ "        --module-path libs\\javafx-sdk-11.0.2\\lib --add-modules=javafx.controls" + "\n" + "\n"
+				+ "-options:" + "\n" + printOptions() + "\n" + "args...:" + "\n"
 				+ "    Input and output file. Output file need not be specified, if options contains -print." + "\n"
-				+ "\n"
-				+ "Note: if no options and arguments are specified, the GUI is created." + "\n"
-				+ "\n"
-				+ "Example:" + "\n"
-				+ "    CLI: java -jar JOU_Deserializer.jar -print input.data output.json" + "\n"
+				+ "\n" + "Note: if no options and arguments are specified, the GUI is created." + "\n" + "\n"
+				+ "Example:" + "\n" + "    CLI: java -jar JOU_Deserializer.jar -print input.data output.json" + "\n"
 				+ "    GUI: java -jar JOU_Deserializer.jar" + "\n");
 	}
-	
+
+	/**
+	 * Sets printJSON to true.
+	 */
 	private static void setPrintJSON() {
 		printJSON = true;
 	}
-	
+
+	/**
+	 * @return string with all possible options for running the application.
+	 */
 	private static String printOptions() {
 		String result = "";
 		for (Option option : options.keySet()) {
@@ -102 +138 @@
 		return result;
 	}
 
-	
-	
+	/**
+	 * Main method.
+	 * 
+	 * @param args input arguments.
+	 */
 	public static void main(String[] args) {
 		if (args.length == 0) {
+			// If no arguments exist, launch the GUI.
 			Application.launch(Window.class, args);
 		} else {
+			// Command-line user interface only.
 			String input = null, output = null;
-			
+
+			// Get options and input parameters.
 			for (int i = 0; i < args.length; i++) {
 				Option o = new Option(args[i]);
 				if (options.containsKey(o)) {
@@ -128 +170 @@
 					}
 				}
 			}
-			
+
 			if (input == null) {
 				// Only options.
 				return;
 			}
-			
+
+			// Set input and output file.
 			File inputFile = new File(input);
 			if (!inputFile.exists()) {
 				errorMessage("the input file does not exist");
 				return;
 			}
 			outputFile = output == null ? null : new File(output);
-			
+
+			// Create and run converter.
 			Converter thread = new Converter(new CLI());
 			thread.start();
 			thread.setInput(inputFile, null);
@@ -157 +201 @@
 			}
 		}
 	}
-	
+
+	/**
+	 * Prints an error message.
+	 * 
+	 * @param message error message.
+	 */
 	private static void errorMessage(String message) {
 		System.out.println("\nERROR: " + message.toUpperCase() + "!\n");
 	}
-	
-	
-	
+
 	@Override
 	public void loadingInputFileError() {
 		errorMessage("there was an error loading the file");
@@ -177 +224 @@
 		} else {
 			errorMessage("an error occurred while deserializing");
 			if (loaded != null) {
-				System.out.println("The following actions (print, save) will work with the extracted content of the file.");
+				System.out.println(
+						"The following actions (print, save) will work with the extracted content of the file.");
 				saveJson(loaded);
 			} else {
 				// This shouldn't happen, it's catched by the loadingInputFileError().
@@ -185 +233 @@
 			}
 		}
 	}
-	
+
+	/**
+	 * Saves the resulting text (JSON) to the file or prints it to the command line.
+	 * 
+	 * @param json the resulting text in JSON format.
+	 */
 	private void saveJson(String json) {
 		if (outputFile != null) {
 			try {
@@ -199 +252 @@
 			System.out.println(json);
 		}
 	}
-	
+
 }