feat: optimized performance; replaced deprecated api usage in tests;

Author: AutoComplete1

README.md

@@ -7,25 +7,25 @@ jPowerShell2 is a fork of [jPowerShell](https://github.com/profesorfalken/jPower
 
 ## 💻 Installation
 
-To install jPowerShell you can add the dependecy to your software project management tool: https://search.maven.org/artifact/io.github.autocomplete1/jPowerShell2/1.0.1/jar
+To install jPowerShell you can add the dependecy to your software project management tool: https://search.maven.org/artifact/io.github.autocomplete1/jPowerShell2/1.0.2/jar
 
 Maven:
  ```
 <dependency> 
     <groupId>io.github.autocomplete1</groupId>
     <artifactId>jPowerShell2</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
     <scope>compile</scope>
 </dependency> 
 ``` 
 
 Gradle:
 ```
-implementation 'io.github.autocomplete1:jPowerShell2:1.0.1'
+implementation 'io.github.autocomplete1:jPowerShell2:1.0.2'
 ```
 
 Instead, you can direct download the JAR file and add it to your classpath.   
-https://repo1.maven.org/maven2/io/github/autocomplete1/jPowerShell2/1.0.1/jPowerShell2-1.0.1.jar
+https://repo1.maven.org/maven2/io/github/autocomplete1/jPowerShell2/1.0.2/jPowerShell2-1.0.2.jar
 
 ## ⚡️ Usage
 

build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group = 'io.github.autocomplete1'
-version = '1.0.1'
+version = '1.0.2'
 description = 'Simple Java API to interact with PowerShell console'
 java.sourceCompatibility = JavaVersion.VERSION_1_8
 

src/main/java/io/github/autocomplete1/PowerShell.java

@@ -46,6 +46,8 @@ public class PowerShell implements AutoCloseable {
     // Writer to send commands
     private PrintWriter commandWriter;
 
+    private BufferedReader outputReader;
+
     // Threaded session variables
     private boolean closed = false;
     private ExecutorService executorService;
@@ -68,7 +70,7 @@ private PowerShell() {
     }
 
     /**
-     * Allows to override jPowerShell configuration using a map of key/value <br>
+     * Allows overriding jPowerShell configuration using a map of key/value <br>
      * Default values are taken from file <i>jpowershell.properties</i>, which can
      * be replaced just setting it on project classpath
      * <p>
@@ -114,8 +116,8 @@ public PowerShell configuration(Map<String, String> config) {
     }
 
     /**
-     * Creates a session in PowerShell console an returns an instance which allows
-     * to execute commands in PowerShell context.<br>
+     * Creates a session in PowerShell console which returns an instance which allows
+     * executing commands in PowerShell context.<br>
      * It uses the default PowerShell installation in the system.
      *
      * @return an instance of the class
@@ -126,8 +128,8 @@ public static PowerShell openSession() throws PowerShellNotAvailableException {
     }
 
     /**
-     * Creates a session in PowerShell console an returns an instance which allows
-     * to execute commands in PowerShell context.<br>
+     * Creates a session in PowerShell console which returns an instance which allows
+     * executing commands in PowerShell context.<br>
      * This method allows to define a PowersShell executable path different from default
      *
      * @param customPowerShellExecutablePath the path of powershell executable. If you are using
@@ -140,8 +142,8 @@ public static PowerShell openSession(String customPowerShellExecutablePath) thro
     }
 
     /**
-     * Creates a session in PowerShell console an returns an instance which allows
-     * to execute commands in PowerShell context.<br>
+     * Creates a session in PowerShell console which returns an instance which allows
+     * executing commands in PowerShell context.<br>
      * This method allows to define a PowersShell executable path different from default
      *
      * @param customPowerShellExecutablePath the path of powershell executable. If you are using
@@ -158,11 +160,11 @@ public static PowerShell openSession(String customPowerShellExecutablePath, Map<
 
         String powerShellExecutablePath = customPowerShellExecutablePath == null ? (OSDetector.isWindows() ? DEFAULT_WIN_EXECUTABLE : DEFAULT_LINUX_EXECUTABLE) : customPowerShellExecutablePath;
 
-        return powerShell.initalize(powerShellExecutablePath);
+        return powerShell.initialize(powerShellExecutablePath);
     }
 
     // Initializes PowerShell console in which we will enter the commands
-    private PowerShell initalize(String powerShellExecutablePath) throws PowerShellNotAvailableException {
+    private PowerShell initialize(String powerShellExecutablePath) throws PowerShellNotAvailableException {
         String codePage = PowerShellCodepage.getIdentifierByCodePageName(Charset.defaultCharset().name());
         ProcessBuilder pb;
 
@@ -193,6 +195,8 @@ private PowerShell initalize(String powerShellExecutablePath) throws PowerShellN
         //Prepare writer that will be used to send commands to powershell
         this.commandWriter = new PrintWriter(new OutputStreamWriter(new BufferedOutputStream(p.getOutputStream())), true);
 
+        this.outputReader = new BufferedReader(new InputStreamReader(p.getInputStream()));
+
         // Init thread pool. 2 threads are needed: one to write and read console and the other to close it
         this.executorService = Executors.newFixedThreadPool(2);
 
@@ -219,8 +223,7 @@ public PowerShellResponse executeCommand(String command) {
 
         checkState();
 
-        PowerShellCommandProcessor commandProcessor = new PowerShellCommandProcessor("standard", p.getInputStream(),
-                this.waitPause, this.scriptMode);
+        PowerShellCommandProcessor commandProcessor = new PowerShellCommandProcessor(this.outputReader, this.waitPause, this.scriptMode);
         Future<String> result = executorService.submit(commandProcessor);
 
         // Launch command
@@ -251,7 +254,7 @@ public PowerShellResponse executeCommand(String command) {
     }
 
     /**
-     * Execute a single command in PowerShell consolscriptModee and gets result
+     * Execute a single command in PowerShell console scriptMode and gets result
      *
      * @param command the command to execute
      * @return response with the output of the command
@@ -269,7 +272,7 @@ public static PowerShellResponse executeSingleCommand(String command) {
     }
 
     /**
-     * Allows to chain command executions providing a more fluent API.<p>
+     * Allows chaining command executions providing a more fluent API.<p>
      * <p>
      * This method allows also to optionally handle the response in a closure
      *
@@ -447,7 +450,7 @@ public void close() {
                 commandWriter.close();
                 try {
                     if (p.isAlive()) {
-                        p.getInputStream().close();
+                        outputReader.close();
                     }
                 } catch (IOException ex) {
                     logger.log(Level.SEVERE,

src/main/java/io/github/autocomplete1/PowerShellCommandProcessor.java

@@ -17,8 +17,6 @@
 
 import java.io.BufferedReader;
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.util.concurrent.Callable;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -33,25 +31,23 @@ class PowerShellCommandProcessor implements Callable<String> {
 
     private static final String CRLF = "\r\n";
 
-    private final BufferedReader reader;
-
     private boolean closed = false;
 
+    private final BufferedReader outputReader;
+
     private final boolean scriptMode;
 
     private final int waitPause;
 
     /**
      * Constructor that takes the output and the input of the PowerShell session
      *
-     * @param name        the name of the CommandProcessor
-     * @param inputStream the stream needed to read the command output
-     * @param waitPause   long the wait pause in milliseconds
-     * @param scriptMode  boolean indicates if the command executes a script
+     * @param outputReader outputReader of the powershell session
+     * @param waitPause    long the wait pause in milliseconds
+     * @param scriptMode   boolean indicates if the command executes a script
      */
-    public PowerShellCommandProcessor(String name, InputStream inputStream, int waitPause, boolean scriptMode) {
-        this.reader = new BufferedReader(new InputStreamReader(
-                inputStream));
+    public PowerShellCommandProcessor(BufferedReader outputReader, int waitPause, boolean scriptMode) {
+        this.outputReader = outputReader;
         this.waitPause = waitPause;
         this.scriptMode = scriptMode;
     }
@@ -81,9 +77,9 @@ public String call() throws InterruptedException {
     //Reads all data from output
     private void readData(StringBuilder powerShellOutput) throws IOException {
         String line;
-        while (null != (line = this.reader.readLine())) {
+        while (null != (line = this.outputReader.readLine())) {
 
-            //In the case of script mode it finish when the last line is read
+            //In the case of script mode it finishes when the last line is read
             if (this.scriptMode) {
                 if (line.equals(PowerShell.END_SCRIPT_STRING)) {
                     break;
@@ -108,7 +104,7 @@ private void readData(StringBuilder powerShellOutput) throws IOException {
     //Checks when we can start reading the output. Timeout if it takes too long in order to avoid hangs
     private boolean startReading() throws IOException, InterruptedException {
         //If the reader is not ready, gives it some milliseconds
-        while (!this.reader.ready()) {
+        while (!this.outputReader.ready()) {
             Thread.sleep(this.waitPause);
             if (this.closed) {
                 return false;
@@ -117,20 +113,20 @@ private boolean startReading() throws IOException, InterruptedException {
         return true;
     }
 
-    //Checks when we the reader can continue to read.
+    //Checks when we have the reader can continue to read.
     private boolean canContinueReading() throws IOException, InterruptedException {
         //If the reader is not ready, gives it some milliseconds
         //It is important to do that, because the ready method guarantees that the readline will not be blocking
-        if (!this.reader.ready()) {
+        if (!this.outputReader.ready()) {
             Thread.sleep(this.waitPause);
         }
 
         //If not ready yet, wait a moment to make sure it is finished
-        if (!this.reader.ready()) {
+        if (!this.outputReader.ready()) {
             Thread.sleep(50);
         }
 
-        return this.reader.ready();
+        return this.outputReader.ready();
     }
 
     /**

src/main/java/io/github/autocomplete1/PowerShellResponse.java

@@ -16,7 +16,7 @@
 package io.github.autocomplete1;
 
 /**
- * Response of PowerShell command. This object encapsulate all the useful
+ * Response of PowerShell command. This object encapsulates all the useful
  * returned information
  *
  * @author Javier Garcia Alonso