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

org.gradle.api.tasks
[Java] Class Exec

java.lang.Object
  org.gradle.api.internal.AbstractTask
      org.gradle.api.DefaultTask
          org.gradle.api.internal.ConventionTask
              org.gradle.api.tasks.Exec
All Implemented Interfaces:
ExecSpec
public class Exec
extends org.gradle.api.internal.ConventionTask

Executes a command line process. Example: 

 task stopTomcat(type:Exec) {
   workingDir '../tomcat/bin'

   //on windows:
   commandLine 'cmd', '/c', 'stop.bat'

   //on linux (oh yeah!!!)
   commandLine './stop.sh'
 }
Authors:
Hans Dockter

Field Summary
 
Fields inherited from class org.gradle.api.internal.ConventionTask
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION
 
Fields inherited from class DefaultTask
TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION
 
Constructor Summary
Exec()

 
Method Summary
Exec args(java.lang.Object... args)

{@inheritDoc}
ExecSpec args(java.lang.Iterable args)

{@inheritDoc}
Exec commandLine(java.lang.Object... arguments)

{@inheritDoc}
ExecSpec commandLine(java.lang.Iterable args)

{@inheritDoc}
Exec copyTo(ProcessForkOptions target)

{@inheritDoc}
Exec environment(java.lang.String name, java.lang.Object value)

{@inheritDoc}
Exec environment(java.util.Map environmentVariables)

{@inheritDoc}
Exec executable(java.lang.Object executable)

{@inheritDoc}
java.util.List getArgs()

{@inheritDoc}
java.util.List getCommandLine()

{@inheritDoc}
java.util.Map getEnvironment()

{@inheritDoc}
java.io.OutputStream getErrorOutput()

{@inheritDoc}
ExecResult getExecResult()

Returns the result for the command run by this task.

java.lang.String getExecutable()

{@inheritDoc}
java.io.InputStream getStandardInput()

{@inheritDoc}
java.io.OutputStream getStandardOutput()

{@inheritDoc}
java.io.File getWorkingDir()

{@inheritDoc}
boolean isIgnoreExitValue()

{@inheritDoc}
Exec setArgs(java.lang.Iterable arguments)

{@inheritDoc}
void setCommandLine(java.lang.Iterable args)

{@inheritDoc}
void setCommandLine(java.lang.Object... args)

{@inheritDoc}
void setEnvironment(java.util.Map environmentVariables)

{@inheritDoc}
Exec setErrorOutput(java.io.OutputStream outputStream)

{@inheritDoc}
void setExecutable(java.lang.Object executable)

{@inheritDoc}
ExecSpec setIgnoreExitValue(boolean ignoreExitValue)

{@inheritDoc}
Exec setStandardInput(java.io.InputStream inputStream)

{@inheritDoc}
Exec setStandardOutput(java.io.OutputStream outputStream)

{@inheritDoc}
void setWorkingDir(java.lang.Object dir)

{@inheritDoc}
Exec workingDir(java.lang.Object dir)

{@inheritDoc}
 
Methods inherited from class org.gradle.api.internal.ConventionTask
org.gradle.api.internal.ConventionTask#conventionMapping(java.lang.String, org.gradle.api.tasks.ConventionValue), org.gradle.api.internal.ConventionTask#getConventionMapping(), org.gradle.api.internal.ConventionTask#setConventionMapping(org.gradle.api.internal.ConventionMapping), org.gradle.api.internal.ConventionTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.internal.ConventionTask#toString(), org.gradle.api.internal.ConventionTask#compareTo(org.gradle.api.Task), org.gradle.api.internal.ConventionTask#compareTo(java.lang.Object), org.gradle.api.internal.ConventionTask#getName(), org.gradle.api.internal.ConventionTask#getActions(), org.gradle.api.internal.ConventionTask#setName(java.lang.String), org.gradle.api.internal.ConventionTask#getState(), org.gradle.api.internal.ConventionTask#getPath(), org.gradle.api.internal.ConventionTask#getLogger(), org.gradle.api.internal.ConventionTask#leftShift(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#execute(), org.gradle.api.internal.ConventionTask#configure(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#configure(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#isEnabled(), org.gradle.api.internal.ConventionTask#getDescription(), org.gradle.api.internal.ConventionTask#captureStandardOutput(org.gradle.api.logging.LogLevel), org.gradle.api.internal.ConventionTask#disableStandardOutputCapture(), org.gradle.api.internal.ConventionTask#property(java.lang.String), org.gradle.api.internal.ConventionTask#setEnabled(boolean), org.gradle.api.internal.ConventionTask#getOutputs(), org.gradle.api.internal.ConventionTask#getOutputs(), org.gradle.api.internal.ConventionTask#getProject(), org.gradle.api.internal.ConventionTask#setActions(java.util.List), org.gradle.api.internal.ConventionTask#getTaskDependencies(), org.gradle.api.internal.ConventionTask#getTaskDependencies(), org.gradle.api.internal.ConventionTask#getDependsOn(), org.gradle.api.internal.ConventionTask#setDependsOn(java.lang.Iterable), org.gradle.api.internal.ConventionTask#dependsOn([Ljava.lang.Object;), org.gradle.api.internal.ConventionTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.ConventionTask#onlyIf(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.internal.ConventionTask#setDidWork(boolean), org.gradle.api.internal.ConventionTask#getDidWork(), org.gradle.api.internal.ConventionTask#doFirst(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#doFirst(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#doLast(org.gradle.api.Action), org.gradle.api.internal.ConventionTask#doLast(groovy.lang.Closure), org.gradle.api.internal.ConventionTask#deleteAllActions(), org.gradle.api.internal.ConventionTask#getEnabled(), org.gradle.api.internal.ConventionTask#getAnt(), org.gradle.api.internal.ConventionTask#getLogging(), org.gradle.api.internal.ConventionTask#hasProperty(java.lang.String), org.gradle.api.internal.ConventionTask#getConvention(), org.gradle.api.internal.ConventionTask#setDescription(java.lang.String), org.gradle.api.internal.ConventionTask#getGroup(), org.gradle.api.internal.ConventionTask#setGroup(java.lang.String), org.gradle.api.internal.ConventionTask#dependsOnTaskDidWork(), org.gradle.api.internal.ConventionTask#getInputs(), org.gradle.api.internal.ConventionTask#getTemporaryDir(), org.gradle.api.internal.ConventionTask#getExtensions(), org.gradle.api.internal.ConventionTask#getAsDynamicObject(), org.gradle.api.internal.ConventionTask#getAdditionalProperties(), org.gradle.api.internal.ConventionTask#getStandardOutputCapture(), org.gradle.api.internal.ConventionTask#executeWithoutThrowingTaskFailure(), org.gradle.api.internal.ConventionTask#setProject(org.gradle.api.Project), org.gradle.api.internal.ConventionTask#getDynamicObjectHelper(), org.gradle.api.internal.ConventionTask#addValidator(org.gradle.api.internal.tasks.execution.TaskValidator), org.gradle.api.internal.ConventionTask#getValidators(), org.gradle.api.internal.ConventionTask#getExecuter(), org.gradle.api.internal.ConventionTask#setExecuter(org.gradle.api.internal.tasks.TaskExecuter), org.gradle.api.internal.ConventionTask#getOnlyIf(), org.gradle.api.internal.ConventionTask#getTemporaryDirFactory(), org.gradle.api.internal.ConventionTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, java.lang.String, java.util.concurrent.Callable), org.gradle.api.internal.ConventionTask#wait(), org.gradle.api.internal.ConventionTask#wait(long), org.gradle.api.internal.ConventionTask#wait(long, int), org.gradle.api.internal.ConventionTask#equals(java.lang.Object), org.gradle.api.internal.ConventionTask#hashCode(), org.gradle.api.internal.ConventionTask#getClass(), org.gradle.api.internal.ConventionTask#notify(), org.gradle.api.internal.ConventionTask#notifyAll()
 
Methods inherited from class DefaultTask
setProperty, toString, compareTo, compareTo, getName, getActions, setName, getState, getPath, getLogger, leftShift, execute, configure, configure, isEnabled, getDescription, captureStandardOutput, disableStandardOutputCapture, property, setEnabled, getOutputs, getOutputs, getProject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, getDidWork, doFirst, doFirst, doLast, doLast, deleteAllActions, getEnabled, getAnt, getLogging, hasProperty, getConvention, setDescription, getGroup, setGroup, dependsOnTaskDidWork, getInputs, getTemporaryDir, getExtensions, getAsDynamicObject, getAdditionalProperties, getStandardOutputCapture, executeWithoutThrowingTaskFailure, setProject, getDynamicObjectHelper, addValidator, getValidators, getExecuter, setExecuter, getOnlyIf, getTemporaryDirFactory, injectIntoNewInstance, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
 

Constructor Detail

Exec

public Exec()

 
Method Detail

args

public Exec args(java.lang.Object... args)
{@inheritDoc}

args

public ExecSpec args(java.lang.Iterable args)
{@inheritDoc}

commandLine

public Exec commandLine(java.lang.Object... arguments)
{@inheritDoc}

commandLine

public ExecSpec commandLine(java.lang.Iterable args)
{@inheritDoc}

copyTo

public Exec copyTo(ProcessForkOptions target)
{@inheritDoc}

environment

public Exec environment(java.lang.String name, java.lang.Object value)
{@inheritDoc}

environment

public Exec environment(java.util.Map environmentVariables)
{@inheritDoc}

executable

public Exec executable(java.lang.Object executable)
{@inheritDoc}

getArgs

public java.util.List getArgs()
{@inheritDoc}

getCommandLine

public java.util.List getCommandLine()
{@inheritDoc}

getEnvironment

public java.util.Map getEnvironment()
{@inheritDoc}

getErrorOutput

public java.io.OutputStream getErrorOutput()
{@inheritDoc}

getExecResult

public ExecResult getExecResult()
Returns the result for the command run by this task. Returns null if this task has not been executed yet.
Returns:
The result. Returns null if this task has not been executed yet.

getExecutable

public java.lang.String getExecutable()
{@inheritDoc}

getStandardInput

public java.io.InputStream getStandardInput()
{@inheritDoc}

getStandardOutput

public java.io.OutputStream getStandardOutput()
{@inheritDoc}

getWorkingDir

public java.io.File getWorkingDir()
{@inheritDoc}

isIgnoreExitValue

public boolean isIgnoreExitValue()
{@inheritDoc}

setArgs

public Exec setArgs(java.lang.Iterable arguments)
{@inheritDoc}

setCommandLine

public void setCommandLine(java.lang.Iterable args)
{@inheritDoc}

setCommandLine

public void setCommandLine(java.lang.Object... args)
{@inheritDoc}

setEnvironment

public void setEnvironment(java.util.Map environmentVariables)
{@inheritDoc}

setErrorOutput

public Exec setErrorOutput(java.io.OutputStream outputStream)
{@inheritDoc}

setExecutable

public void setExecutable(java.lang.Object executable)
{@inheritDoc}

setIgnoreExitValue

public ExecSpec setIgnoreExitValue(boolean ignoreExitValue)
{@inheritDoc}

setStandardInput

public Exec setStandardInput(java.io.InputStream inputStream)
{@inheritDoc}

setStandardOutput

public Exec setStandardOutput(java.io.OutputStream outputStream)
{@inheritDoc}

setWorkingDir

public void setWorkingDir(java.lang.Object dir)
{@inheritDoc}

workingDir

public Exec workingDir(java.lang.Object dir)
{@inheritDoc}

 

Groovy Documentation