Exec (Gradle API 2.0)

org.gradle.api.tasks.Exec

All Implemented Interfaces and Traits:: ExecSpec

public class Exec
extends ConventionTask

Executes a command line process. Example:

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

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

   //on linux
   commandLine './stop.sh'

   //store the output instead of printing to the console:
   standardOutput = new ByteArrayOutputStream()

   //extension method stopTomcat.output() can be used to obtain the output:
   ext.output = {
     return standardOutput.toString()
   }
 }

Constructor Summary

Constructors
Constructor and description
`Exec ()`

Methods Summary

Methods
Type	Name and description
`Exec`	`args(Object... args)` {@inheritDoc}
`ExecSpec`	`args(Iterable<?> args)` {@inheritDoc}
`Exec`	`commandLine(Object... arguments)` {@inheritDoc}
`ExecSpec`	`commandLine(Iterable<?> args)` {@inheritDoc}
`Exec`	`copyTo(ProcessForkOptions target)` {@inheritDoc}
`Exec`	`environment(String name, Object value)` {@inheritDoc}
`Exec`	`environment(Map<String, ?> environmentVariables)` {@inheritDoc}
`Exec`	`executable(Object executable)` {@inheritDoc}
`List<String>`	`getArgs()` {@inheritDoc}
`List<String>`	`getCommandLine()` {@inheritDoc}
`Map<String, Object>`	`getEnvironment()` {@inheritDoc}
`OutputStream`	`getErrorOutput()` {@inheritDoc}
`protected ExecActionFactory`	`getExecActionFactory()`
`ExecResult`	`getExecResult()` Returns the result for the command run by this task.
`String`	`getExecutable()` {@inheritDoc}
`InputStream`	`getStandardInput()` {@inheritDoc}
`OutputStream`	`getStandardOutput()` {@inheritDoc}
`File`	`getWorkingDir()` {@inheritDoc}
`boolean`	`isIgnoreExitValue()` {@inheritDoc}
`Exec`	`setArgs(Iterable<?> arguments)` {@inheritDoc}
`void`	`setCommandLine(Iterable<?> args)` {@inheritDoc}
`void`	`setCommandLine(Object... args)` {@inheritDoc}
`void`	`setEnvironment(Map<String, ?> environmentVariables)` {@inheritDoc}
`Exec`	`setErrorOutput(OutputStream outputStream)` {@inheritDoc}
`void`	`setExecutable(Object executable)` {@inheritDoc}
`ExecSpec`	`setIgnoreExitValue(boolean ignoreExitValue)` {@inheritDoc}
`Exec`	`setStandardInput(InputStream inputStream)` {@inheritDoc}
`Exec`	`setStandardOutput(OutputStream outputStream)` {@inheritDoc}
`void`	`setWorkingDir(Object dir)` {@inheritDoc}
`Exec`	`workingDir(Object dir)` {@inheritDoc}

- Constructor Detail
  - public Exec()
- Method Detail
  - public Exec args(Object... args)
    
    {@inheritDoc}
  - public ExecSpec args(Iterable<?> args)
    
    {@inheritDoc}
  - public Exec commandLine(Object... arguments)
    
    {@inheritDoc}
  - public ExecSpec commandLine(Iterable<?> args)
    
    {@inheritDoc}
  - public Exec copyTo(ProcessForkOptions target)
    
    {@inheritDoc}
  - public Exec environment(String name, Object value)
    
    {@inheritDoc}
  - public Exec environment(Map<String, ?> environmentVariables)
    
    {@inheritDoc}
  - public Exec executable(Object executable)
    
    {@inheritDoc}
  - public List<String> getArgs()
    
    {@inheritDoc}
  - public List<String> getCommandLine()
    
    {@inheritDoc}
  - public Map<String, Object> getEnvironment()
    
    {@inheritDoc}
  - public OutputStream getErrorOutput()
    
    {@inheritDoc}
  - @Inject protected ExecActionFactory getExecActionFactory()
  - 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.
  - public String getExecutable()
    
    {@inheritDoc}
  - public InputStream getStandardInput()
    
    {@inheritDoc}
  - public OutputStream getStandardOutput()
    
    {@inheritDoc}
  - public File getWorkingDir()
    
    {@inheritDoc}
  - public boolean isIgnoreExitValue()
    
    {@inheritDoc}
  - public Exec setArgs(Iterable<?> arguments)
    
    {@inheritDoc}
  - public void setCommandLine(Iterable<?> args)
    
    {@inheritDoc}
  - public void setCommandLine(Object... args)
    
    {@inheritDoc}
  - public void setEnvironment(Map<String, ?> environmentVariables)
    
    {@inheritDoc}
  - public Exec setErrorOutput(OutputStream outputStream)
    
    {@inheritDoc}
  - public void setExecutable(Object executable)
    
    {@inheritDoc}
  - public ExecSpec setIgnoreExitValue(boolean ignoreExitValue)
    
    {@inheritDoc}
  - public Exec setStandardInput(InputStream inputStream)
    
    {@inheritDoc}
  - public Exec setStandardOutput(OutputStream outputStream)
    
    {@inheritDoc}
  - public void setWorkingDir(Object dir)
    
    {@inheritDoc}
  - public Exec workingDir(Object dir)
    
    {@inheritDoc}

Summary:
Constructor
Method

| Detail:
Constructor
Method

Gradle API 2.0

[Java] Class Exec

Constructor Summary

Methods Summary

Constructor Detail

public Exec()

Method Detail

public Exec args(Object... args)

public ExecSpec args(Iterable<?> args)

public Exec commandLine(Object... arguments)

public ExecSpec commandLine(Iterable<?> args)

public Exec copyTo(ProcessForkOptions target)

public Exec environment(String name, Object value)

public Exec environment(Map<String, ?> environmentVariables)

public Exec executable(Object executable)

public List<String> getArgs()

public List<String> getCommandLine()

public Map<String, Object> getEnvironment()

public OutputStream getErrorOutput()

@Inject protected ExecActionFactory getExecActionFactory()

public ExecResult getExecResult()

public String getExecutable()

public InputStream getStandardInput()

public OutputStream getStandardOutput()

public File getWorkingDir()

public boolean isIgnoreExitValue()

public Exec setArgs(Iterable<?> arguments)

public void setCommandLine(Iterable<?> args)

public void setCommandLine(Object... args)

public void setEnvironment(Map<String, ?> environmentVariables)

public Exec setErrorOutput(OutputStream outputStream)

public void setExecutable(Object executable)

public ExecSpec setIgnoreExitValue(boolean ignoreExitValue)

public Exec setStandardInput(InputStream inputStream)

public Exec setStandardOutput(OutputStream outputStream)

public void setWorkingDir(Object dir)

public Exec workingDir(Object dir)