Package org.gradle.api.tasks

Klasse AbstractExecTask<T extends AbstractExecTask>

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.AbstractExecTask<T>

Typparameter:

T - The concrete type of the class.

Alle implementierten Schnittstellen:

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>

Bekannte direkte Unterklassen:

Exec, RunTestExecutable

@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly")
public abstract class AbstractExecTask<T extends AbstractExecTask>
extends org.gradle.api.internal.ConventionTask
implements ExecSpec

AbstractExecTask is the base class for all exec tasks.

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen org.gradle.api.Task

Task.Namer

Feldübersicht

Von Schnittstelle geerbte Felder org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractExecTask(Class<T> taskType)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
T	args(Iterable<?> args)	Adds arguments for the command to be executed.
T	args(Object... args)	Adds arguments for the command to be executed.
T	commandLine(Iterable<?> args)	Sets the full command line, including the executable to be executed plus its arguments.
T	commandLine(Object... arguments)	Sets the full command line, including the executable to be executed plus its arguments.
T	copyTo(ProcessForkOptions target)	Copies these options to the given target options.
T	environment(String name, Object value)	Adds an environment variable to the environment for this process.
T	environment(Map<String,?> environmentVariables)	Adds some environment variables to the environment for this process.
protected void	exec()
T	executable(Object executable)	Sets the name of the executable to use.
List<String>	getArgs()	Returns the arguments for the command to be executed.
List<CommandLineArgumentProvider>	getArgumentProviders()	Argument providers for the application.
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.
protected org.gradle.process.internal.ExecActionFactory	getExecActionFactory()
String	getExecutable()	Returns the name of the executable to use.
Provider<ExecResult>	getExecutionResult()	Returns the result for the command run by this task.
protected ObjectFactory	getObjectFactory()
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.
T	setArgs(Iterable<?> arguments)	Sets the arguments for the command to be executed.
T	setArgs(List<String> 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	setCommandLine(List<String> 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.
T	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.
void	setExecutable(String executable)	Sets the name of the executable to use.
T	setIgnoreExitValue(boolean ignoreExitValue)	Sets whether a non-zero exit value is ignored, or an exception thrown.
T	setStandardInput(InputStream inputStream)	Sets the standard input stream for the process executing the command.
T	setStandardOutput(OutputStream outputStream)	Sets the output stream to consume standard output from the process executing the command.
void	setWorkingDir(File dir)	Sets the working directory for the process.
void	setWorkingDir(Object dir)	Sets the working directory for the process.
T	workingDir(Object dir)	Sets the working directory for the process.

Von Klasse geerbte Methoden org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Von Klasse geerbte Methoden 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, usesService

Von Klasse geerbte Methoden 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, setImpliesSubProjects

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Konstruktordetails

AbstractExecTask

public AbstractExecTask(Class<T> taskType)

Methodendetails

getObjectFactory

@Inject
protected ObjectFactory getObjectFactory()

getExecActionFactory

@Inject
protected org.gradle.process.internal.ExecActionFactory getExecActionFactory()

exec

protected void exec()

commandLine

public T commandLine(Object... arguments)

Sets the full command line, including the executable to be executed plus its arguments.

Angegeben von:

commandLine in Schnittstelle ExecSpec

Parameter:

arguments - the command plus the args to be executed

Gibt zurück:

this

commandLine

public T commandLine(Iterable<?> args)

Sets the full command line, including the executable to be executed plus its arguments.

Angegeben von:

commandLine in Schnittstelle ExecSpec

Parameter:

args - the command plus the args to be executed

Gibt zurück:

this

args

public T args(Object... args)

Adds arguments for the command to be executed.

Angegeben von:

args in Schnittstelle ExecSpec

Parameter:

args - args for the command

Gibt zurück:

this

args

public T args(Iterable<?> args)

Adds arguments for the command to be executed.

Angegeben von:

args in Schnittstelle ExecSpec

Parameter:

args - args for the command

Gibt zurück:

this

setArgs

public T setArgs(List<String> arguments)

Sets the arguments for the command to be executed.

Angegeben von:

setArgs in Schnittstelle ExecSpec

Parameter:

arguments - args for the command

Gibt zurück:

this

setArgs

public T setArgs(@Nullable
 Iterable<?> arguments)

Sets the arguments for the command to be executed.

Angegeben von:

setArgs in Schnittstelle ExecSpec

Parameter:

arguments - args for the command

Gibt zurück:

this

getArgs

@Nullable
@Optional
@Input
public List<String> getArgs()

Returns the arguments for the command to be executed. Defaults to an empty list.

Angegeben von:

getArgs in Schnittstelle ExecSpec

getArgumentProviders

public List<CommandLineArgumentProvider> getArgumentProviders()

Argument providers for the application.

Angegeben von:

getArgumentProviders in Schnittstelle ExecSpec

getCommandLine

@Internal
public List<String> getCommandLine()

Returns the full command line, including the executable plus its arguments.

Angegeben von:

getCommandLine in Schnittstelle BaseExecSpec

Gibt zurück:

The full command line, including the executable plus its arguments

setCommandLine

public void setCommandLine(List<String> args)

Sets the full command line, including the executable to be executed plus its arguments.

Angegeben von:

setCommandLine in Schnittstelle ExecSpec

Parameter:

args - the command plus the args to be executed

setCommandLine

public void setCommandLine(Iterable<?> args)

Sets the full command line, including the executable to be executed plus its arguments.

Angegeben von:

setCommandLine in Schnittstelle ExecSpec

Parameter:

args - the command plus the args to be executed

setCommandLine

public void setCommandLine(Object... args)

Sets the full command line, including the executable to be executed plus its arguments.

Angegeben von:

setCommandLine in Schnittstelle ExecSpec

Parameter:

args - the command plus the args to be executed

getExecutable

@Nullable
@Optional
@Input
public String getExecutable()

Returns the name of the executable to use.

Angegeben von:

getExecutable in Schnittstelle ProcessForkOptions

Gibt zurück:

The executable.

setExecutable

public void setExecutable(@Nullable
 String executable)

Sets the name of the executable to use.

Angegeben von:

setExecutable in Schnittstelle ProcessForkOptions

Parameter:

executable - The executable. Must not be null.

setExecutable

public void setExecutable(Object executable)

Sets the name of the executable to use.

Angegeben von:

setExecutable in Schnittstelle ProcessForkOptions

Parameter:

executable - The executable. Must not be null.

executable

public T executable(Object executable)

Sets the name of the executable to use.

Angegeben von:

executable in Schnittstelle ProcessForkOptions

Parameter:

executable - The executable. Must not be null.

Gibt zurück:

this

getWorkingDir

@Internal
public File getWorkingDir()

Returns the working directory for the process. Defaults to the project directory.

Angegeben von:

getWorkingDir in Schnittstelle ProcessForkOptions

Gibt zurück:

The working directory. Never returns null.

setWorkingDir

public void setWorkingDir(File dir)

Sets the working directory for the process.

Angegeben von:

setWorkingDir in Schnittstelle ProcessForkOptions

Parameter:

dir - The working directory. Must not be null.

setWorkingDir

public void setWorkingDir(Object dir)

Sets the working directory for the process. The supplied argument is evaluated as per Project.file(Object).

Angegeben von:

setWorkingDir in Schnittstelle ProcessForkOptions

Parameter:

dir - The working directory. Must not be null.

workingDir

public T workingDir(Object dir)

Sets the working directory for the process. The supplied argument is evaluated as per Project.file(Object).

Angegeben von:

workingDir in Schnittstelle ProcessForkOptions

Parameter:

dir - The working directory. Must not be null.

Gibt zurück:

this

getEnvironment

@Internal
public Map<String,Object> getEnvironment()

The environment variables to use for the process. Defaults to the environment of this process.

Angegeben von:

getEnvironment in Schnittstelle ProcessForkOptions

Gibt zurück:

The environment. Returns an empty map when there are no environment variables.

setEnvironment

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

Sets the environment variable to use for the process.

Angegeben von:

setEnvironment in Schnittstelle ProcessForkOptions

Parameter:

environmentVariables - The environment variables. Must not be null.

environment

public T environment(String name,
 Object value)

Adds an environment variable to the environment for this process.

Angegeben von:

environment in Schnittstelle ProcessForkOptions

Parameter:

name - The name of the variable.

value - The value for the variable. Must not be null.

Gibt zurück:

this

environment

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

Adds some environment variables to the environment for this process.

Angegeben von:

environment in Schnittstelle ProcessForkOptions

Parameter:

environmentVariables - The environment variables. Must not be null.

Gibt zurück:

this

copyTo

public T copyTo(ProcessForkOptions target)

Copies these options to the given target options.

Angegeben von:

copyTo in Schnittstelle ProcessForkOptions

Parameter:

target - The target options

Gibt zurück:

this

setStandardInput

public T setStandardInput(InputStream inputStream)

Sets the standard input stream for the process executing the command. The stream is closed after the process completes.

Angegeben von:

setStandardInput in Schnittstelle BaseExecSpec

Parameter:

inputStream - The standard input stream for the process. Must not be null.

Gibt zurück:

this

getStandardInput

@Internal
public InputStream 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.

Angegeben von:

getStandardInput in Schnittstelle BaseExecSpec

Gibt zurück:

The standard input stream.

setStandardOutput

public T setStandardOutput(OutputStream outputStream)

Sets the output stream to consume standard output from the process executing the command. The stream is closed after the process completes.

Angegeben von:

setStandardOutput in Schnittstelle BaseExecSpec

Parameter:

outputStream - The standard output stream for the process. Must not be null.

Gibt zurück:

this

getStandardOutput

@Internal
public OutputStream getStandardOutput()

Returns the output stream to consume standard output from the process executing the command. Defaults to System.out.

Angegeben von:

getStandardOutput in Schnittstelle BaseExecSpec

Gibt zurück:

The output stream

setErrorOutput

public T setErrorOutput(OutputStream outputStream)

Sets the output stream to consume standard error from the process executing the command. The stream is closed after the process completes.

Angegeben von:

setErrorOutput in Schnittstelle BaseExecSpec

Parameter:

outputStream - The standard output error stream for the process. Must not be null.

Gibt zurück:

this

getErrorOutput

@Internal
public OutputStream getErrorOutput()

Returns the output stream to consume standard error from the process executing the command. Default to System.err.

Angegeben von:

getErrorOutput in Schnittstelle BaseExecSpec

Gibt zurück:

The error output stream.

setIgnoreExitValue

public T setIgnoreExitValue(boolean ignoreExitValue)

Sets whether a non-zero exit value is ignored, or an exception thrown.

Angegeben von:

setIgnoreExitValue in Schnittstelle BaseExecSpec

Parameter:

ignoreExitValue - whether a non-zero exit value is ignored, or an exception thrown

Gibt zurück:

this

isIgnoreExitValue

@Input
public boolean isIgnoreExitValue()

Tells whether a non-zero exit value is ignored, or an exception thrown. Defaults to false.

Angegeben von:

isIgnoreExitValue in Schnittstelle BaseExecSpec

Gibt zurück:

whether a non-zero exit value is ignored, or an exception thrown

getExecutionResult

@Internal
public Provider<ExecResult> getExecutionResult()

Returns the result for the command run by this task. The provider has no value if this task has not been executed yet.

Gibt zurück:

A provider of the result.

Seit:

6.1