Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.gradle.util.exec
Class DefaultExecHandle

    java.lang.Object
      org.gradle.util.exec.DefaultExecHandle

All Implemented Interfaces:
  ExecHandle

    class DefaultExecHandle
    extends java.lang.Object

Default implementation for the ExecHandle interface.

### State flows

The ExecHandle has very strict state control. The following state flows are allowed:

Normal state flow:

- INIT -> STARTED -> SUCCEEDED

Failure state flows:

- INIT -> FAILED
- INIT -> STARTED -> FAILED

Aborted state flow:

- INIT -> STARTED -> ABORTED

State is controlled on all control methods:

- #start() can only be called when the state is NOT ExecHandleState#STARTED
- #abort() can only be called when the state is ExecHandleState#STARTED
- #startAndWaitForFinish() can only be called when the state is NOT ExecHandleState#STARTED

author:
  Tom Eyckmans

Constructor Summary
`DefaultExecHandle(File directory, java.lang.String command, java.util.List arguments, int normalTerminationExitCode, java.util.Map environment, long keepWaitingTimeout, ExecOutputHandle standardOutputHandle, ExecOutputHandle errorOutputHandle, ExecHandleNotifierFactory notifierFactory, java.util.List listeners)`

Method Summary
`void` | `abort()`
`void` | `aborted()`
`void` | `addListeners(ExecHandleListener listeners)`
`void` | `failed(java.lang.Throwable failureCause)`
`void` | `finished(int exitCode)`
`java.util.List` | `getArguments()`
`java.lang.String` | `getCommand()`
`File` | `getDirectory()`
`java.util.Map` | `getEnvironment()`
`ExecOutputHandle` | `getErrorOutputHandle()`
`int` | `getExitCode()`
`java.lang.Throwable` | `getFailureCause()`
`long` | `getKeepWaitingTimeout()`
`java.util.List` | `getListeners()`
`ExecOutputHandle` | `getStandardOutputHandle()`
`ExecHandleState` | `getState()`
`void` | `removeListeners(ExecHandleListener listeners)`
`void` | `start()`
`ExecHandleState` | `startAndWaitForFinish()`
`void` | `started()`
`ExecHandleState` | `waitForFinish()`

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

Constructor Detail

### DefaultExecHandle

    public DefaultExecHandle(File directory, java.lang.String command, java.util.List arguments, int normalTerminationExitCode, java.util.Map environment, long keepWaitingTimeout, ExecOutputHandle standardOutputHandle, ExecOutputHandle errorOutputHandle, ExecHandleNotifierFactory notifierFactory, java.util.List listeners)

Method Detail

### abort

    public void abort()

### aborted

    public void aborted()

### addListeners

    public void addListeners(ExecHandleListener listeners)

### failed

    public void failed(java.lang.Throwable failureCause)

### finished

    public void finished(int exitCode)

### getArguments

    public java.util.List getArguments()

### getCommand

    public java.lang.String getCommand()

### getDirectory

    public File getDirectory()

### getEnvironment

    public java.util.Map getEnvironment()

### getErrorOutputHandle

    public ExecOutputHandle getErrorOutputHandle()

### getExitCode

    public int getExitCode()

### getFailureCause

    public java.lang.Throwable getFailureCause()

### getKeepWaitingTimeout

    public long getKeepWaitingTimeout()

### getListeners

    public java.util.List getListeners()

### getStandardOutputHandle

    public ExecOutputHandle getStandardOutputHandle()

### getState

    public ExecHandleState getState()

### removeListeners

    public void removeListeners(ExecHandleListener listeners)

### start

    public void start()

### startAndWaitForFinish

    public ExecHandleState startAndWaitForFinish()

### started

    public void started()

### waitForFinish

    public ExecHandleState waitForFinish()

Groovy Documentation