public class JavaExec extends org.gradle.api.internal.ConventionTask implements JavaExecSpec
The process can be started in debug mode (see getDebug()
) in an ad-hoc manner by supplying the `--debug-jvm` switch when invoking the build.
gradle someJavaExecTask --debug-jvm
Task.Namer
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
コンストラクタと説明 |
---|
JavaExec() |
修飾子とタイプ | メソッドと説明 |
---|---|
JavaExecSpec |
args(Iterable<?> args)
Adds args for the main class to be executed.
|
JavaExec |
args(Object... args)
Adds args for the main class to be executed.
|
JavaExec |
bootstrapClasspath(Object... classpath)
Adds the given values to the end of the bootstrap classpath for the process.
|
JavaExec |
classpath(Object... paths)
Adds elements to the classpath for executing the main class.
|
JavaExec |
copyTo(JavaForkOptions options)
Copies these options to the given options.
|
JavaExec |
copyTo(ProcessForkOptions target)
Copies these options to the given target options.
|
JavaExec |
environment(Map<String,?> environmentVariables)
Adds some environment variables to the environment for this process.
|
JavaExec |
environment(String name,
Object value)
Adds an environment variable to the environment for this process.
|
void |
exec() |
JavaExec |
executable(Object executable)
Sets the name of the executable to use.
|
List<String> |
getAllJvmArgs()
Returns the full set of arguments to use to launch the JVM for the process.
|
List<String> |
getArgs()
Returns the arguments passed to the main class to be executed.
|
FileCollection |
getBootstrapClasspath()
Returns the bootstrap classpath to use for the process.
|
FileCollection |
getClasspath()
Returns the classpath for executing the main class.
|
List<String> |
getCommandLine()
Returns the full command line, including the executable plus its arguments.
|
boolean |
getDebug()
Returns true if debugging is enabled for the process.
|
String |
getDefaultCharacterEncoding()
Returns the default character encoding to use.
|
boolean |
getEnableAssertions()
Returns true if assertions are enabled for the process.
|
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.
|
String |
getExecutable()
Returns the name of the executable to use.
|
protected org.gradle.api.internal.file.FileResolver |
getFileResolver() |
List<String> |
getJvmArgs()
Returns the extra arguments to use to launch the JVM for the process.
|
String |
getMain()
Returns the fully qualified name of the Main class to be executed.
|
String |
getMaxHeapSize()
Returns the maximum heap size for the process, if any.
|
String |
getMinHeapSize()
Returns the minimum heap size for the process, if any.
|
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.
|
Map<String,Object> |
getSystemProperties()
Returns the system properties which will be used for the process.
|
File |
getWorkingDir()
Returns the working directory for the process.
|
boolean |
isIgnoreExitValue()
Tells whether a non-zero exit value is ignored, or an exception thrown.
|
JavaExec |
jvmArgs(Iterable<?> arguments)
Adds some arguments to use to launch the JVM for the process.
|
JavaExec |
jvmArgs(Object... arguments)
Adds some arguments to use to launch the JVM for the process.
|
void |
setAllJvmArgs(Iterable<?> arguments)
Sets the full set of arguments to use to launch the JVM for the process.
|
JavaExec |
setArgs(Iterable<?> applicationArgs)
Sets the args for the main class to be executed.
|
void |
setBootstrapClasspath(FileCollection classpath)
Sets the bootstrap classpath to use for the process.
|
JavaExec |
setClasspath(FileCollection classpath)
Sets the classpath for executing the main class.
|
void |
setDebug(boolean enabled)
Enable or disable debugging for the process.
|
void |
setDefaultCharacterEncoding(String defaultCharacterEncoding)
Sets the default character encoding to use.
|
void |
setEnableAssertions(boolean enabled)
Enable or disable assertions for the process.
|
void |
setEnvironment(Map<String,?> environmentVariables)
Sets the environment variable to use for the process.
|
JavaExec |
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.
|
JavaExecSpec |
setIgnoreExitValue(boolean ignoreExitValue)
Sets whether a non-zero exit value is ignored, or an exception thrown.
|
void |
setJvmArgs(Iterable<?> arguments)
Sets the extra arguments to use to launch the JVM for the process.
|
JavaExec |
setMain(String mainClassName)
Sets the fully qualified name of the main class to be executed.
|
void |
setMaxHeapSize(String heapSize)
Sets the maximum heap size for the process.
|
void |
setMinHeapSize(String heapSize)
Sets the minimum heap size for the process.
|
JavaExec |
setStandardInput(InputStream inputStream)
Sets the standard input stream for the process executing the command.
|
JavaExec |
setStandardOutput(OutputStream outputStream)
Sets the output stream to consume standard output from the process executing the command.
|
void |
setSystemProperties(Map<String,?> properties)
Sets the system properties to use for the process.
|
void |
setWorkingDir(Object dir)
Sets the working directory for the process.
|
JavaExec |
systemProperties(Map<String,?> properties)
Adds some system properties to use for the process.
|
JavaExec |
systemProperty(String name,
Object value)
Adds a system property to use for the process.
|
JavaExec |
workingDir(Object dir)
Sets the working directory for the process.
|
conventionMapping, conventionMapping, getConventionMapping
addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString
@Inject protected org.gradle.api.internal.file.FileResolver getFileResolver()
public void exec()
public List<String> getAllJvmArgs()
getAllJvmArgs
インタフェース内 JavaForkOptions
public void setAllJvmArgs(Iterable<?> arguments)
setAllJvmArgs
インタフェース内 JavaForkOptions
arguments
- The arguments. Must not be null.public List<String> getJvmArgs()
getJvmArgs
インタフェース内 JavaForkOptions
public void setJvmArgs(Iterable<?> arguments)
setJvmArgs
インタフェース内 JavaForkOptions
arguments
- The arguments. Must not be null.public JavaExec jvmArgs(Iterable<?> arguments)
jvmArgs
インタフェース内 JavaForkOptions
arguments
- The arguments. Must not be null.public JavaExec jvmArgs(Object... arguments)
jvmArgs
インタフェース内 JavaForkOptions
arguments
- The arguments.public Map<String,Object> getSystemProperties()
getSystemProperties
インタフェース内 JavaForkOptions
public void setSystemProperties(Map<String,?> properties)
setSystemProperties
インタフェース内 JavaForkOptions
properties
- The system properties. Must not be null.public JavaExec systemProperties(Map<String,?> properties)
systemProperties
インタフェース内 JavaForkOptions
properties
- The system properties. Must not be null.public JavaExec systemProperty(String name, Object value)
systemProperty
インタフェース内 JavaForkOptions
name
- The name of the propertyvalue
- The value for the property. May be null.@InputFiles public FileCollection getBootstrapClasspath()
getBootstrapClasspath
インタフェース内 JavaForkOptions
public void setBootstrapClasspath(FileCollection classpath)
setBootstrapClasspath
インタフェース内 JavaForkOptions
classpath
- The classpath. Must not be null. Can be empty.public JavaExec bootstrapClasspath(Object... classpath)
bootstrapClasspath
インタフェース内 JavaForkOptions
classpath
- The classpath.public String getMinHeapSize()
getMinHeapSize
インタフェース内 JavaForkOptions
public void setMinHeapSize(String heapSize)
setMinHeapSize
インタフェース内 JavaForkOptions
heapSize
- The minimum heap size. Use null for the default minimum heap size.public String getDefaultCharacterEncoding()
getDefaultCharacterEncoding
インタフェース内 JavaForkOptions
default character encoding of this JVM
should be used.public void setDefaultCharacterEncoding(String defaultCharacterEncoding)
file.encoding
property). For JVMs
where this is the case, setting the file.encoding
property via JavaForkOptions.setSystemProperties(java.util.Map)
or similar will have no effect as
this value will be overridden by the value specified by JavaForkOptions.getDefaultCharacterEncoding()
.setDefaultCharacterEncoding
インタフェース内 JavaForkOptions
defaultCharacterEncoding
- The default character encoding. Use null to use this JVM's default charset
public String getMaxHeapSize()
getMaxHeapSize
インタフェース内 JavaForkOptions
public void setMaxHeapSize(String heapSize)
setMaxHeapSize
インタフェース内 JavaForkOptions
heapSize
- The heap size. Use null for the default maximum heap size.public boolean getEnableAssertions()
getEnableAssertions
インタフェース内 JavaForkOptions
public void setEnableAssertions(boolean enabled)
setEnableAssertions
インタフェース内 JavaForkOptions
enabled
- true to enable assertions, false to disable.public boolean getDebug()
getDebug
インタフェース内 JavaForkOptions
public void setDebug(boolean enabled)
setDebug
インタフェース内 JavaForkOptions
enabled
- true to enable debugging, false to disable.public String getMain()
getMain
インタフェース内 JavaExecSpec
public JavaExec setMain(String mainClassName)
setMain
インタフェース内 JavaExecSpec
mainClassName
- the fully qualified name of the main class to be executed.public List<String> getArgs()
getArgs
インタフェース内 JavaExecSpec
public JavaExec setArgs(Iterable<?> applicationArgs)
setArgs
インタフェース内 JavaExecSpec
applicationArgs
- Args for the main class.public JavaExec args(Object... args)
args
インタフェース内 JavaExecSpec
args
- Args for the main class.public JavaExecSpec args(Iterable<?> args)
args
インタフェース内 JavaExecSpec
args
- Args for the main class.public JavaExec setClasspath(FileCollection classpath)
setClasspath
インタフェース内 JavaExecSpec
classpath
- the classpathpublic JavaExec classpath(Object... paths)
classpath
インタフェース内 JavaExecSpec
paths
- classpath elements@InputFiles public FileCollection getClasspath()
getClasspath
インタフェース内 JavaExecSpec
public JavaExec copyTo(JavaForkOptions options)
copyTo
インタフェース内 JavaForkOptions
options
- The target options.public String getExecutable()
getExecutable
インタフェース内 ProcessForkOptions
public void setExecutable(Object executable)
setExecutable
インタフェース内 ProcessForkOptions
executable
- The executable. Must not be null.public JavaExec executable(Object executable)
executable
インタフェース内 ProcessForkOptions
executable
- The executable. Must not be null.public File getWorkingDir()
getWorkingDir
インタフェース内 ProcessForkOptions
public void setWorkingDir(Object dir)
Project.file(Object)
.setWorkingDir
インタフェース内 ProcessForkOptions
dir
- The working directory. Must not be null.public JavaExec workingDir(Object dir)
Project.file(Object)
.workingDir
インタフェース内 ProcessForkOptions
dir
- The working directory. Must not be null.public Map<String,Object> getEnvironment()
getEnvironment
インタフェース内 ProcessForkOptions
public void setEnvironment(Map<String,?> environmentVariables)
setEnvironment
インタフェース内 ProcessForkOptions
environmentVariables
- The environment variables. Must not be null.public JavaExec environment(String name, Object value)
environment
インタフェース内 ProcessForkOptions
name
- The name of the variable.value
- The value for the variable. Must not be null.public JavaExec environment(Map<String,?> environmentVariables)
environment
インタフェース内 ProcessForkOptions
environmentVariables
- The environment variables. Must not be null.public JavaExec copyTo(ProcessForkOptions target)
copyTo
インタフェース内 ProcessForkOptions
target
- The target optionspublic JavaExec setStandardInput(InputStream inputStream)
setStandardInput
インタフェース内 BaseExecSpec
inputStream
- The standard input stream for the process. Must not be null.public InputStream getStandardInput()
getStandardInput
インタフェース内 BaseExecSpec
public JavaExec setStandardOutput(OutputStream outputStream)
setStandardOutput
インタフェース内 BaseExecSpec
outputStream
- The standard output stream for the process. Must not be null.public OutputStream getStandardOutput()
System.out
.getStandardOutput
インタフェース内 BaseExecSpec
public JavaExec setErrorOutput(OutputStream outputStream)
setErrorOutput
インタフェース内 BaseExecSpec
outputStream
- The standard output error stream for the process. Must not be null.public OutputStream getErrorOutput()
System.err
.getErrorOutput
インタフェース内 BaseExecSpec
public JavaExecSpec setIgnoreExitValue(boolean ignoreExitValue)
setIgnoreExitValue
インタフェース内 BaseExecSpec
ignoreExitValue
- whether a non-zero exit value is ignored, or an exception thrownpublic boolean isIgnoreExitValue()
false
.isIgnoreExitValue
インタフェース内 BaseExecSpec
public List<String> getCommandLine()
getCommandLine
インタフェース内 BaseExecSpec