com.github.tuupertunut.powershelllibjava

Class PowerShell

java.lang.Object

com.github.tuupertunut.powershelllibjava.PowerShell

All Implemented Interfaces:

Closeable, AutoCloseable

public class PowerShell
extends Object
implements Closeable

PowerShell session that can be used to execute PowerShell commands. An instance of this class can be created with open() or open(java.lang.String). Instances should always be closed with close() to free resources.

Author:

Tuupertunut

Method Summary

Modifier and Type	Method and Description
void	close() Closes this PowerShell session and frees all resources associated with it.
static String	escapePowerShellString(String s) Wraps a string in quotes and escapes all PowerShell special characters.
String	executeCommands(String... commands) Executes one or more PowerShell commands.
static PowerShell	open() Opens a new PowerShell session with default executable.
static PowerShell	open(String customExecutable) Opens a new PowerShell session with the provided executable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

open

public static PowerShell open()
                       throws IOException

Opens a new PowerShell session with default executable. On Windows, the default executable is "powershell" from Windows PowerShell, and on other platforms it is "pwsh" from PowerShell Core.

Returns:

a new PowerShell session.

Throws:

IOException - if an IOException occurred on process creation.

open

public static PowerShell open(String customExecutable)
                       throws IOException

Opens a new PowerShell session with the provided executable.

Parameters:

customExecutable - the PowerShell executable. Can be an executable name like "pwsh" or a path to the executable file.

Returns:

a new PowerShell session.

Throws:

IOException - if an IOException occurred on process creation.

close

public void close()

Closes this PowerShell session and frees all resources associated with it.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

executeCommands

public String executeCommands(String... commands)
                       throws PowerShellExecutionException,
                              IOException

Executes one or more PowerShell commands. This method will wait until all of the commands are executed, and returns the standard output. If multiple commands are given, they will be executed in order. It is also possible to break multiline commands to multiple parts, like this:

 
 executeCommands(
         "if ($cond) {",
         "    Do-Stuff",
         "}")
 
 

Internally, the commands are just joined with a semicolon ';'.

Parameters:

commands - one or more commands to execute.

Returns:

the standard output of the commands.

Throws:

PowerShellExecutionException - if a command encountered an error (wrote something to the standard error stream) while executing.

IOException - if an IOException occurred while reading the output of the commands.

IllegalStateException - if this PowerShell session was already closed, or the process or its output stream has terminated too early.

RuntimeException - if the current thread was interrupted while executing.

escapePowerShellString

public static String escapePowerShellString(String s)

Wraps a string in quotes and escapes all PowerShell special characters. This is a helper method for creating strings that will be interpreted literally by PowerShell.

Parameters:

s - the string to be escaped.

Returns:

an escaped string.