Module io.xpipe.core

Package io.xpipe.core.process

Interface CommandControl

All Superinterfaces:

AutoCloseable, Closeable, ProcessControl

public interface CommandControl
extends ProcessControl

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CommandControl.TerminalExitMode

Nested classes/interfaces inherited from interface io.xpipe.core.process.ProcessControl

ProcessControl.ExceptionConverter

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXIT_TIMEOUT_EXIT_CODE
static final int	START_FAILED_EXIT_CODE
static final int	UNASSIGNED_EXIT_CODE

Method Summary

Modifier and Type	Method	Description
void	accumulateStderr(Consumer<String> con)
void	accumulateStdout(Consumer<String> con)
CommandControl	complex()
default boolean	discardAndCheckExit()
void	discardErr()
void	discardOrThrow()
void	discardOut()
CommandControl	doesNotObeyReturnValueConvention()
default CommandControl	elevated(String message)
CommandControl	elevated(String message, FailableFunction<ShellControl,Boolean,Exception> elevationFunction)
default void	execute()
default boolean	executeAndCheck()
CommandControl	exitTimeout(Integer timeout)
int	getExitCode()
ShellControl	getParent()
CommandControl	notComplex()
byte[]	readRawBytesOrThrow()
String	readStdoutDiscardErr()
String	readStdoutOrThrow()
CommandControl	start()
OutputStream	startExternalStdin()
InputStream	startExternalStdout()
CommandControl	terminalExitMode(CommandControl.TerminalExitMode mode)
boolean	waitFor()
CommandControl	withCustomCharset(Charset charset)
CommandControl	withErrorFormatter(Function<String,String> formatter)
CommandControl	withExceptionConverter(ProcessControl.ExceptionConverter converter)
void	withStdoutOrThrow(Charsetter.FailableConsumer<InputStreamReader,Exception> c)
CommandControl	withWorkingDirectory(String directory)

Methods inherited from interface io.xpipe.core.process.ProcessControl

close, closeStdin, getCharset, getShellDialect, getStderr, getStderrReader, getStdin, getStdout, getStdoutReader, isRunning, isStdinClosed, kill, prepareTerminalOpen, resetData, write, writeLine

Field Details

UNASSIGNED_EXIT_CODE

static final int UNASSIGNED_EXIT_CODE

See Also:

• Constant Field Values

EXIT_TIMEOUT_EXIT_CODE

static final int EXIT_TIMEOUT_EXIT_CODE

See Also:

• Constant Field Values

START_FAILED_EXIT_CODE

static final int START_FAILED_EXIT_CODE

See Also:

• Constant Field Values

Method Details

withExceptionConverter

CommandControl withExceptionConverter(ProcessControl.ExceptionConverter converter)

Specified by:

withExceptionConverter in interface ProcessControl

withErrorFormatter

CommandControl withErrorFormatter(Function<String,String> formatter)

terminalExitMode

CommandControl terminalExitMode(CommandControl.TerminalExitMode mode)

doesNotObeyReturnValueConvention

CommandControl doesNotObeyReturnValueConvention()

complex

CommandControl complex()

notComplex

CommandControl notComplex()

withWorkingDirectory

CommandControl withWorkingDirectory(String directory)

execute

default void execute()
              throws Exception

Throws:

Exception

executeAndCheck

default boolean executeAndCheck()
                         throws Exception

Throws:

Exception

getParent

ShellControl getParent()

startExternalStdout

InputStream startExternalStdout()
                         throws Exception

Throws:

Exception

startExternalStdin

OutputStream startExternalStdin()
                         throws Exception

Throws:

Exception

waitFor

boolean waitFor()

withCustomCharset

CommandControl withCustomCharset(Charset charset)

getExitCode

int getExitCode()

elevated

default CommandControl elevated(String message)

elevated

CommandControl elevated(String message,
 FailableFunction<ShellControl,Boolean,Exception> elevationFunction)

start

CommandControl start()
              throws Exception

Specified by:

start in interface ProcessControl

Throws:

Exception

exitTimeout

CommandControl exitTimeout(Integer timeout)

withStdoutOrThrow

void withStdoutOrThrow(Charsetter.FailableConsumer<InputStreamReader,Exception> c)

readStdoutDiscardErr

String readStdoutDiscardErr()
                     throws Exception

Throws:

Exception

discardOrThrow

void discardOrThrow()
             throws Exception

Throws:

Exception

accumulateStdout

void accumulateStdout(Consumer<String> con)

accumulateStderr

void accumulateStderr(Consumer<String> con)

readRawBytesOrThrow

byte[] readRawBytesOrThrow()
                    throws Exception

Throws:

Exception

readStdoutOrThrow

String readStdoutOrThrow()
                  throws Exception

Throws:

Exception

discardAndCheckExit

default boolean discardAndCheckExit()
                             throws ProcessOutputException

Throws:

ProcessOutputException

discardOut

void discardOut()

discardErr

void discardErr()