AbstractNutsExecCommand (net.thevpc.nuts.nuts-runtime 0.8.2.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.wscommands.NutsWorkspaceCommandBase<NutsExecCommand>
- - net.thevpc.nuts.runtime.standalone.wscommands.AbstractNutsExecCommand

All Implemented Interfaces:

NutsCommandLineConfigurable, NutsExecCommand, NutsWorkspaceCommand

Direct Known Subclasses:

DefaultNutsExecCommand, RemoteNutsExecCommand
```
public abstract class AbstractNutsExecCommand
extends NutsWorkspaceCommandBase<NutsExecCommand>
implements NutsExecCommand
```
type: Command Class

Author:

thevpc

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AbstractNutsExecCommand.SPrintStream

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractNutsExecCommand.SPrintStream`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`command`
`protected NutsDefinition`	`commandDefinition`
`protected String`	`directory`
`protected boolean`	`dry`
`protected Map<String,String>`	`env`
`protected NutsPrintStream`	`err`
`protected boolean`	`executed`
`protected NutsExecutionType`	`executionType`
`protected List<String>`	`executorOptions`
`protected boolean`	`failFast`
`protected InputStream`	`in`
`protected NutsPrintStream`	`out`
`protected boolean`	`redirectErrorStream`
`protected NutsExecutionException`	`result`
`protected NutsRunAs`	`runAs`

Fields inherited from class net.thevpc.nuts.runtime.standalone.wscommands.NutsWorkspaceCommandBase
session, ws

Constructor Summary

Constructors
Constructor and Description

AbstractNutsExecCommand(NutsWorkspace ws)

Constructors
Constructor and Description
`AbstractNutsExecCommand(NutsWorkspace ws)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NutsExecCommand`	`addCommand(Collection<String> command)`
`NutsExecCommand`	`addCommand(String... command)`
`NutsExecCommand`	`addEnv(Map<String,String> env)`
`NutsExecCommand`	`addExecutorOption(String executorOption)`
`NutsExecCommand`	`addExecutorOptions(Collection<String> executorOptions)`
`NutsExecCommand`	`addExecutorOptions(String... executorOptions)`
`NutsExecCommand`	`clearCommand()`
`NutsExecCommand`	`clearEnv()`
`NutsExecCommand`	`clearExecutorOptions()`
`boolean`	`configureFirst(NutsCommandLine cmdLine)`
`NutsExecCommand`	`copy()`
`NutsExecCommand`	`copyFrom(NutsExecCommand other)`
`NutsExecCommandFormat`	`formatter()`
`String[]`	`getCommand()`
`String`	`getCommandString()`
`String`	`getCommandString(ProcessBuilder2.CommandStringFormat f)`
`String`	`getDirectory()`
`Map<String,String>`	`getEnv()`
`NutsPrintStream`	`getErr()`
`String`	`getErrorString()`
`NutsExecutionType`	`getExecutionType()`
`String[]`	`getExecutorOptions()`
`protected String`	`getExtraErrorMessage()`
`InputStream`	`getIn()`
`NutsPrintStream`	`getOut()`
`String`	`getOutputString()`
`String`	`getOutputString0()`
`String`	`getRedirectInpuFile()`
`String`	`getRedirectOuputFile()`
`int`	`getResult()`
`NutsExecutionException`	`getResultException()`
`NutsRunAs`	`getRunAs()`
`int`	`getSleepMillis()`
`NutsExecCommand`	`grabErrorString()`
`NutsExecCommand`	`grabOutputString()`
`boolean`	`isDry()`
`boolean`	`isFailFast()`
`boolean`	`isGrabErrorString()`
`boolean`	`isGrabOutputString()`
`boolean`	`isInheritSystemIO()`
`boolean`	`isRedirectErrorStream()`
`NutsExecCommand`	`setCommand(Collection<String> command)`
`NutsExecCommand`	`setCommand(NutsDefinition definition)`
`NutsExecCommand`	`setCommand(String... command)`
`NutsExecCommand`	`setDirectory(String directory)`
`NutsExecCommand`	`setDry(boolean value)`
`NutsExecCommand`	`setEnv(Map<String,String> env)`
`NutsExecCommand`	`setEnv(String key, String value)`
`NutsExecCommand`	`setErr(NutsPrintStream err)`
`NutsExecCommand`	`setExecutionType(NutsExecutionType executionType)`
`NutsExecCommand`	`setFailFast(boolean failFast)`
`NutsExecCommand`	`setIn(InputStream in)`
`NutsExecCommand`	`setInheritSystemIO(boolean inheritSystemIO)`
`NutsExecCommand`	`setOut(NutsPrintStream out)`
`NutsExecCommand`	`setRedirectErrorStream(boolean redirectErrorStream)`
`NutsExecCommand`	`setRedirectInpuFile(String redirectInpuFile)`
`NutsExecCommand`	`setRedirectOuputFile(String redirectOuputFile)`
`NutsExecCommand`	`setRunAs(NutsRunAs runAs)`
`NutsExecCommand`	`setSleepMillis(int sleepMillis)`
`String`	`toString()`

Methods inherited from class net.thevpc.nuts.runtime.standalone.wscommands.NutsWorkspaceCommandBase
_LOG, _LOGOP, checkSession, configure, configure, copyFromWorkspaceCommandBase, copySession, getCommandName, getSession, getWorkspace, invalidateResult, setSession, setWs

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

Methods inherited from interface net.thevpc.nuts.NutsExecCommand
configure, copySession, run, setSession, which

Methods inherited from interface net.thevpc.nuts.NutsWorkspaceCommand
getSession

Methods inherited from interface net.thevpc.nuts.NutsCommandLineConfigurable
configure, configureLast

- Field Detail
  - commandDefinition
```
protected NutsDefinition commandDefinition
```
  - command
```
protected List<String> command
```
  - executorOptions
```
protected List<String> executorOptions
```
  - env
```
protected Map<String,String> env
```
  - result
```
protected NutsExecutionException result
```
  - executed
```
protected boolean executed
```
  - directory
```
protected String directory
```
  - out
```
protected NutsPrintStream out
```
  - err
```
protected NutsPrintStream err
```
  - in
```
protected InputStream in
```
  - executionType
```
protected NutsExecutionType executionType
```
  - runAs
```
protected NutsRunAs runAs
```
  - redirectErrorStream
```
protected boolean redirectErrorStream
```
  - failFast
```
protected boolean failFast
```
  - dry
```
protected boolean dry
```
- Constructor Detail
  - AbstractNutsExecCommand
```
public AbstractNutsExecCommand(NutsWorkspace ws)
```
- Method Detail
  - formatter
```
public NutsExecCommandFormat formatter()
```
    Specified by:
    
    formatter in interface NutsExecCommand
  - setFailFast
```
public NutsExecCommand setFailFast(boolean failFast)
```
    Specified by:
    
    setFailFast in interface NutsExecCommand
  - isFailFast
```
public boolean isFailFast()
```
    Specified by:
    
    isFailFast in interface NutsExecCommand
  - getCommand
```
public String[] getCommand()
```
    Specified by:
    
    getCommand in interface NutsExecCommand
  - setCommand
```
public NutsExecCommand setCommand(NutsDefinition definition)
```
    Specified by:
    
    setCommand in interface NutsExecCommand
  - setCommand
```
public NutsExecCommand setCommand(String... command)
```
    Specified by:
    
    setCommand in interface NutsExecCommand
  - setCommand
```
public NutsExecCommand setCommand(Collection<String> command)
```
    Specified by:
    
    setCommand in interface NutsExecCommand
  - addCommand
```
public NutsExecCommand addCommand(String... command)
```
    Specified by:
    
    addCommand in interface NutsExecCommand
  - clearCommand
```
public NutsExecCommand clearCommand()
```
    Specified by:
    
    clearCommand in interface NutsExecCommand
  - addCommand
```
public NutsExecCommand addCommand(Collection<String> command)
```
    Specified by:
    
    addCommand in interface NutsExecCommand
  - addExecutorOption
```
public NutsExecCommand addExecutorOption(String executorOption)
```
    Specified by:
    
    addExecutorOption in interface NutsExecCommand
  - addExecutorOptions
```
public NutsExecCommand addExecutorOptions(String... executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NutsExecCommand
  - addExecutorOptions
```
public NutsExecCommand addExecutorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NutsExecCommand
  - clearExecutorOptions
```
public NutsExecCommand clearExecutorOptions()
```
    Specified by:
    
    clearExecutorOptions in interface NutsExecCommand
  - getEnv
```
public Map<String,String> getEnv()
```
    Specified by:
    
    getEnv in interface NutsExecCommand
  - addEnv
```
public NutsExecCommand addEnv(Map<String,String> env)
```
    Specified by:
    
    addEnv in interface NutsExecCommand
  - setEnv
```
public NutsExecCommand setEnv(String key,
                              String value)
```
    Specified by:
    
    setEnv in interface NutsExecCommand
  - setEnv
```
public NutsExecCommand setEnv(Map<String,String> env)
```
    Specified by:
    
    setEnv in interface NutsExecCommand
  - clearEnv
```
public NutsExecCommand clearEnv()
```
    Specified by:
    
    clearEnv in interface NutsExecCommand
  - getDirectory
```
public String getDirectory()
```
    Specified by:
    
    getDirectory in interface NutsExecCommand
  - setDirectory
```
public NutsExecCommand setDirectory(String directory)
```
    Specified by:
    
    setDirectory in interface NutsExecCommand
  - getIn
```
public InputStream getIn()
```
    Specified by:
    
    getIn in interface NutsExecCommand
  - isInheritSystemIO
```
public boolean isInheritSystemIO()
```
    Specified by:
    
    isInheritSystemIO in interface NutsExecCommand
  - setInheritSystemIO
```
public NutsExecCommand setInheritSystemIO(boolean inheritSystemIO)
```
    Specified by:
    
    setInheritSystemIO in interface NutsExecCommand
  - setIn
```
public NutsExecCommand setIn(InputStream in)
```
    Specified by:
    
    setIn in interface NutsExecCommand
  - getOut
```
public NutsPrintStream getOut()
```
    Specified by:
    
    getOut in interface NutsExecCommand
  - grabOutputString
```
public NutsExecCommand grabOutputString()
```
    Specified by:
    
    grabOutputString in interface NutsExecCommand
  - grabErrorString
```
public NutsExecCommand grabErrorString()
```
    Specified by:
    
    grabErrorString in interface NutsExecCommand
  - getOutputString
```
public String getOutputString()
```
    Specified by:
    
    getOutputString in interface NutsExecCommand
  - getOutputString0
```
public String getOutputString0()
```
  - getErrorString
```
public String getErrorString()
```
    Specified by:
    
    getErrorString in interface NutsExecCommand
  - setOut
```
public NutsExecCommand setOut(NutsPrintStream out)
```
    Specified by:
    
    setOut in interface NutsExecCommand
  - setErr
```
public NutsExecCommand setErr(NutsPrintStream err)
```
    Specified by:
    
    setErr in interface NutsExecCommand
  - getErr
```
public NutsPrintStream getErr()
```
    Specified by:
    
    getErr in interface NutsExecCommand
  - getExecutionType
```
public NutsExecutionType getExecutionType()
```
    Specified by:
    
    getExecutionType in interface NutsExecCommand
  - isRedirectErrorStream
```
public boolean isRedirectErrorStream()
```
    Specified by:
    
    isRedirectErrorStream in interface NutsExecCommand
  - setRedirectErrorStream
```
public NutsExecCommand setRedirectErrorStream(boolean redirectErrorStream)
```
    Specified by:
    
    setRedirectErrorStream in interface NutsExecCommand
  - setExecutionType
```
public NutsExecCommand setExecutionType(NutsExecutionType executionType)
```
    Specified by:
    
    setExecutionType in interface NutsExecCommand
  - getRunAs
```
public NutsRunAs getRunAs()
```
    Specified by:
    
    getRunAs in interface NutsExecCommand
  - setRunAs
```
public NutsExecCommand setRunAs(NutsRunAs runAs)
```
    Specified by:
    
    setRunAs in interface NutsExecCommand
  - copyFrom
```
public NutsExecCommand copyFrom(NutsExecCommand other)
```
    Specified by:
    
    copyFrom in interface NutsExecCommand
  - copy
```
public NutsExecCommand copy()
```
    Specified by:
    
    copy in interface NutsExecCommand
  - getResult
```
public int getResult()
```
    Specified by:
    
    getResult in interface NutsExecCommand
  - getExecutorOptions
```
public String[] getExecutorOptions()
```
    Specified by:
    
    getExecutorOptions in interface NutsExecCommand
  - getResultException
```
public NutsExecutionException getResultException()
```
    Specified by:
    
    getResultException in interface NutsExecCommand
  - getExtraErrorMessage
```
protected String getExtraErrorMessage()
```
  - configureFirst
```
public boolean configureFirst(NutsCommandLine cmdLine)
```
    Specified by:
    
    configureFirst in interface NutsCommandLineConfigurable
    
    Overrides:
    
    configureFirst in class NutsWorkspaceCommandBase<NutsExecCommand>
  - isDry
```
public boolean isDry()
```
    Specified by:
    
    isDry in interface NutsExecCommand
  - setDry
```
public NutsExecCommand setDry(boolean value)
```
    Specified by:
    
    setDry in interface NutsExecCommand
  - isGrabOutputString
```
public boolean isGrabOutputString()
```
  - isGrabErrorString
```
public boolean isGrabErrorString()
```
  - getCommandString
```
public String getCommandString()
```
  - getCommandString
```
public String getCommandString(ProcessBuilder2.CommandStringFormat f)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSleepMillis
```
public int getSleepMillis()
```
    Specified by:
    
    getSleepMillis in interface NutsExecCommand
  - setSleepMillis
```
public NutsExecCommand setSleepMillis(int sleepMillis)
```
    Specified by:
    
    setSleepMillis in interface NutsExecCommand
  - getRedirectOuputFile
```
public String getRedirectOuputFile()
```
    Specified by:
    
    getRedirectOuputFile in interface NutsExecCommand
  - setRedirectOuputFile
```
public NutsExecCommand setRedirectOuputFile(String redirectOuputFile)
```
    Specified by:
    
    setRedirectOuputFile in interface NutsExecCommand
  - getRedirectInpuFile
```
public String getRedirectInpuFile()
```
    Specified by:
    
    getRedirectInpuFile in interface NutsExecCommand
  - setRedirectInpuFile
```
public NutsExecCommand setRedirectInpuFile(String redirectInpuFile)
```
    Specified by:
    
    setRedirectInpuFile in interface NutsExecCommand

Class AbstractNutsExecCommand

Nested Class Summary

Field Summary

Fields inherited from class net.thevpc.nuts.runtime.standalone.wscommands.NutsWorkspaceCommandBase

Constructor Summary

Method Summary

Methods inherited from class net.thevpc.nuts.runtime.standalone.wscommands.NutsWorkspaceCommandBase

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.NutsExecCommand

Methods inherited from interface net.thevpc.nuts.NutsWorkspaceCommand

Methods inherited from interface net.thevpc.nuts.NutsCommandLineConfigurable

Field Detail

commandDefinition

command

executorOptions

env

result

executed

directory

out

err

in

executionType

runAs

redirectErrorStream

failFast

dry

Constructor Detail

AbstractNutsExecCommand

Method Detail

formatter

setFailFast

isFailFast

getCommand

setCommand

setCommand

setCommand

addCommand

clearCommand

addCommand

addExecutorOption

addExecutorOptions

addExecutorOptions

clearExecutorOptions

getEnv

addEnv

setEnv

setEnv

clearEnv

getDirectory

setDirectory

getIn

isInheritSystemIO

setInheritSystemIO

setIn

getOut

grabOutputString

grabErrorString

getOutputString

getOutputString0

getErrorString

setOut

setErr

getErr

getExecutionType

isRedirectErrorStream

setRedirectErrorStream

setExecutionType

getRunAs

setRunAs

copyFrom

copy

getResult

getExecutorOptions

getResultException

getExtraErrorMessage

configureFirst

isDry

setDry

isGrabOutputString