Module io.xpipe.core

Package io.xpipe.core.process

Interface ShellControl

All Superinterfaces:

AutoCloseable, Closeable, ProcessControl

public interface ShellControl
extends ProcessControl

Method Summary

Modifier and Type	Method	Description
void	cd(String directory)
void	checkRunning()
CommandControl	command(FailableFunction<ShellControl,String,Exception> command)
CommandControl	command(FailableFunction<ShellControl,String,Exception> command, FailableFunction<ShellControl,String,Exception> terminalCommand)
default CommandControl	command(String... command)
default CommandControl	command(List<String> command)
ShellControl	elevated(FailableFunction<ShellControl,Boolean,Exception> elevationFunction)
ShellControl	elevationPassword(SecretValue value)
default boolean	executeBooleanSimpleCommand(String command)
void	executeLine(String command)
default void	executeSimpleCommand(String command)
default void	executeSimpleCommand(String command, String failMessage)
default String	executeStringSimpleCommand(ShellDialect type, String command)
default String	executeStringSimpleCommand(String command)
void	exitAndWait()
Semaphore	getCommandLock()
SecretValue	getElevationPassword()
OsType	getOsType()
String	getTemporaryDirectory()
ShellControl	initWith(List<String> cmds)
boolean	isLocal()
void	onInit(Consumer<ShellControl> pc)
String	prepareIntermediateTerminalOpen(String content)
String	prepareTerminalOpen()
void	restart()
ShellControl	start()
default ShellControl	subShell(@NonNull ShellDialect type)
ShellControl	subShell(FailableFunction<ShellControl,String,Exception> command, FailableBiFunction<ShellControl,String,String,Exception> terminalCommand)
default ShellControl	subShell(@NonNull String command)
default ShellControl	subShell(@NonNull List<String> command)

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

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

Method Details

getCommandLock

Semaphore getCommandLock()

onInit

void onInit(Consumer<ShellControl> pc)

prepareTerminalOpen

String prepareTerminalOpen()
                    throws Exception

Specified by:

prepareTerminalOpen in interface ProcessControl

Throws:

Exception

prepareIntermediateTerminalOpen

String prepareIntermediateTerminalOpen(String content)
                                throws Exception

Throws:

Exception

getTemporaryDirectory

String getTemporaryDirectory()
                      throws Exception

Throws:

Exception

checkRunning

void checkRunning()
           throws Exception

Throws:

Exception

executeStringSimpleCommand

default String executeStringSimpleCommand(String command)
                                   throws Exception

Throws:

Exception

executeBooleanSimpleCommand

default boolean executeBooleanSimpleCommand(String command)
                                     throws Exception

Throws:

Exception

executeSimpleCommand

default void executeSimpleCommand(String command)
                           throws Exception

Throws:

Exception

executeSimpleCommand

default void executeSimpleCommand(String command,
 String failMessage)
                           throws Exception

Throws:

Exception

executeStringSimpleCommand

default String executeStringSimpleCommand(ShellDialect type,
 String command)
                                   throws Exception

Throws:

Exception

restart

void restart()
      throws Exception

Throws:

Exception

isLocal

boolean isLocal()

getOsType

OsType getOsType()

elevated

ShellControl elevated(FailableFunction<ShellControl,Boolean,Exception> elevationFunction)

elevationPassword

ShellControl elevationPassword(SecretValue value)

initWith

ShellControl initWith(List<String> cmds)

getElevationPassword

SecretValue getElevationPassword()

subShell

default ShellControl subShell(@NonNull
 @NonNull ShellDialect type)

subShell

default ShellControl subShell(@NonNull
 @NonNull List<String> command)

subShell

default ShellControl subShell(@NonNull
 @NonNull String command)

subShell

ShellControl subShell(FailableFunction<ShellControl,String,Exception> command,
 FailableBiFunction<ShellControl,String,String,Exception> terminalCommand)

executeLine

void executeLine(String command)
          throws Exception

Throws:

Exception

cd

void cd(String directory)
 throws Exception

Throws:

Exception

start

ShellControl start()
            throws Exception

Specified by:

start in interface ProcessControl

Throws:

Exception

command

CommandControl command(FailableFunction<ShellControl,String,Exception> command)

command

CommandControl command(FailableFunction<ShellControl,String,Exception> command,
 FailableFunction<ShellControl,String,Exception> terminalCommand)

command

default CommandControl command(String... command)

command

default CommandControl command(List<String> command)

exitAndWait

void exitAndWait()
          throws IOException

Throws:

IOException