Module io.xpipe.core

Package io.xpipe.core.process

Interface CommandControl

All Superinterfaces:

AutoCloseable, 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	ELEVATION_FAILED_EXIT_CODE
static final int	EXIT_TIMEOUT_EXIT_CODE
static final int	INTERNAL_ERROR_EXIT_CODE
static final int	START_FAILED_EXIT_CODE
static final int	UNASSIGNED_EXIT_CODE

Method Summary

Modifier and Type	Method	Description
CommandControl	complex()
default boolean	discardAndCheckExit()
void	discardOrThrow()
CommandControl	doesNotObeyReturnValueConvention()
CommandControl	elevated(ElevationFunction function)
default void	execute()
default boolean	executeAndCheck()
long	getExitCode()
ShellControl	getParent()
CommandControl	notComplex()
byte[]	readRawBytesOrThrow()
String[]	readStdoutAndStderr()
Optional<String>	readStdoutIfPossible()
String	readStdoutOrThrow()
void	setExitTimeout(Duration duration)
void	setSensitive()
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)
CommandControl	withWorkingDirectory(String directory)

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

close, closeStdin, getCharset, getShellDialect, getStderr, getStdin, getStdout, getUuid, isAnyStreamClosed, isRunning, kill, prepareTerminalOpen, refreshRunningState, resetData, shutdown

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

INTERNAL_ERROR_EXIT_CODE

static final int INTERNAL_ERROR_EXIT_CODE

See Also:

• Constant Field Values

ELEVATION_FAILED_EXIT_CODE

static final int ELEVATION_FAILED_EXIT_CODE

See Also:

• Constant Field Values

Method Details

setSensitive

void setSensitive()

withExceptionConverter

CommandControl withExceptionConverter(ProcessControl.ExceptionConverter converter)

Specified by:

withExceptionConverter in interface ProcessControl

start

CommandControl start()
              throws Exception

Specified by:

start in interface ProcessControl

Throws:

Exception

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

setExitTimeout

void setExitTimeout(Duration duration)

waitFor

boolean waitFor()

withCustomCharset

CommandControl withCustomCharset(Charset charset)

getExitCode

long getExitCode()

elevated

CommandControl elevated(ElevationFunction function)

readStdoutAndStderr

String[] readStdoutAndStderr()
                      throws Exception

Throws:

Exception

discardOrThrow

void discardOrThrow()
             throws Exception

Throws:

Exception

readRawBytesOrThrow

byte[] readRawBytesOrThrow()
                    throws Exception

Throws:

Exception

readStdoutOrThrow

String readStdoutOrThrow()
                  throws Exception

Throws:

Exception

readStdoutIfPossible

Optional<String> readStdoutIfPossible()
                               throws Exception

Throws:

Exception

discardAndCheckExit

default boolean discardAndCheckExit()
                             throws ProcessOutputException

Throws:

ProcessOutputException