Package org.gradle.process

Interface JavaExecSpec

All Superinterfaces:
BaseExecSpec, JavaForkOptions, ProcessForkOptions
All Known Implementing Classes:
JavaExec
public interface JavaExecSpec extends JavaForkOptions, BaseExecSpec
Specifies the options for executing a Java application.

  • Method Details

    • getJvmArguments

      @Incubating @Optional @Internal ListProperty<String> getJvmArguments()
      Extra JVM arguments to be to use to launch the JVM for the process. Must be used to set a convention for JVM arguments.
      Since:
      8.1

    • getMainModule

      @Optional @Input Property<String> getMainModule()
      The name of the main module to be executed if the application should run as a Java module.
      Since:
      6.4

    • getMainClass

      @Optional @Input Property<String> getMainClass()
      The fully qualified name of the Main class to be executed.

      This does not need to be set if using an Executable Jar with a Main-Class attribute.

      Since:
      6.4

    • setMain

      @Deprecated @ReplacedBy("mainClass") default JavaExecSpec setMain(@Nullable String main)
      Deprecated.
      Use getMainClass().set(main) instead. This method will be removed in Gradle 9.0.
      Sets the fully qualified name of the main class to be executed.
      Parameters:
      main - the fully qualified name of the main class to be executed.
      Returns:
      this

    • getArgs

      @Nullable @Optional @Input List<String> getArgs()
      Returns the arguments passed to the main class to be executed.

    • args

      JavaExecSpec args(Object... args)
      Adds args for the main class to be executed.
      Parameters:
      args - Args for the main class.
      Returns:
      this

    • args

      JavaExecSpec args(Iterable<?> args)
      Adds args for the main class to be executed.
      Parameters:
      args - Args for the main class.
      Returns:
      this

    • setArgs

      JavaExecSpec setArgs(@Nullable List<String> args)
      Sets the args for the main class to be executed.
      Parameters:
      args - Args for the main class.
      Returns:
      this
      Since:
      4.0

    • setArgs

      JavaExecSpec setArgs(@Nullable Iterable<?> args)
      Sets the args for the main class to be executed.
      Parameters:
      args - Args for the main class.
      Returns:
      this

    • getArgumentProviders

      List<CommandLineArgumentProvider> getArgumentProviders()
      Argument providers for the application.
      Since:
      4.6

    • classpath

      JavaExecSpec classpath(Object... paths)
      Adds elements to the classpath for executing the main class.
      Parameters:
      paths - classpath elements
      Returns:
      this

    • getClasspath

      @Classpath FileCollection getClasspath()
      Returns the classpath for executing the main class.

    • setClasspath

      JavaExecSpec setClasspath(FileCollection classpath)
      Sets the classpath for executing the main class.
      Parameters:
      classpath - the classpath
      Returns:
      this

    • getModularity

      ModularitySpec getModularity()
      Returns the module path handling for executing the main class.
      Since:
      6.4