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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	KILLED_EXIT_CODE
static final int	TIMEOUT_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()
CommandControl	customCharset(Charset charset)
default boolean	discardAndCheckExit()
void	discardErr()
void	discardOrThrow()
void	discardOut()
CommandControl	doesNotObeyReturnValueConvention()
default CommandControl	elevated()
CommandControl	elevated(FailableFunction<ShellControl,Boolean,Exception> elevationFunction)
default void	execute()
CommandControl	exitTimeout(Integer timeout)
int	getExitCode()
ShellControl	getParent()
CommandControl	notComplex()
String	readOrThrow()
String	readStdoutDiscardErr()
CommandControl	sensitive()
CommandControl	start()
OutputStream	startExternalStdin()
InputStream	startExternalStdout()
CommandControl	terminalExitMode(CommandControl.TerminalExitMode mode)
boolean	waitFor()
void	withStdoutOrThrow(Charsetter.FailableConsumer<InputStreamReader,Exception> c)
CommandControl	workingDirectory(String directory)

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

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

Field Details

UNASSIGNED_EXIT_CODE

static final int UNASSIGNED_EXIT_CODE

See Also:

• Constant Field Values

TIMEOUT_EXIT_CODE

static final int TIMEOUT_EXIT_CODE

See Also:

• Constant Field Values

KILLED_EXIT_CODE

static final int KILLED_EXIT_CODE

See Also:

• Constant Field Values

Method Details

terminalExitMode

CommandControl terminalExitMode(CommandControl.TerminalExitMode mode)

doesNotObeyReturnValueConvention

CommandControl doesNotObeyReturnValueConvention()

sensitive

CommandControl sensitive()

Specified by:

sensitive in interface ProcessControl

complex

CommandControl complex()

notComplex

CommandControl notComplex()

workingDirectory

CommandControl workingDirectory(String directory)

execute

default void execute()
              throws Exception

Throws:

Exception

getParent

ShellControl getParent()

startExternalStdout

InputStream startExternalStdout()
                         throws Exception

Throws:

Exception

startExternalStdin

OutputStream startExternalStdin()
                         throws Exception

Throws:

Exception

waitFor

boolean waitFor()

customCharset

CommandControl customCharset(Charset charset)

getExitCode

int getExitCode()

elevated

default CommandControl elevated()

elevated

CommandControl elevated(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)
                throws Exception

Throws:

Exception

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)

readOrThrow

String readOrThrow()
            throws Exception

Throws:

Exception

discardAndCheckExit

default boolean discardAndCheckExit()
                             throws ProcessOutputException

Throws:

ProcessOutputException

discardOut

void discardOut()

discardErr

void discardErr()