Module xyz.ronella.casual.trivial

Package xyz.ronella.trivial.handy

Class CommandRunner

java.lang.Object

xyz.ronella.trivial.handy.CommandRunner

public final class CommandRunner
extends Object

Run external command.

Since:

2.5.0

Field Summary

Fields

Modifier and Type	Field	Description
static final BiConsumer<InputStream,InputStream>	DEFAULT_OUTPUT_LOGIC	The default output logic implementation that just simply print the output stream to System.out and error stream to System.err.
static final int	ERROR_EXIT_CODE	The ERROR_EXIT_CODE when exception occurred running the command.

Method Summary

Modifier and Type	Method	Description
static int	runCommand(String... command)	Run the commands received.
static int	runCommand(BiConsumer<InputStream,InputStream> outputLogic, String... command)	Run the commands received.
static int	runCommand(BiConsumer<InputStream,InputStream> outputLogic, ICommandArray commandArray)	Start a process based on the command received.
static int	runCommand(Consumer<ProcessBuilder> initProcessBuilder, String... command)	Run the commands received.
static int	runCommand(Consumer<ProcessBuilder> initProcessBuilder, BiConsumer<InputStream,InputStream> outputLogic, String... command)	Run the commands received.
static int	runCommand(Consumer<ProcessBuilder> initProcessBuilder, BiConsumer<InputStream,InputStream> outputLogic, ICommandArray commandArray)	Run the commands received.
static int	runCommand(Consumer<ProcessBuilder> initProcessBuilder, ICommandArray commandArray)	Run the commands received.
static int	runCommand(Supplier<ProcessBuilder> createProcessBuilder, String... command)	Run the commands received.
static int	runCommand(Supplier<ProcessBuilder> createProcessBuilder, BiConsumer<InputStream,InputStream> outputLogic, String... command)	Run the commands received.
static int	runCommand(Supplier<ProcessBuilder> createProcessBuilder, BiConsumer<InputStream,InputStream> outputLogic, ICommandArray commandArray)	Run the commands received.
static int	runCommand(Supplier<ProcessBuilder> createProcessBuilder, ICommandArray commandArray)	Run the commands received.
static int	runCommand(ICommandArray commandArray)	Run the commands received.
static Process	startProcess(Consumer<Process> initProcess, ICommandArray commandArray)	Start a process based on the command received.
static Process	startProcess(Consumer<ProcessBuilder> initProcessBuilder, Consumer<Process> initProcess, ICommandArray commandArray)	Start a process based on the command received.
static Process	startProcess(Supplier<ProcessBuilder> createProcessBuilder, Consumer<Process> initProcess, BiConsumer<InputStream,InputStream> outputLogic, ICommandArray commandArray)	Start a process based on the command received.
static Process	startProcess(Supplier<ProcessBuilder> createProcessBuilder, Consumer<Process> initProcess, ICommandArray commandArray)	Start a process based on the command received.
static Process	startProcess(ICommandArray commandArray)	Start a process based on the command received.

Methods inherited from class java.lang.Object

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

Field Details

ERROR_EXIT_CODE

public static final int ERROR_EXIT_CODE

The ERROR_EXIT_CODE when exception occurred running the command.

See Also:

• Constant Field Values

DEFAULT_OUTPUT_LOGIC

public static final BiConsumer<InputStream,InputStream> DEFAULT_OUTPUT_LOGIC

The default output logic implementation that just simply print the output stream to System.out and error stream to System.err.

Method Details

runCommand

public static int runCommand(Supplier<ProcessBuilder> createProcessBuilder,
 String... command)
                      throws MissingCommandException

Run the commands received.

Parameters:

createProcessBuilder - Manually creates an instance of ProcessBuilder.

command - The commands to be executed.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

runCommand

public static int runCommand(Supplier<ProcessBuilder> createProcessBuilder,
 ICommandArray commandArray)
                      throws MissingCommandException

Run the commands received.

Parameters:

createProcessBuilder - Manually creates an instance of ProcessBuilder.

commandArray - An implementation of ICommandArray.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.10.0

runCommand

public static int runCommand(Consumer<ProcessBuilder> initProcessBuilder,
 String... command)
                      throws MissingCommandException

Run the commands received.

Parameters:

initProcessBuilder - Must hold the additional initialization logic for ProcessBuilder.

command - The commands to be executed.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.13.0

runCommand

public static int runCommand(Consumer<ProcessBuilder> initProcessBuilder,
 ICommandArray commandArray)
                      throws MissingCommandException

Run the commands received.

Parameters:

initProcessBuilder - Must hold the additional initialization logic for ProcessBuilder.

commandArray - An implementation of ICommandArray.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.10.0

runCommand

public static int runCommand(ICommandArray commandArray)
                      throws MissingCommandException

Run the commands received.

Parameters:

commandArray - An implementation of ICommandArray.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.10.0

runCommand

public static int runCommand(String... command)
                      throws MissingCommandException

Run the commands received.

Parameters:

command - The commands to be executed.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

runCommand

public static int runCommand(BiConsumer<InputStream,InputStream> outputLogic,
 String... command)
                      throws MissingCommandException

Run the commands received.

Parameters:

command - The commands to be executed.

outputLogic - Must hold the logic on dealing with the output and error result.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

runCommand

public static int runCommand(BiConsumer<InputStream,InputStream> outputLogic,
 ICommandArray commandArray)
                      throws MissingCommandException

Start a process based on the command received.

Parameters:

commandArray - An implementation of ICommandArray.

outputLogic - Must hold the logic on dealing with the output and error result.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.10.0

startProcess

public static Process startProcess(Consumer<Process> initProcess,
 ICommandArray commandArray)
                            throws MissingCommandException,
CommandRunnerException

Start a process based on the command received.

Parameters:

commandArray - An implementation of ICommandArray.

initProcess - Manually initialize the instance of Process.

Returns:

An instance of Process.

Throws:

MissingCommandException - Thrown when no command was passed.

CommandRunnerException - Thrown when CommandRunner encountered an error.

Since:

2.13.0

startProcess

public static Process startProcess(ICommandArray commandArray)
                            throws MissingCommandException,
CommandRunnerException

Start a process based on the command received.

Parameters:

commandArray - An implementation of ICommandArray.

Returns:

An instance of Process.

Throws:

MissingCommandException - Thrown when no command was passed.

CommandRunnerException - Thrown when CommandRunner encountered an error.

Since:

2.14.0

runCommand

public static int runCommand(Consumer<ProcessBuilder> initProcessBuilder,
 BiConsumer<InputStream,InputStream> outputLogic,
 String... command)
                      throws MissingCommandException

Run the commands received.

Parameters:

initProcessBuilder - Must hold the additional initialization logic for ProcessBuilder.

outputLogic - Must hold the logic on dealing with the output and error result.

command - The commands to be executed.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

runCommand

public static int runCommand(Consumer<ProcessBuilder> initProcessBuilder,
 BiConsumer<InputStream,InputStream> outputLogic,
 ICommandArray commandArray)
                      throws MissingCommandException

Run the commands received.

Parameters:

initProcessBuilder - Must hold the additional initialization logic for ProcessBuilder.

outputLogic - Must hold the logic on dealing with the output and error result.

commandArray - An implementation of ICommandArray.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.10.0

startProcess

public static Process startProcess(Consumer<ProcessBuilder> initProcessBuilder,
 Consumer<Process> initProcess,
 ICommandArray commandArray)
                            throws MissingCommandException,
CommandRunnerException

Start a process based on the command received.

Parameters:

initProcessBuilder - Must hold the additional initialization logic for ProcessBuilder.

initProcess - Manually initialize the instance of Process.

commandArray - An implementation of ICommandArray.

Returns:

An instance of Process.

Throws:

MissingCommandException - Thrown when no command was passed.

CommandRunnerException - Thrown when CommandRunner encountered an error.

Since:

2.13.0

runCommand

public static int runCommand(Supplier<ProcessBuilder> createProcessBuilder,
 BiConsumer<InputStream,InputStream> outputLogic,
 ICommandArray commandArray)
                      throws MissingCommandException

Run the commands received.

Parameters:

createProcessBuilder - Manually creates an instance of ProcessBuilder.

outputLogic - Must hold the logic on dealing with the output and error result.

commandArray - An implementation of ICommandArray.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

Since:

2.10.0

startProcess

public static Process startProcess(Supplier<ProcessBuilder> createProcessBuilder,
 Consumer<Process> initProcess,
 ICommandArray commandArray)
                            throws MissingCommandException,
CommandRunnerException

Start a process based on the command received.

Parameters:

createProcessBuilder - Manually creates an instance of ProcessBuilder.

initProcess - Manually initialize the instance of Process.

commandArray - An implementation of ICommandArray.

Returns:

An instance of Process.

Throws:

MissingCommandException - Thrown when no command was passed.

CommandRunnerException - Thrown when CommandRunner encountered an error.

Since:

2.13.0

runCommand

public static int runCommand(Supplier<ProcessBuilder> createProcessBuilder,
 BiConsumer<InputStream,InputStream> outputLogic,
 String... command)
                      throws MissingCommandException

Run the commands received.

Parameters:

createProcessBuilder - Manually creates an instance of ProcessBuilder.

outputLogic - Must hold the logic on dealing with the output and error result.

command - The commands to be executed.

Returns:

The exit code after the completion of the process.

Throws:

MissingCommandException - Thrown when no command was passed.

startProcess

public static Process startProcess(Supplier<ProcessBuilder> createProcessBuilder,
 Consumer<Process> initProcess,
 BiConsumer<InputStream,InputStream> outputLogic,
 ICommandArray commandArray)
                            throws MissingCommandException,
CommandRunnerException

Start a process based on the command received.

Parameters:

createProcessBuilder - Manually creates an instance of ProcessBuilder.

initProcess - Manually initialize the instance of Process.

outputLogic - Must hold the logic on dealing with the output and error result.

commandArray - An implementation of ICommandArray.

Returns:

An instance of Process.

Throws:

MissingCommandException - Thrown when no command was passed.

CommandRunnerException - Thrown when CommandRunner encountered an error.

Since:

2.13.0