Shell.Builder (libsuperuser 1.0.0.201704021214 API)

java.lang.Object
- eu.chainfire.libsuperuser.Shell.Builder

Enclosing class:: Shell

public static class Shell.Builder
extends java.lang.Object

Builder class for Shell.Interactive

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Shell.Builder`	`addCommand(java.util.List<java.lang.String> commands)` Add commands to execute
`Shell.Builder`	`addCommand(java.util.List<java.lang.String> commands, int code, Shell.OnCommandResultListener onCommandResultListener)` Add commands to execute, with a callback to be called on completion (of all commands)
`Shell.Builder`	`addCommand(java.lang.String command)` Add a command to execute
`Shell.Builder`	`addCommand(java.lang.String[] commands)` Add commands to execute
`Shell.Builder`	`addCommand(java.lang.String[] commands, int code, Shell.OnCommandResultListener onCommandResultListener)` Add commands to execute, with a callback to be called on completion (of all commands)
`Shell.Builder`	`addCommand(java.lang.String command, int code, Shell.OnCommandResultListener onCommandResultListener)` Add a command to execute, with a callback to be called on completion
`Shell.Builder`	`addEnvironment(java.util.Map<java.lang.String,java.lang.String> addEnvironment)` Add or update environment variables
`Shell.Builder`	`addEnvironment(java.lang.String key, java.lang.String value)` Add or update an environment variable
`Shell.Interactive`	`open()` Construct a `Shell.Interactive` instance, and start the shell
`Shell.Interactive`	`open(Shell.OnCommandResultListener onCommandResultListener)` Construct a `Shell.Interactive` instance, try to start the shell, and call onCommandResultListener to report success or failure
`Shell.Builder`	`setAutoHandler(boolean autoHandler)` Automatically create a handler if possible ? Default to true
`Shell.Builder`	`setHandler(android.os.Handler handler)` Set a custom handler that will be used to post all callbacks to
`Shell.Builder`	`setMinimalLogging(boolean useMinimal)` Enable/disable reduced logcat output
`Shell.Builder`	`setOnSTDERRLineListener(StreamGobbler.OnLineListener onLineListener)` Set a callback called for every line output to STDERR by the shell
`Shell.Builder`	`setOnSTDOUTLineListener(StreamGobbler.OnLineListener onLineListener)` Set a callback called for every line output to STDOUT by the shell
`Shell.Builder`	`setShell(java.lang.String shell)` Set shell binary to use.
`Shell.Builder`	`setWantSTDERR(boolean wantSTDERR)` Set if error output should be appended to command block result output
`Shell.Builder`	`setWatchdogTimeout(int watchdogTimeout)` Enable command timeout callback
`Shell.Builder`	`useSH()` Convenience function to set "sh" as used shell
`Shell.Builder`	`useSU()` Convenience function to set "su" as used shell

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - setHandler
```
public Shell.Builder setHandler(android.os.Handler handler)
```
    Set a custom handler that will be used to post all callbacks to
    
    See Shell.Interactive for further details on threading and handlers
    
    Parameters:
    
    handler - Handler to use
    
    Returns:
    
    This Builder object for method chaining
  - setAutoHandler
```
public Shell.Builder setAutoHandler(boolean autoHandler)
```
    Automatically create a handler if possible ? Default to true
    
    See Shell.Interactive for further details on threading and handlers
    
    Parameters:
    
    autoHandler - Auto-create handler ?
    
    Returns:
    
    This Builder object for method chaining
  - setShell
```
public Shell.Builder setShell(java.lang.String shell)
```
    Set shell binary to use. Usually "sh" or "su", do not use a full path unless you have a good reason to
    
    Parameters:
    
    shell - Shell to use
    
    Returns:
    
    This Builder object for method chaining
  - useSH
```
public Shell.Builder useSH()
```
    Convenience function to set "sh" as used shell
    
    Returns:
    
    This Builder object for method chaining
  - useSU
```
public Shell.Builder useSU()
```
    Convenience function to set "su" as used shell
    
    Returns:
    
    This Builder object for method chaining
  - setWantSTDERR
```
public Shell.Builder setWantSTDERR(boolean wantSTDERR)
```
    Set if error output should be appended to command block result output
    
    Parameters:
    
    wantSTDERR - Want error output ?
    
    Returns:
    
    This Builder object for method chaining
  - addEnvironment
```
public Shell.Builder addEnvironment(java.lang.String key,
                                    java.lang.String value)
```
    Add or update an environment variable
    
    Parameters:
    
    key - Key of the environment variable
    
    value - Value of the environment variable
    
    Returns:
    
    This Builder object for method chaining
  - addEnvironment
```
public Shell.Builder addEnvironment(java.util.Map<java.lang.String,java.lang.String> addEnvironment)
```
    Add or update environment variables
    
    Parameters:
    
    addEnvironment - Map of environment variables
    
    Returns:
    
    This Builder object for method chaining
  - addCommand
```
public Shell.Builder addCommand(java.lang.String command)
```
    Add a command to execute
    
    Parameters:
    
    command - Command to execute
    
    Returns:
    
    This Builder object for method chaining
  - addCommand
```
public Shell.Builder addCommand(java.lang.String command,
                                int code,
                                Shell.OnCommandResultListener onCommandResultListener)
```
    Add a command to execute, with a callback to be called on completion
    
    The thread on which the callback executes is dependent on various factors, see Shell.Interactive for further details
    
    Parameters:
    
    command - Command to execute
    
    code - User-defined value passed back to the callback
    
    onCommandResultListener - Callback to be called on completion
    
    Returns:
    
    This Builder object for method chaining
  - addCommand
```
public Shell.Builder addCommand(java.util.List<java.lang.String> commands)
```
    Add commands to execute
    
    Parameters:
    
    commands - Commands to execute
    
    Returns:
    
    This Builder object for method chaining
  - addCommand
```
public Shell.Builder addCommand(java.util.List<java.lang.String> commands,
                                int code,
                                Shell.OnCommandResultListener onCommandResultListener)
```
    Add commands to execute, with a callback to be called on completion (of all commands)
    
    The thread on which the callback executes is dependent on various factors, see Shell.Interactive for further details
    
    Parameters:
    
    commands - Commands to execute
    
    code - User-defined value passed back to the callback
    
    onCommandResultListener - Callback to be called on completion (of all commands)
    
    Returns:
    
    This Builder object for method chaining
  - addCommand
```
public Shell.Builder addCommand(java.lang.String[] commands)
```
    Add commands to execute
    
    Parameters:
    
    commands - Commands to execute
    
    Returns:
    
    This Builder object for method chaining
  - addCommand
```
public Shell.Builder addCommand(java.lang.String[] commands,
                                int code,
                                Shell.OnCommandResultListener onCommandResultListener)
```
    Add commands to execute, with a callback to be called on completion (of all commands)
    
    The thread on which the callback executes is dependent on various factors, see Shell.Interactive for further details
    
    Parameters:
    
    commands - Commands to execute
    
    code - User-defined value passed back to the callback
    
    onCommandResultListener - Callback to be called on completion (of all commands)
    
    Returns:
    
    This Builder object for method chaining
  - setOnSTDOUTLineListener
```
public Shell.Builder setOnSTDOUTLineListener(StreamGobbler.OnLineListener onLineListener)
```
    Set a callback called for every line output to STDOUT by the shell
    
    The thread on which the callback executes is dependent on various factors, see Shell.Interactive for further details
    
    Parameters:
    
    onLineListener - Callback to be called for each line
    
    Returns:
    
    This Builder object for method chaining
  - setOnSTDERRLineListener
```
public Shell.Builder setOnSTDERRLineListener(StreamGobbler.OnLineListener onLineListener)
```
    Set a callback called for every line output to STDERR by the shell
    
    The thread on which the callback executes is dependent on various factors, see Shell.Interactive for further details
    
    Parameters:
    
    onLineListener - Callback to be called for each line
    
    Returns:
    
    This Builder object for method chaining
  - setWatchdogTimeout
```
public Shell.Builder setWatchdogTimeout(int watchdogTimeout)
```
    Enable command timeout callback
    
    This will invoke the onCommandResult() callback with exitCode WATCHDOG_EXIT if a command takes longer than watchdogTimeout seconds to complete.
    
    If a watchdog timeout occurs, it generally means that the Interactive session is out of sync with the shell process. The caller should close the current session and open a new one.
    
    Parameters:
    
    watchdogTimeout - Timeout, in seconds; 0 to disable
    
    Returns:
    
    This Builder object for method chaining
  - setMinimalLogging
```
public Shell.Builder setMinimalLogging(boolean useMinimal)
```
    Enable/disable reduced logcat output
    
    Note that this is a global setting
    
    Parameters:
    
    useMinimal - true for reduced output, false for full output
    
    Returns:
    
    This Builder object for method chaining
  - open
```
public Shell.Interactive open()
```
    Construct a Shell.Interactive instance, and start the shell
    
    Returns:
    
    Interactive shell
  - open
```
public Shell.Interactive open(Shell.OnCommandResultListener onCommandResultListener)
```
    Construct a Shell.Interactive instance, try to start the shell, and call onCommandResultListener to report success or failure
    
    Parameters:
    
    onCommandResultListener - Callback to return shell open status
    
    Returns:
    
    Interactive shell

Class Shell.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setHandler

setAutoHandler

setShell

useSH

useSU

setWantSTDERR

addEnvironment

addEnvironment

addCommand

addCommand

addCommand

addCommand

addCommand

addCommand

setOnSTDOUTLineListener

setOnSTDERRLineListener

setWatchdogTimeout

setMinimalLogging

open

open