|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.api.internal.AbstractTask org.gradle.api.DefaultTask org.gradle.api.internal.ConventionTask org.gradle.api.tasks.Exec
public class Exec
Executes a command line process. Example:
task stopTomcat(type:Exec) { workingDir = file('../tomcat/bin') //on windows: commandLine = ['cmd', '/c', 'stop.bat'] //on linux (oh yeah!!!) commandLine = ['./stop.sh'] }
Field Summary |
---|
Fields inherited from interface org.gradle.api.Task |
---|
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE |
Constructor Summary | |
---|---|
Exec()
|
Method Summary | |
---|---|
ExecSpec |
args(Iterable<?> args)
Adds arguments for the command to be executed. |
Exec |
args(Object... args)
Adds arguments for the command to be executed. |
ExecSpec |
commandLine(Iterable<?> args)
Sets the full command line, including the executable to be executed plus its arguments. |
Exec |
commandLine(Object... arguments)
Sets the full command line, including the executable to be executed plus its arguments. |
Exec |
copyTo(ProcessForkOptions target)
Copies these options to the given target options. |
Exec |
environment(Map<String,?> environmentVariables)
Adds some environment variables to the environment for this process. |
Exec |
environment(String name,
Object value)
Adds an environment variable to the environment for this process. |
Exec |
executable(Object executable)
Sets the name of the executable to use. |
List<String> |
getArgs()
Returns the arguments for the command to be executed. |
List<String> |
getCommandLine()
Returns the full command line, including the executable plus its arguments. |
Map<String,Object> |
getEnvironment()
The environment variables to use for the process. |
OutputStream |
getErrorOutput()
Returns the output stream to consume standard error from the process executing the command. |
ExecResult |
getExecResult()
Returns the result for the command run by this task. |
String |
getExecutable()
Returns the name of the executable to use. |
InputStream |
getStandardInput()
Returns the standard input stream for the process executing the command. |
OutputStream |
getStandardOutput()
Returns the output stream to consume standard output from the process executing the command. |
File |
getWorkingDir()
Returns the working directory for the process. |
boolean |
isIgnoreExitValue()
Tells whether a non-zero exit value is ignored, or an exception thrown. |
Exec |
setArgs(Iterable<?> arguments)
Sets the arguments for the command to be executed. |
void |
setCommandLine(Iterable<?> args)
Sets the full command line, including the executable to be executed plus its arguments. |
void |
setCommandLine(Object... args)
Sets the full command line, including the executable to be executed plus its arguments. |
void |
setEnvironment(Map<String,?> environmentVariables)
Sets the environment variable to use for the process. |
Exec |
setErrorOutput(OutputStream outputStream)
Sets the output stream to consume standard error from the process executing the command. |
void |
setExecutable(Object executable)
Sets the name of the executable to use. |
ExecSpec |
setIgnoreExitValue(boolean ignoreExitValue)
Sets whether a non-zero exit value is ignored, or an exception thrown. |
Exec |
setStandardInput(InputStream inputStream)
Sets the standard input stream for the process executing the command. |
Exec |
setStandardOutput(OutputStream outputStream)
Sets the output stream to consume standard output from the process executing the command. |
void |
setWorkingDir(Object dir)
Sets the working directory for the process. |
Exec |
workingDir(Object dir)
Sets the working directory for the process. |
Methods inherited from class org.gradle.api.internal.ConventionTask |
---|
conventionMapping, getConventionMapping, setConventionMapping |
Methods inherited from class org.gradle.api.internal.AbstractTask |
---|
addValidator, captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, execute, getActions, getAdditionalProperties, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setConvention, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Exec()
Method Detail |
---|
public Exec commandLine(Object... arguments)
commandLine
in interface ExecSpec
arguments
- the command plus the args to be executed
public ExecSpec commandLine(Iterable<?> args)
commandLine
in interface ExecSpec
args
- the command plus the args to be executed
public Exec args(Object... args)
args
in interface ExecSpec
args
- args for the command
public ExecSpec args(Iterable<?> args)
args
in interface ExecSpec
args
- args for the command
public Exec setArgs(Iterable<?> arguments)
setArgs
in interface ExecSpec
arguments
- args for the command
public List<String> getArgs()
getArgs
in interface ExecSpec
public List<String> getCommandLine()
getCommandLine
in interface BaseExecSpec
public void setCommandLine(Iterable<?> args)
setCommandLine
in interface ExecSpec
args
- the command plus the args to be executedpublic void setCommandLine(Object... args)
setCommandLine
in interface ExecSpec
args
- the command plus the args to be executedpublic String getExecutable()
getExecutable
in interface ProcessForkOptions
public void setExecutable(Object executable)
setExecutable
in interface ProcessForkOptions
executable
- The executable. Must not be null.public Exec executable(Object executable)
executable
in interface ProcessForkOptions
executable
- The executable. Must not be null.
public File getWorkingDir()
getWorkingDir
in interface ProcessForkOptions
public void setWorkingDir(Object dir)
Project.file(Object)
.
setWorkingDir
in interface ProcessForkOptions
dir
- The working directory. Must not be null.public Exec workingDir(Object dir)
Project.file(Object)
.
workingDir
in interface ProcessForkOptions
dir
- The working directory. Must not be null.
public Map<String,Object> getEnvironment()
getEnvironment
in interface ProcessForkOptions
public void setEnvironment(Map<String,?> environmentVariables)
setEnvironment
in interface ProcessForkOptions
environmentVariables
- The environment variables. Must not be null.public Exec environment(String name, Object value)
environment
in interface ProcessForkOptions
name
- The name of the variable.value
- The value for the variable. Must not be null.
public Exec environment(Map<String,?> environmentVariables)
environment
in interface ProcessForkOptions
environmentVariables
- The environment variables. Must not be null.
public Exec copyTo(ProcessForkOptions target)
copyTo
in interface ProcessForkOptions
target
- The target options
public Exec setStandardInput(InputStream inputStream)
setStandardInput
in interface BaseExecSpec
inputStream
- The standard input stream for the process. Must not be null.
public InputStream getStandardInput()
getStandardInput
in interface BaseExecSpec
public Exec setStandardOutput(OutputStream outputStream)
setStandardOutput
in interface BaseExecSpec
outputStream
- The standard output stream for the process. Must not be null.
public OutputStream getStandardOutput()
System.out
.
getStandardOutput
in interface BaseExecSpec
public Exec setErrorOutput(OutputStream outputStream)
setErrorOutput
in interface BaseExecSpec
outputStream
- The standard output error stream for the process. Must not be null.
public OutputStream getErrorOutput()
System.err
.
getErrorOutput
in interface BaseExecSpec
public ExecSpec setIgnoreExitValue(boolean ignoreExitValue)
setIgnoreExitValue
in interface BaseExecSpec
ignoreExitValue
- whether a non-zero exit value is ignored, or an exception thrown
public boolean isIgnoreExitValue()
false
.
isIgnoreExitValue
in interface BaseExecSpec
public ExecResult getExecResult()
null
if this task has not been executed yet.
null
if this task has not been executed yet.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |