Package org.gradle.api.tasks
Class Exec
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
- All Implemented Interfaces:
Comparable<Task>,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.IConventionAware,org.gradle.api.internal.TaskInternal,Named,ExtensionAware,Task,BaseExecSpec,ExecSpec,ProcessForkOptions,Configurable<Task>
@DisableCachingByDefault(because="Gradle would require more information to cache this task")
public abstract class Exec
extends AbstractExecTask<Exec>
Executes a command line process. Example:
task stopTomcat(type:Exec) {
workingDir '../tomcat/bin'
//on windows:
commandLine 'cmd.exe', '/d', '/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()
}
}
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer -
Field Summary
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetArgs()Returns the arguments for the command to be executed.Returns the output stream to consume standard error from the process executing the command.Returns the standard input stream for the process executing the command.Returns the output stream to consume standard output from the process executing the command.booleanTells whether a non-zero exit value is ignored, or an exception thrown.Sets the arguments for the command to be executed.Sets the arguments for the command to be executed.setErrorOutput(OutputStream outputStream) Sets the output stream to consume standard error from the process executing the command.setIgnoreExitValue(boolean ignoreExitValue) Sets whether a non-zero exit value is ignored, or an exception thrown.setStandardInput(InputStream inputStream) Sets the standard input stream for the process executing the command.setStandardOutput(OutputStream outputStream) Sets the output stream to consume standard output from the process executing the command.Methods inherited from class org.gradle.api.tasks.AbstractExecTask
args, args, commandLine, commandLine, copyTo, environment, environment, exec, executable, getArgumentProviders, getCommandLine, getEnvironment, getExecActionFactory, getExecutable, getExecutionResult, getObjectFactory, getWorkingDir, setCommandLine, setCommandLine, setCommandLine, setEnvironment, setExecutable, setExecutable, setWorkingDir, setWorkingDir, workingDirMethods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTask
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.Task
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
-
Constructor Details
-
Exec
public Exec()
-
-
Method Details
-
getArgs
Returns the arguments for the command to be executed. Defaults to an empty list.- Specified by:
getArgsin interfaceExecSpec- Overrides:
getArgsin classAbstractExecTask<Exec>
-
setArgs
Sets the arguments for the command to be executed.- Specified by:
setArgsin interfaceExecSpec- Overrides:
setArgsin classAbstractExecTask<Exec>- Parameters:
arguments- args for the command- Returns:
- this
-
setArgs
Sets the arguments for the command to be executed.- Specified by:
setArgsin interfaceExecSpec- Overrides:
setArgsin classAbstractExecTask<Exec>- Parameters:
arguments- args for the command- Returns:
- this
-
isIgnoreExitValue
public boolean isIgnoreExitValue()Tells whether a non-zero exit value is ignored, or an exception thrown. Defaults tofalse.- Specified by:
isIgnoreExitValuein interfaceBaseExecSpec- Overrides:
isIgnoreExitValuein classAbstractExecTask<Exec>- Returns:
- whether a non-zero exit value is ignored, or an exception thrown
-
setIgnoreExitValue
Sets whether a non-zero exit value is ignored, or an exception thrown.- Specified by:
setIgnoreExitValuein interfaceBaseExecSpec- Overrides:
setIgnoreExitValuein classAbstractExecTask<Exec>- Parameters:
ignoreExitValue- whether a non-zero exit value is ignored, or an exception thrown- Returns:
- this
-
getStandardInput
Returns the standard input stream for the process executing the command. The stream is closed after the process completes. Defaults to an empty stream.- Specified by:
getStandardInputin interfaceBaseExecSpec- Overrides:
getStandardInputin classAbstractExecTask<Exec>- Returns:
- The standard input stream.
-
setStandardInput
Sets the standard input stream for the process executing the command. The stream is closed after the process completes.- Specified by:
setStandardInputin interfaceBaseExecSpec- Overrides:
setStandardInputin classAbstractExecTask<Exec>- Parameters:
inputStream- The standard input stream for the process. Must not be null.- Returns:
- this
-
getStandardOutput
Returns the output stream to consume standard output from the process executing the command. Defaults toSystem.out.- Specified by:
getStandardOutputin interfaceBaseExecSpec- Overrides:
getStandardOutputin classAbstractExecTask<Exec>- Returns:
- The output stream
-
setStandardOutput
Sets the output stream to consume standard output from the process executing the command. The stream is closed after the process completes.- Specified by:
setStandardOutputin interfaceBaseExecSpec- Overrides:
setStandardOutputin classAbstractExecTask<Exec>- Parameters:
outputStream- The standard output stream for the process. Must not be null.- Returns:
- this
-
getErrorOutput
Returns the output stream to consume standard error from the process executing the command. Default toSystem.err.- Specified by:
getErrorOutputin interfaceBaseExecSpec- Overrides:
getErrorOutputin classAbstractExecTask<Exec>- Returns:
- The error output stream.
-
setErrorOutput
Sets the output stream to consume standard error from the process executing the command. The stream is closed after the process completes.- Specified by:
setErrorOutputin interfaceBaseExecSpec- Overrides:
setErrorOutputin classAbstractExecTask<Exec>- Parameters:
outputStream- The standard output error stream for the process. Must not be null.- Returns:
- this
-