Interface SlimeLauncherOptionsNested

All Known Subinterfaces:
SlimeLauncherOptions, SlimeLauncherOptionsInternal
All Known Implementing Classes:
SlimeLauncherOptionsImpl
public interface SlimeLauncherOptionsNested

  • Method Details

    • getMainClass

      @Input @Optional org.gradle.api.provider.Property<String> getMainClass()

      The main class for Slime Launcher to use.

      This is the class that will be invoked by Slime Launcher, not the main class of the JavaExec task that will be produced from these options.

      Returns:
      A property for the main class

    • getInheritArgs

      @Input @Optional org.gradle.api.provider.Property<Boolean> getInheritArgs()

      Wither or not to inherit arguments from the UserDev provided run configs.

      If you set this to false you must specify all arguments to start the process manually.

      Returns:
      A property controlling inheritance of arguments from UserDev config file.

    • getArgs

      @Input @Optional org.gradle.api.provider.ListProperty<String> getArgs()

      The arguments to pass to the main class.

      This is the arguments that will be passed to the main class through Slime Launcher, not the arguments for Slime Launcher itself.

      Returns:
      A property for the arguments to pass to the main class

    • getInheritJvmArgs

      @Input @Optional org.gradle.api.provider.Property<Boolean> getInheritJvmArgs()

      Wither or not to inherit JVM arguments from the UserDev provided run configs.

      If you set this to false you must specify all JVM arguments to start the process manually.

      Returns:
      A property controlling inheritance of JVM arguments from UserDev config file.

    • getJvmArgs

      @Input @Optional org.gradle.api.provider.ListProperty<String> getJvmArgs()

      The JVM arguments to use.

      These are applied immediately when Slime Launcher is executed. A reminder that Slime Launcher is not a re-launcher but a dev-environment bootstrapper.

      Returns:
      A property for the JVM arguments

    • getMinHeapSize

      @Input @Optional org.gradle.api.provider.Property<String> getMinHeapSize()

      The minimum memory heap size to use.

      Working with this property is preferred over manually using the -Xms argument in the JVM arguments.

      Returns:
      A property for the minimum heap size

    • getMaxHeapSize

      @Input @Optional org.gradle.api.provider.Property<String> getMaxHeapSize()

      The maximum memory heap size to use.

      Working with this property is preferred over manually using the -Xmx argument in the JVM arguments.

      Returns:
      A property for the maximum heap size

    • getSystemProperties

      @Input @Optional org.gradle.api.provider.MapProperty<String,String> getSystemProperties()
      The system properties to use.
      Returns:
      A property for the system properties

    • getEnvironment

      @Input @Optional org.gradle.api.provider.MapProperty<String,String> getEnvironment()
      The environment variables to use.
      Returns:
      A property for the environment variables

    • getWorkingDir

      @Internal org.gradle.api.file.DirectoryProperty getWorkingDir()

      The working directory to use.

      To clarify: this is the working directory of the Java process. Slime Launcher uses absolute file locations to place its caches and metadata, which do not interfere with the working directory.

      Returns:
      A property for the working directory

    • args

      void args(Object args)
      Adds to the arguments to pass to the main class.
      Parameters:
      args - The arguments to add
      See Also:
      API Note:
      To add multiple arguments, use args(Object...)

    • args

      void args(Object... args)
      Adds to the arguments to pass to the main class.
      Parameters:
      args - The arguments to add
      See Also:
      API Note:
      Unlike setArgs(String...), this method does not replace the existing arguments.

    • args

      void args(Iterable<?> args)
      Adds to the arguments to pass to the main class.
      Parameters:
      args - The arguments to add
      See Also:
      API Note:
      Unlike HasMultipleValues.set(Iterable), this method does not replace the existing arguments.

    • args

      void args(org.gradle.api.provider.Provider<? extends Iterable<?>> args)
      Adds to the arguments to pass to the main class.
      Parameters:
      args - The arguments to add
      See Also:
      API Note:
      Unlike HasMultipleValues.set(Provider), this method does not replace the existing arguments.

    • setArgs

      void setArgs(String... args)
      Sets the arguments to pass to the main class.
      Parameters:
      args - The arguments
      See Also:

    • jvmArgs

      void jvmArgs(Object jvmArgs)
      Adds to the JVM arguments to use.
      Parameters:
      jvmArgs - The JVM argument to add
      See Also:
      API Note:
      To add multiple arguments, use jvmArgs(Object...)

    • jvmArgs

      void jvmArgs(Object... jvmArgs)
      Adds to the JVM arguments to use.
      Parameters:
      jvmArgs - The JVM arguments to add
      See Also:
      API Note:
      Unlike setJvmArgs(Object...), this method does not replace the existing arguments.

    • jvmArgs

      void jvmArgs(Iterable<?> jvmArgs)
      Adds to the JVM arguments to use.
      Parameters:
      jvmArgs - The JVM arguments to add
      See Also:
      API Note:
      Unlike HasMultipleValues.set(Iterable), this method does not replace the existing arguments.

    • jvmArgs

      void jvmArgs(org.gradle.api.provider.Provider<? extends Iterable<?>> jvmArgs)
      Adds to the JVM arguments to use.
      Parameters:
      jvmArgs - The JVM arguments to add
      See Also:
      API Note:
      Unlike HasMultipleValues.set(Provider), this method does not replace the existing arguments.

    • setJvmArgs

      void setJvmArgs(Object... jvmArgs)
      Sets the JVM arguments to use.
      Parameters:
      jvmArgs - The arguments
      See Also:
      • HasMultipleValues.set(Iterable)

    • systemProperty

      void systemProperty(String name, Object value)
      Adds a single system property to use.
      Parameters:
      name - The name
      value - The value
      See Also:
      API Note:
      To add multiple system properties at once, use systemProperties(Provider).

    • systemProperties

      void systemProperties(Map<String,?> properties)
      Adds to the system properties to use.
      Parameters:
      properties - The system properties
      See Also:
      API Note:
      Unlike MapProperty.set(Map), this method does not replace the existing system properties. To add a single property, use systemProperty(String,Object).

    • systemProperties

      void systemProperties(org.gradle.api.provider.Provider<? extends Map<String,?>> properties)
      Adds to the system properties to use.
      Parameters:
      properties - The system properties
      See Also:
      API Note:
      Unlike MapProperty.set(Provider), this method does not replace the existing system properties. To add a single property, use systemProperty(String,Object).

    • environment

      void environment(String name, Object value)
      Adds a single environment variable to use.
      Parameters:
      name - The name
      value - The value
      See Also:
      API Note:
      To add multiple environment variables at once, use environment(Provider).

    • environment

      void environment(Map<String,?> properties)
      Adds to the environment variables to use.
      Parameters:
      properties - The environment variables
      See Also:
      API Note:
      Unlike MapProperty.set(Map), this method does not replace the existing environment variables. To add a single variable, use environment(String,Object).

    • environment

      void environment(org.gradle.api.provider.Provider<? extends Map<String,?>> properties)
      Adds to the environment variables to use.
      Parameters:
      properties - The environment variables
      See Also:
      API Note:
      Unlike MapProperty.set(Provider), this method does not replace the existing environment variables. To add a single variable, use environment(String,Object).