AbstractNExecCmd (Nuts Community Core Runtime 0.8.7.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase<NExecCmd>
- - net.thevpc.nuts.runtime.standalone.workspace.cmd.exec.AbstractNExecCmd

All Implemented Interfaces:

NCmdLineConfigurable, NExecCmd, NWorkspaceCmd, NComponent, NScorable

Direct Known Subclasses:

DefaultNExecCmd, RemoteNExecCmd
```
public abstract class AbstractNExecCmd
extends NWorkspaceCmdBase<NExecCmd>
implements NExecCmd
```
type: Command Class

Author:

thevpc

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`bot`
`protected List<String>`	`command`
`protected NDefinition`	`commandDefinition`
`protected NPath`	`directory`
`protected Boolean`	`dry`
`protected Map<String,String>`	`env`
`protected NExecOutput`	`err`
`protected boolean`	`executed`
`protected NDuration`	`executionTime`
`protected NExecutionType`	`executionType`
`protected List<String>`	`executorOptions`
`protected boolean`	`failFast`
`protected NExecInput`	`in`
`protected boolean`	`multipleRuns`
`protected String`	`multipleRunsCron`
`protected int`	`multipleRunsMaxCount`
`protected long`	`multipleRunsMinTimeMs`
`protected long`	`multipleRunsSafeTimeMs`
`protected NExecOutput`	`out`
`protected NExecutionException`	`resultException`
`protected NRunAs`	`runAs`
`protected List<String>`	`workspaceOptions`

Fields inherited from interface net.thevpc.nuts.util.NScorable
CUSTOM_SCORE, DEFAULT_SCORE, UNSUPPORTED_SCORE

Constructor Summary

Constructors
Constructor and Description

AbstractNExecCmd()

Constructors
Constructor and Description
`AbstractNExecCmd()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NExecCmd`	`addCommand(Collection<String> command)`
`NExecCmd`	`addCommand(NPath path)`
`NExecCmd`	`addCommand(String... command)`
`NExecCmd`	`addEnv(Map<String,String> env)`
`NExecCmd`	`addExecutorOption(String executorOption)`
`NExecCmd`	`addExecutorOptions(Collection<String> executorOptions)`
`NExecCmd`	`addExecutorOptions(String... executorOptions)`
`NExecCmd`	`addWorkspaceOptions(NWorkspaceOptions workspaceOptions)`
`NExecCmd`	`addWorkspaceOptions(String workspaceOptions)`
`NExecCmd`	`at(NConnexionString host)`
`NExecCmd`	`at(String host)`
`NExecCmd`	`clearCommand()`
`NExecCmd`	`clearEnv()`
`NExecCmd`	`clearExecutorOptions()`
`NExecCmd`	`clearWorkspaceOptions(String workspaceOptions)`
`boolean`	`configureFirst(NCmdLine cmdLine)`
`NExecCmd`	`copy()`
`NExecCmd`	`copyFrom(NExecCmd other)`
`NExecCmd`	`currentUser()`
`NExecCmd`	`embedded()`
`NExecCmd`	`failFast()`
`Boolean`	`getBot()`
`List<String>`	`getCommand()`
`NDefinition`	`getCommandDefinition()`
`String`	`getCommandString()`
`String`	`getCommandString(ProcessBuilder2.CommandStringFormat f)`
`String`	`getConnexionString()`
`NPath`	`getDirectory()`
`Boolean`	`getDry()`
`Map<String,String>`	`getEnv()`
`NExecOutput`	`getErr()`
`NExecutionType`	`getExecutionType()`
`List<String>`	`getExecutorOptions()`
`protected String`	`getExtraErrorMessage()`
`String`	`getGrabbedAllString()`
`String`	`getGrabbedErrString()`
`String`	`getGrabbedOutOnlyString()`
`String`	`getGrabbedOutString()`
`NExecInput`	`getIn()`
`NExecOutput`	`getOut()`
`int`	`getResultCode()`
`NOptional<NExecutionException>`	`getResultException()`
`NRunAs`	`getRunAs()`
`int`	`getScore(NScorableContext context)`
`long`	`getSleepMillis()`
`List<String>`	`getWorkspaceOptions()`
`NExecCmd`	`grabAll()`
`NExecCmd`	`grabErr()`
`NExecCmd`	`grabOut()`
`NExecCmd`	`grabOutOnly()`
`boolean`	`isFailFast()`
`NExecCmd`	`open()`
`NExecCmd`	`redirectErr()`
`NExecCmd`	`root()`
`NExecCmd`	`setBot(Boolean bot)`
`NExecCmd`	`setCommand(Collection<String> command)`
`NExecCmd`	`setCommand(String... command)`
`NExecCmd`	`setCommandDefinition(NDefinition definition)`
`NExecCmd`	`setConnexionString(NConnexionString target)`
`NExecCmd`	`setConnexionString(String host)`
`NExecCmd`	`setDirectory(NPath directory)`
`NExecCmd`	`setDry(Boolean dry)`
`NExecCmd`	`setEnv(Map<String,String> env)`
`NExecCmd`	`setEnv(String key, String value)`
`NExecCmd`	`setErr(NExecOutput err)`
`NExecCmd`	`setExecutionType(NExecutionType executionType)`
`NExecCmd`	`setExecutorOptions(Collection<String> executorOptions)`
`NExecCmd`	`setFailFast(boolean failFast)`
`NExecCmd`	`setIn(NExecInput in)`
`NExecCmd`	`setOut(NExecOutput out)`
`NExecCmd`	`setRunAs(NRunAs runAs)`
`NExecCmd`	`setSleepMillis(long sleepMillis)`
`NExecCmd`	`spawn()`
`NExecCmd`	`sudo()`
`NExecCmd`	`system()`
`String`	`toString()`

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase
_LOG, configure, copyFromWorkspaceCommandBase, getCommandName, invalidateResult

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

Methods inherited from interface net.thevpc.nuts.command.NExecCmd
configure, of, of, ofSystem, run, which

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable
configure, configure, configureLast

Methods inherited from interface net.thevpc.nuts.util.NScorable
isValidScore, query, query

- Field Detail
  - commandDefinition
```
protected NDefinition commandDefinition
```
  - command
```
protected List<String> command
```
  - executorOptions
```
protected List<String> executorOptions
```
  - workspaceOptions
```
protected List<String> workspaceOptions
```
  - env
```
protected Map<String,String> env
```
  - resultException
```
protected NExecutionException resultException
```
  - executed
```
protected boolean executed
```
  - executionTime
```
protected NDuration executionTime
```
  - multipleRuns
```
protected boolean multipleRuns
```
  - multipleRunsMinTimeMs
```
protected long multipleRunsMinTimeMs
```
  - multipleRunsSafeTimeMs
```
protected long multipleRunsSafeTimeMs
```
  - multipleRunsMaxCount
```
protected int multipleRunsMaxCount
```
  - multipleRunsCron
```
protected String multipleRunsCron
```
  - directory
```
protected NPath directory
```
  - out
```
protected NExecOutput out
```
  - err
```
protected NExecOutput err
```
  - in
```
protected NExecInput in
```
  - executionType
```
protected NExecutionType executionType
```
  - runAs
```
protected NRunAs runAs
```
  - dry
```
protected Boolean dry
```
  - failFast
```
protected boolean failFast
```
  - bot
```
protected Boolean bot
```
- Constructor Detail
  - AbstractNExecCmd
```
public AbstractNExecCmd()
```
- Method Detail
  - getScore
```
public int getScore(NScorableContext context)
```
    Specified by:
    
    getScore in interface NComponent
    
    Specified by:
    
    getScore in interface NScorable
    
    Overrides:
    
    getScore in class NWorkspaceCmdBase<NExecCmd>
  - isFailFast
```
public boolean isFailFast()
```
    Specified by:
    
    isFailFast in interface NExecCmd
  - setBot
```
public NExecCmd setBot(Boolean bot)
```
    Specified by:
    
    setBot in interface NExecCmd
  - getBot
```
public Boolean getBot()
```
    Specified by:
    
    getBot in interface NExecCmd
  - setFailFast
```
public NExecCmd setFailFast(boolean failFast)
```
    Specified by:
    
    setFailFast in interface NExecCmd
  - failFast
```
public NExecCmd failFast()
```
    Specified by:
    
    failFast in interface NExecCmd
  - getCommand
```
public List<String> getCommand()
```
    Specified by:
    
    getCommand in interface NExecCmd
  - setCommand
```
public NExecCmd setCommand(String... command)
```
    Specified by:
    
    setCommand in interface NExecCmd
  - setCommand
```
public NExecCmd setCommand(Collection<String> command)
```
    Specified by:
    
    setCommand in interface NExecCmd
  - setCommandDefinition
```
public NExecCmd setCommandDefinition(NDefinition definition)
```
    Specified by:
    
    setCommandDefinition in interface NExecCmd
  - getCommandDefinition
```
public NDefinition getCommandDefinition()
```
    Specified by:
    
    getCommandDefinition in interface NExecCmd
  - addCommand
```
public NExecCmd addCommand(NPath path)
```
    Specified by:
    
    addCommand in interface NExecCmd
  - addCommand
```
public NExecCmd addCommand(String... command)
```
    Specified by:
    
    addCommand in interface NExecCmd
  - addCommand
```
public NExecCmd addCommand(Collection<String> command)
```
    Specified by:
    
    addCommand in interface NExecCmd
  - clearCommand
```
public NExecCmd clearCommand()
```
    Specified by:
    
    clearCommand in interface NExecCmd
  - addExecutorOption
```
public NExecCmd addExecutorOption(String executorOption)
```
    Specified by:
    
    addExecutorOption in interface NExecCmd
  - addExecutorOptions
```
public NExecCmd addExecutorOptions(String... executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NExecCmd
  - setExecutorOptions
```
public NExecCmd setExecutorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    setExecutorOptions in interface NExecCmd
  - addExecutorOptions
```
public NExecCmd addExecutorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NExecCmd
  - clearExecutorOptions
```
public NExecCmd clearExecutorOptions()
```
    Specified by:
    
    clearExecutorOptions in interface NExecCmd
  - getWorkspaceOptions
```
public List<String> getWorkspaceOptions()
```
    Specified by:
    
    getWorkspaceOptions in interface NExecCmd
  - clearWorkspaceOptions
```
public NExecCmd clearWorkspaceOptions(String workspaceOptions)
```
    Specified by:
    
    clearWorkspaceOptions in interface NExecCmd
  - addWorkspaceOptions
```
public NExecCmd addWorkspaceOptions(NWorkspaceOptions workspaceOptions)
```
    Specified by:
    
    addWorkspaceOptions in interface NExecCmd
  - addWorkspaceOptions
```
public NExecCmd addWorkspaceOptions(String workspaceOptions)
```
    Specified by:
    
    addWorkspaceOptions in interface NExecCmd
  - getEnv
```
public Map<String,String> getEnv()
```
    Specified by:
    
    getEnv in interface NExecCmd
  - setEnv
```
public NExecCmd setEnv(Map<String,String> env)
```
    Specified by:
    
    setEnv in interface NExecCmd
  - addEnv
```
public NExecCmd addEnv(Map<String,String> env)
```
    Specified by:
    
    addEnv in interface NExecCmd
  - setEnv
```
public NExecCmd setEnv(String key,
                       String value)
```
    Specified by:
    
    setEnv in interface NExecCmd
  - clearEnv
```
public NExecCmd clearEnv()
```
    Specified by:
    
    clearEnv in interface NExecCmd
  - getDirectory
```
public NPath getDirectory()
```
    Specified by:
    
    getDirectory in interface NExecCmd
  - setDirectory
```
public NExecCmd setDirectory(NPath directory)
```
    Specified by:
    
    setDirectory in interface NExecCmd
  - getIn
```
public NExecInput getIn()
```
    Specified by:
    
    getIn in interface NExecCmd
  - setIn
```
public NExecCmd setIn(NExecInput in)
```
    Specified by:
    
    setIn in interface NExecCmd
  - getOut
```
public NExecOutput getOut()
```
    Specified by:
    
    getOut in interface NExecCmd
  - setOut
```
public NExecCmd setOut(NExecOutput out)
```
    Specified by:
    
    setOut in interface NExecCmd
  - grabOut
```
public NExecCmd grabOut()
```
    Specified by:
    
    grabOut in interface NExecCmd
  - grabAll
```
public NExecCmd grabAll()
```
    Specified by:
    
    grabAll in interface NExecCmd
  - grabOutOnly
```
public NExecCmd grabOutOnly()
```
    Specified by:
    
    grabOutOnly in interface NExecCmd
  - grabErr
```
public NExecCmd grabErr()
```
    Specified by:
    
    grabErr in interface NExecCmd
  - getGrabbedAllString
```
public String getGrabbedAllString()
```
    Specified by:
    
    getGrabbedAllString in interface NExecCmd
  - getGrabbedOutOnlyString
```
public String getGrabbedOutOnlyString()
```
    Specified by:
    
    getGrabbedOutOnlyString in interface NExecCmd
  - getGrabbedOutString
```
public String getGrabbedOutString()
```
    Specified by:
    
    getGrabbedOutString in interface NExecCmd
  - getGrabbedErrString
```
public String getGrabbedErrString()
```
    Specified by:
    
    getGrabbedErrString in interface NExecCmd
  - getErr
```
public NExecOutput getErr()
```
    Specified by:
    
    getErr in interface NExecCmd
  - setErr
```
public NExecCmd setErr(NExecOutput err)
```
    Specified by:
    
    setErr in interface NExecCmd
  - getExecutionType
```
public NExecutionType getExecutionType()
```
    Specified by:
    
    getExecutionType in interface NExecCmd
  - setExecutionType
```
public NExecCmd setExecutionType(NExecutionType executionType)
```
    Specified by:
    
    setExecutionType in interface NExecCmd
  - system
```
public NExecCmd system()
```
    Specified by:
    
    system in interface NExecCmd
  - embedded
```
public NExecCmd embedded()
```
    Specified by:
    
    embedded in interface NExecCmd
  - spawn
```
public NExecCmd spawn()
```
    Specified by:
    
    spawn in interface NExecCmd
  - open
```
public NExecCmd open()
```
    Specified by:
    
    open in interface NExecCmd
  - getRunAs
```
public NRunAs getRunAs()
```
    Specified by:
    
    getRunAs in interface NExecCmd
  - sudo
```
public NExecCmd sudo()
```
    Specified by:
    
    sudo in interface NExecCmd
  - root
```
public NExecCmd root()
```
    Specified by:
    
    root in interface NExecCmd
  - currentUser
```
public NExecCmd currentUser()
```
    Specified by:
    
    currentUser in interface NExecCmd
  - setRunAs
```
public NExecCmd setRunAs(NRunAs runAs)
```
    Specified by:
    
    setRunAs in interface NExecCmd
  - getDry
```
public Boolean getDry()
```
    Specified by:
    
    getDry in interface NExecCmd
  - setDry
```
public NExecCmd setDry(Boolean dry)
```
    Specified by:
    
    setDry in interface NExecCmd
  - copyFrom
```
public NExecCmd copyFrom(NExecCmd other)
```
    Specified by:
    
    copyFrom in interface NExecCmd
  - copy
```
public NExecCmd copy()
```
    Specified by:
    
    copy in interface NExecCmd
  - getResultCode
```
public int getResultCode()
```
    Specified by:
    
    getResultCode in interface NExecCmd
  - getExecutorOptions
```
public List<String> getExecutorOptions()
```
    Specified by:
    
    getExecutorOptions in interface NExecCmd
  - getResultException
```
public NOptional<NExecutionException> getResultException()
```
    Specified by:
    
    getResultException in interface NExecCmd
  - getSleepMillis
```
public long getSleepMillis()
```
    Specified by:
    
    getSleepMillis in interface NExecCmd
  - setSleepMillis
```
public NExecCmd setSleepMillis(long sleepMillis)
```
    Specified by:
    
    setSleepMillis in interface NExecCmd
  - getExtraErrorMessage
```
protected String getExtraErrorMessage()
```
  - configureFirst
```
public boolean configureFirst(NCmdLine cmdLine)
```
    Specified by:
    
    configureFirst in interface NCmdLineConfigurable
    
    Overrides:
    
    configureFirst in class NWorkspaceCmdBase<NExecCmd>
  - getCommandString
```
public String getCommandString()
```
  - getCommandString
```
public String getCommandString(ProcessBuilder2.CommandStringFormat f)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getConnexionString
```
public String getConnexionString()
```
    Specified by:
    
    getConnexionString in interface NExecCmd
  - setConnexionString
```
public NExecCmd setConnexionString(String host)
```
    Specified by:
    
    setConnexionString in interface NExecCmd
  - at
```
public NExecCmd at(String host)
```
    Specified by:
    
    at in interface NExecCmd
  - at
```
public NExecCmd at(NConnexionString host)
```
    Specified by:
    
    at in interface NExecCmd
  - setConnexionString
```
public NExecCmd setConnexionString(NConnexionString target)
```
    Specified by:
    
    setConnexionString in interface NExecCmd
  - redirectErr
```
public NExecCmd redirectErr()
```
    Specified by:
    
    redirectErr in interface NExecCmd

Class AbstractNExecCmd

Field Summary

Fields inherited from interface net.thevpc.nuts.util.NScorable

Constructor Summary

Method Summary

Methods inherited from class net.thevpc.nuts.runtime.standalone.workspace.cmd.NWorkspaceCmdBase

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.command.NExecCmd

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLineConfigurable

Methods inherited from interface net.thevpc.nuts.util.NScorable

Field Detail

commandDefinition

command

executorOptions

workspaceOptions

env

resultException

executed

executionTime

multipleRuns

multipleRunsMinTimeMs

multipleRunsSafeTimeMs

multipleRunsMaxCount

multipleRunsCron

directory

out

err

in

executionType

runAs

dry

failFast

bot

Constructor Detail

AbstractNExecCmd

Method Detail

getScore

isFailFast

setBot

getBot

setFailFast

failFast

getCommand

setCommand

setCommand

setCommandDefinition

getCommandDefinition

addCommand

addCommand

addCommand

clearCommand

addExecutorOption

addExecutorOptions

setExecutorOptions

addExecutorOptions

clearExecutorOptions

getWorkspaceOptions

clearWorkspaceOptions

addWorkspaceOptions

addWorkspaceOptions

getEnv

setEnv

addEnv

setEnv

clearEnv

getDirectory

setDirectory

getIn

setIn

getOut

setOut

grabOut

grabAll

grabOutOnly

grabErr

getGrabbedAllString

getGrabbedOutOnlyString

getGrabbedOutString

getGrabbedErrString

getErr