AbstractNExec (Nuts Community Core Runtime 1.0.0.0 API)

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

All Implemented Interfaces:

NCmdLineConfigurable, NExec, NWorkspaceCmd, NConnectionStringAware, NComponent

Direct Known Subclasses:

DefaultNExec, RemoteNExec
```
public abstract class AbstractNExec
extends NWorkspaceCmdBase<NExec>
implements NExec
```
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`

Constructor Summary

Constructors
Constructor and Description

AbstractNExec()

Constructors
Constructor and Description
`AbstractNExec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NExec`	`addCommand(Collection<String> command)`
`NExec`	`addCommand(NPath path)`
`NExec`	`addCommand(String... command)`
`NExec`	`addEnv(Map<String,String> env)`
`NExec`	`addExecutorOption(String executorOption)`
`NExec`	`addExecutorOptions(Collection<String> executorOptions)`
`NExec`	`addExecutorOptions(String... executorOptions)`
`NExec`	`addWorkspaceOptions(NWorkspaceOptions workspaceOptions)`
`NExec`	`addWorkspaceOptions(String workspaceOptions)`
`NExec`	`at(NConnectionString connectionString)`
`NExec`	`at(String connectionString)`
`Boolean`	`bot()`
`NExec`	`bot(Boolean bot)`
`NExec`	`clearCommand()`
`NExec`	`clearEnv()`
`NExec`	`clearExecutorOptions()`
`NExec`	`clearWorkspaceOptions(String workspaceOptions)`
`List<String>`	`command()`
`NExec`	`command(Collection<String> command)`
`NExec`	`command(String... command)`
`NDefinition`	`commandDefinition()`
`NExec`	`commandDefinition(NDefinition definition)`
`boolean`	`configureFirst(NCmdLine cmdLine)`
`NConnectionString`	`connectionString()`
`NExec`	`connectionString(NConnectionString connectionString)`
`NExec`	`connectionString(String connectionString)`
`NExec`	`copy()`
`NExec`	`copyFrom(NExec other)`
`NExec`	`currentUser()`
`NPath`	`directory()`
`NExec`	`directory(NPath directory)`
`Boolean`	`dry()`
`NExec`	`dry(Boolean dry)`
`NExec`	`embedded()`
`Map<String,String>`	`env()`
`NExec`	`env(Map<String,String> env)`
`NExec`	`env(String key, String value)`
`NExecOutput`	`err()`
`NExec`	`err(NExecOutput err)`
`NExecutionType`	`executionType()`
`NExec`	`executionType(NExecutionType executionType)`
`List<String>`	`executorOptions()`
`NExec`	`executorOptions(Collection<String> executorOptions)`
`int`	`exitCode()`
`NExec`	`failFast(boolean failFast)`
`String`	`getCommandString()`
`String`	`getCommandString(ProcessBuilder2.CommandStringFormat f)`
`protected String`	`getExtraErrorMessage()`
`NExec`	`grabAll()`
`String`	`grabbedAll()`
`String`	`grabbedErr()`
`byte[]`	`grabbedErrBytes()`
`String`	`grabbedOut()`
`byte[]`	`grabbedOutBytes()`
`String`	`grabbedOutOnly()`
`NExec`	`grabErr()`
`NExec`	`grabOut()`
`NExec`	`grabOutOnly()`
`NExecInput`	`in()`
`NExec`	`in(NExecInput in)`
`boolean`	`isFailFast()`
`boolean`	`isRawCommand()`
`NExec`	`maxBytes(int maxBytes)`
`NExec`	`maxLines(int maxLines)`
`NExec`	`open()`
`NExecOutput`	`out()`
`NExec`	`out(NExecOutput out)`
`NExec`	`rawCommand(boolean rawCommand)`
`NExec`	`redirectErr()`
`NOptional<NExecutionException>`	`resultException()`
`NExec`	`root()`
`NRunAs`	`runAs()`
`NExec`	`runAs(NRunAs runAs)`
`NDuration`	`sleepDuration()`
`NExec`	`sleepDuration(NDuration sleepMillis)`
`NExec`	`spawn()`
`NExec`	`sudo()`
`NExec`	`system()`
`String`	`toString()`
`List<String>`	`workspaceOptions()`

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.NExec
configure, of, of, ofOpenFile, ofSystem, run, which

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

- 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
  - AbstractNExec
```
public AbstractNExec()
```
- Method Detail
  - isFailFast
```
public boolean isFailFast()
```
    Specified by:
    
    isFailFast in interface NExec
  - bot
```
public NExec bot(Boolean bot)
```
    Specified by:
    
    bot in interface NExec
  - maxLines
```
public NExec maxLines(int maxLines)
```
    Specified by:
    
    maxLines in interface NExec
  - maxBytes
```
public NExec maxBytes(int maxBytes)
```
    Specified by:
    
    maxBytes in interface NExec
  - bot
```
public Boolean bot()
```
    Specified by:
    
    bot in interface NExec
  - failFast
```
public NExec failFast(boolean failFast)
```
    Specified by:
    
    failFast in interface NExec
  - command
```
public List<String> command()
```
    Specified by:
    
    command in interface NExec
  - command
```
public NExec command(String... command)
```
    Specified by:
    
    command in interface NExec
  - command
```
public NExec command(Collection<String> command)
```
    Specified by:
    
    command in interface NExec
  - commandDefinition
```
public NExec commandDefinition(NDefinition definition)
```
    Specified by:
    
    commandDefinition in interface NExec
  - commandDefinition
```
public NDefinition commandDefinition()
```
    Specified by:
    
    commandDefinition in interface NExec
  - addCommand
```
public NExec addCommand(NPath path)
```
    Specified by:
    
    addCommand in interface NExec
  - addCommand
```
public NExec addCommand(String... command)
```
    Specified by:
    
    addCommand in interface NExec
  - addCommand
```
public NExec addCommand(Collection<String> command)
```
    Specified by:
    
    addCommand in interface NExec
  - clearCommand
```
public NExec clearCommand()
```
    Specified by:
    
    clearCommand in interface NExec
  - addExecutorOption
```
public NExec addExecutorOption(String executorOption)
```
    Specified by:
    
    addExecutorOption in interface NExec
  - addExecutorOptions
```
public NExec addExecutorOptions(String... executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NExec
  - executorOptions
```
public NExec executorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    executorOptions in interface NExec
  - addExecutorOptions
```
public NExec addExecutorOptions(Collection<String> executorOptions)
```
    Specified by:
    
    addExecutorOptions in interface NExec
  - clearExecutorOptions
```
public NExec clearExecutorOptions()
```
    Specified by:
    
    clearExecutorOptions in interface NExec
  - workspaceOptions
```
public List<String> workspaceOptions()
```
    Specified by:
    
    workspaceOptions in interface NExec
  - clearWorkspaceOptions
```
public NExec clearWorkspaceOptions(String workspaceOptions)
```
    Specified by:
    
    clearWorkspaceOptions in interface NExec
  - addWorkspaceOptions
```
public NExec addWorkspaceOptions(NWorkspaceOptions workspaceOptions)
```
    Specified by:
    
    addWorkspaceOptions in interface NExec
  - addWorkspaceOptions
```
public NExec addWorkspaceOptions(String workspaceOptions)
```
    Specified by:
    
    addWorkspaceOptions in interface NExec
  - env
```
public Map<String,String> env()
```
    Specified by:
    
    env in interface NExec
  - env
```
public NExec env(Map<String,String> env)
```
    Specified by:
    
    env in interface NExec
  - addEnv
```
public NExec addEnv(Map<String,String> env)
```
    Specified by:
    
    addEnv in interface NExec
  - env
```
public NExec env(String key,
                 String value)
```
    Specified by:
    
    env in interface NExec
  - clearEnv
```
public NExec clearEnv()
```
    Specified by:
    
    clearEnv in interface NExec
  - directory
```
public NPath directory()
```
    Specified by:
    
    directory in interface NExec
  - directory
```
public NExec directory(NPath directory)
```
    Specified by:
    
    directory in interface NExec
  - in
```
public NExecInput in()
```
    Specified by:
    
    in in interface NExec
  - in
```
public NExec in(NExecInput in)
```
    Specified by:
    
    in in interface NExec
  - out
```
public NExecOutput out()
```
    Specified by:
    
    out in interface NExec
  - out
```
public NExec out(NExecOutput out)
```
    Specified by:
    
    out in interface NExec
  - grabOut
```
public NExec grabOut()
```
    Specified by:
    
    grabOut in interface NExec
  - grabAll
```
public NExec grabAll()
```
    Specified by:
    
    grabAll in interface NExec
  - grabOutOnly
```
public NExec grabOutOnly()
```
    Specified by:
    
    grabOutOnly in interface NExec
  - grabErr
```
public NExec grabErr()
```
    Specified by:
    
    grabErr in interface NExec
  - grabbedAll
```
public String grabbedAll()
```
    Specified by:
    
    grabbedAll in interface NExec
  - grabbedOutOnly
```
public String grabbedOutOnly()
```
    Specified by:
    
    grabbedOutOnly in interface NExec
  - grabbedOut
```
public String grabbedOut()
```
    Specified by:
    
    grabbedOut in interface NExec
  - grabbedOutBytes
```
public byte[] grabbedOutBytes()
```
    Specified by:
    
    grabbedOutBytes in interface NExec
  - grabbedErrBytes
```
public byte[] grabbedErrBytes()
```
    Specified by:
    
    grabbedErrBytes in interface NExec
  - grabbedErr
```
public String grabbedErr()
```
    Specified by:
    
    grabbedErr in interface NExec
  - err
```
public NExecOutput err()
```
    Specified by:
    
    err in interface NExec
  - err
```
public NExec err(NExecOutput err)
```
    Specified by:
    
    err in interface NExec
  - executionType
```
public NExecutionType executionType()
```
    Specified by:
    
    executionType in interface NExec
  - executionType
```
public NExec executionType(NExecutionType executionType)
```
    Specified by:
    
    executionType in interface NExec
  - system
```
public NExec system()
```
    Specified by:
    
    system in interface NExec
  - embedded
```
public NExec embedded()
```
    Specified by:
    
    embedded in interface NExec
  - spawn
```
public NExec spawn()
```
    Specified by:
    
    spawn in interface NExec
  - open
```
public NExec open()
```
    Specified by:
    
    open in interface NExec
  - runAs
```
public NRunAs runAs()
```
    Specified by:
    
    runAs in interface NExec
  - sudo
```
public NExec sudo()
```
    Specified by:
    
    sudo in interface NExec
  - root
```
public NExec root()
```
    Specified by:
    
    root in interface NExec
  - currentUser
```
public NExec currentUser()
```
    Specified by:
    
    currentUser in interface NExec
  - runAs
```
public NExec runAs(NRunAs runAs)
```
    Specified by:
    
    runAs in interface NExec
  - dry
```
public Boolean dry()
```
    Specified by:
    
    dry in interface NExec
  - dry
```
public NExec dry(Boolean dry)
```
    Specified by:
    
    dry in interface NExec
  - copyFrom
```
public NExec copyFrom(NExec other)
```
    Specified by:
    
    copyFrom in interface NExec
  - copy
```
public NExec copy()
```
    Specified by:
    
    copy in interface NExec
  - exitCode
```
public int exitCode()
```
    Specified by:
    
    exitCode in interface NExec
  - executorOptions
```
public List<String> executorOptions()
```
    Specified by:
    
    executorOptions in interface NExec
  - resultException
```
public NOptional<NExecutionException> resultException()
```
    Specified by:
    
    resultException in interface NExec
  - sleepDuration
```
public NDuration sleepDuration()
```
    Specified by:
    
    sleepDuration in interface NExec
  - sleepDuration
```
public NExec sleepDuration(NDuration sleepMillis)
```
    Specified by:
    
    sleepDuration in interface NExec
  - getExtraErrorMessage
```
protected String getExtraErrorMessage()
```
  - configureFirst
```
public boolean configureFirst(NCmdLine cmdLine)
```
    Specified by:
    
    configureFirst in interface NCmdLineConfigurable
    
    Overrides:
    
    configureFirst in class NWorkspaceCmdBase<NExec>
  - getCommandString
```
public String getCommandString()
```
  - getCommandString
```
public String getCommandString(ProcessBuilder2.CommandStringFormat f)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - connectionString
```
public NConnectionString connectionString()
```
    Specified by:
    
    connectionString in interface NExec
    
    Specified by:
    
    connectionString in interface NConnectionStringAware
  - connectionString
```
public NExec connectionString(String connectionString)
```
    Specified by:
    
    connectionString in interface NExec
    
    Specified by:
    
    connectionString in interface NConnectionStringAware
  - at
```
public NExec at(String connectionString)
```
    Specified by:
    
    at in interface NExec
    
    Specified by:
    
    at in interface NConnectionStringAware
  - at
```
public NExec at(NConnectionString connectionString)
```
    Specified by:
    
    at in interface NExec
    
    Specified by:
    
    at in interface NConnectionStringAware
  - connectionString
```
public NExec connectionString(NConnectionString connectionString)
```
    Specified by:
    
    connectionString in interface NExec
    
    Specified by:
    
    connectionString in interface NConnectionStringAware
  - redirectErr
```
public NExec redirectErr()
```
    Specified by:
    
    redirectErr in interface NExec
  - isRawCommand
```
public boolean isRawCommand()
```
    Specified by:
    
    isRawCommand in interface NExec
  - rawCommand
```
public NExec rawCommand(boolean rawCommand)
```
    Specified by:
    
    rawCommand in interface NExec

Class AbstractNExec

Field Summary

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.NExec

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

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

AbstractNExec

Method Detail

isFailFast

bot

maxLines

maxBytes

bot

failFast

command

command

command

commandDefinition

commandDefinition

addCommand

addCommand

addCommand

clearCommand

addExecutorOption

addExecutorOptions

executorOptions

addExecutorOptions

clearExecutorOptions

workspaceOptions

clearWorkspaceOptions

addWorkspaceOptions

addWorkspaceOptions

env

env

addEnv

env

clearEnv

directory

directory

in

in

out

out

grabOut

grabAll

grabOutOnly

grabErr

grabbedAll

grabbedOutOnly

grabbedOut

grabbedOutBytes

grabbedErrBytes

grabbedErr

err