added javadoc pom entry, updates to FilesAndStreams and preps for SDK

Author: fquirin

pom.xml

@@ -61,6 +61,17 @@
 					<finalName>sepia-core-tools-v${project.version}</finalName>
 				</configuration>
 			</plugin>
+			
+			<!-- Java docs, use with: mvn javadoc:jar -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>3.0.1</version>
+				<configuration>
+					<doclint>none</doclint> <!-- TODO: fix errors found by linter -->
+					<finalName>sepia-core-tools-v${project.version}</finalName>
+				</configuration>
+			</plugin>
 		</plugins>
 	</build>
 

src/main/java/net/b07z/sepia/server/core/tools/ClassBuilder.java

@@ -1,6 +1,13 @@
 package net.b07z.sepia.server.core.tools;
 
 import java.lang.reflect.Constructor;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.tools.DiagnosticCollector;
+import javax.tools.JavaCompiler;
+import javax.tools.JavaFileObject;
+import javax.tools.ToolProvider;
 
 /**
  * Build classes from strings. Very handy for configuration files and plug-ins.
@@ -81,5 +88,23 @@ public static Object construct(String module_name){
 			throw new RuntimeException(DateTime.getLogDate() + " ERROR - Class not found: " + module_name, e);
 		}
 	}
+	
+	/**
+	 * Experimental string source-code compiler.
+	 * @param className
+	 * @param classCode
+	 * @param fileName
+	 */
+	public static void compile(String className, String classCode, String fileName){
+		JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
+	    DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<JavaFileObject>();
+	    
+	    List<JavaFileObject> compilationUnits = new ArrayList<JavaFileObject>();
+        JavaFileObject file = new SourceCodeFromString(className, classCode);
+        compilationUnits.add(file);
+
+	    JavaCompiler.CompilationTask task = compiler.getTask(null, null, diagnostics, null, null, compilationUnits);
+	    System.out.println(task.call() + diagnostics.getDiagnostics().toString()); //passes every time
+	}
 
 }

src/main/java/net/b07z/sepia/server/core/tools/FilesAndStreams.java

@@ -1,21 +1,22 @@
 package net.b07z.sepia.server.core.tools;
 
-import java.io.BufferedInputStream;
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
-import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Properties;
+import java.util.function.Consumer;
 
 /**
  * Handles file read/write/edit etc.
@@ -36,21 +37,62 @@ public static interface LineOperation {
 		 */
 		public String run(String lineInput);
 	}
+	
+	/**
+	 * Consume streams with custom consumer. Usage example with println:<br>
+	 * <br>
+	 * BufferedInputStreamConsumer streamGobbler = new StreamGobbler(myStream, System.out::println);<br>
+	 * Executors.newSingleThreadExecutor().submit(streamGobbler);<br>
+	 * <br>
+	 * As seen on <a href="https://www.baeldung.com/run-shell-command-in-java">baeldung.com</a>
+	 */
+	public static class BufferedInputStreamConsumer implements Runnable {
+	    private InputStream inputStream;
+	    private Consumer<String> consumer;
+	    private  Charset charset;
+	 
+	    public BufferedInputStreamConsumer(InputStream inputStream, Charset charset, Consumer<String> consumer) {
+	        this.inputStream = inputStream;
+	        this.consumer = consumer;
+	        this.charset = charset;
+	    }
+	    @Override
+	    public void run() {
+	        new BufferedReader(new InputStreamReader(inputStream, charset)).lines()
+	          .forEach(consumer);
+	    }
+	}
 
 	/**
-	 * Collect all data of an InputStream to a string.<br>
-	 * NOTE: Please define encoding of stream!
+	 * Collect all data of an InputStream to a string via BufferedReader and InputStreamReader.<br>
+	 * NOTE: Please check correct encoding of stream!
 	 */
-	public static String getStringFromStream(InputStream stream) {
-		try (BufferedReader in = new BufferedReader(new InputStreamReader(stream))) {
+	public static String getStringFromStream(InputStream stream, Charset charset) throws IOException{
+		try (BufferedReader in = new BufferedReader(new InputStreamReader(stream, charset))) {
 			String inputLine;
 			StringBuilder response = new StringBuilder();
 			while ((inputLine = in.readLine()) != null) {
-				response.append(inputLine);
+				response.append(inputLine + System.lineSeparator());
 			}
 			return response.toString();
-		} catch (IOException e) {
-			throw new RuntimeException(e);
+		}catch (IOException e){
+			throw e;
+		}
+	}
+	/**
+	 * Collect all data of an InputStream to a list, line-by-line via BufferedReader and InputStreamReader.<br>
+	 * NOTE: Please check correct encoding of stream!
+	 */
+	public static List<String> getLinesFromStream(InputStream stream, Charset charset) throws IOException{
+		try (BufferedReader in = new BufferedReader(new InputStreamReader(stream, charset))) {
+			String inputLine;
+			List<String> response = new ArrayList<>();
+			while ((inputLine = in.readLine()) != null) {
+				response.add(inputLine);
+			}
+			return response;
+		}catch (IOException e){
+			throw e;
 		}
 	}
 
@@ -141,7 +183,7 @@ public static boolean replaceLineInFile(String pathWithName, String lineMatchReg
 			Path path = Paths.get(pathWithName);
 			List<String> fileContent = new ArrayList<>(Files.readAllLines(path, StandardCharsets.UTF_8));
 			boolean foundLine = false;
-			for (int i = 0; i < fileContent.size(); i++) {
+			for (int i=0; i<fileContent.size(); i++) {
 				String line = fileContent.get(i);
 			    if (line.matches(lineMatchRegExp)) {
 			    	foundLine = true;
@@ -164,27 +206,29 @@ public static boolean replaceLineInFile(String pathWithName, String lineMatchReg
 	}
 
 	/**
-	 * Save settings to properties file.
-	 * @param config_file - path and file
+	 * Save settings to properties file (UTF-8).
+	 * @param configFile - path and file
 	 * @param config - Properties with settings to store
 	 */
-	public static void saveSettings(String config_file, Properties config) throws Exception{
-		OutputStream out =null;
-		File f = new File(config_file);
-	    out = new FileOutputStream( f );
+	public static void saveSettings(String configFile, Properties config) throws Exception{
+		File f = new File(configFile);
+		OutputStreamWriter out = new OutputStreamWriter(
+				new FileOutputStream(f), StandardCharsets.UTF_8
+		);
 	    config.store(out, null);
 	    out.flush();
 	    out.close();
 	}
 
 	/**
-	 * Load settings from properties file and return Properties.
+	 * Load settings from properties file (UTF-8) and return Properties.
 	 * @param config_file - path and file
 	 */
-	public static Properties loadSettings(String config_file) throws Exception{
-		BufferedInputStream stream=null;
+	public static Properties loadSettings(String configFile) throws Exception{
 		Properties config = new Properties();
-		stream = new BufferedInputStream(new FileInputStream(config_file));
+		InputStreamReader stream = new InputStreamReader(
+				new FileInputStream(configFile), StandardCharsets.UTF_8
+		);
 		config.load(stream);
 		stream.close();
 		return config;

src/main/java/net/b07z/sepia/server/core/tools/SourceCodeFromString.java

@@ -0,0 +1,24 @@
+package net.b07z.sepia.server.core.tools;
+
+import java.net.URI;
+
+import javax.tools.SimpleJavaFileObject;
+
+/**
+ * Class used during on-the-fly compiling of a source-code string. 
+ * 
+ * @author Florian Quirin
+ */
+public class SourceCodeFromString extends SimpleJavaFileObject {
+    final String code;
+
+    public SourceCodeFromString(String name, String code){
+        super(URI.create("string:///" + name.replace('.','/') + Kind.SOURCE.extension), Kind.SOURCE);
+        this.code = code;
+    }
+    
+    @Override
+    public CharSequence getCharContent(boolean ignoreEncodingErrors){
+        return code;
+    }
+}