Package org.gradle.jvm.application.tasks

Class CreateStartScripts

  • All Implemented Interfaces:
    Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>
    Direct Known Subclasses:
    CreateStartScripts
    public class CreateStartScripts
extends org.gradle.api.internal.ConventionTask
    Creates start scripts for launching JVM applications.

    Example: 

     task createStartScripts(type: CreateStartScripts) {
   outputDir = file('build/sample')
   mainClassName = 'org.gradle.test.Main'
   applicationName = 'myApp'
   classpath = files('path/to/some.jar')
 }

    Note: the Gradle "application" plugin adds a pre-configured task of this type named "startScripts".

    The task generates separate scripts targeted at Microsoft Windows environments and UNIX-like environments (e.g. Linux, macOS). The actual generation is implemented by the getWindowsStartScriptGenerator() and getUnixStartScriptGenerator() properties, of type ScriptGenerator.

    Example: 

     task createStartScripts(type: CreateStartScripts) {
   unixStartScriptGenerator = new CustomUnixStartScriptGenerator()
   windowsStartScriptGenerator = new CustomWindowsStartScriptGenerator()
 }

 class CustomUnixStartScriptGenerator implements ScriptGenerator {
   void generateScript(JavaAppStartScriptGenerationDetails details, Writer destination) {
     // implementation
   }
 }

 class CustomWindowsStartScriptGenerator implements ScriptGenerator {
   void generateScript(JavaAppStartScriptGenerationDetails details, Writer destination) {
     // implementation
   }
 }

    The default generators are of the type TemplateBasedScriptGenerator, with default templates. This templates can be changed via the TemplateBasedScriptGenerator.setTemplate(org.gradle.api.resources.TextResource) method.

    The default implementations used by this task use Groovy's SimpleTemplateEngine to parse the template, with the following variables available:

    • applicationName
    • optsEnvironmentVar
    • exitEnvironmentVar
    • mainClassName
    • defaultJvmOpts
    • appNameSystemProperty
    • appHomeRelativePath
    • classpath

    Example: 

     task createStartScripts(type: CreateStartScripts) {
   unixStartScriptGenerator.template = resources.text.fromFile('customUnixStartScript.txt')
   windowsStartScriptGenerator.template = resources.text.fromFile('customWindowsStartScript.txt')
 }

    • Constructor Detail

      • CreateStartScripts

        public CreateStartScripts()

    • Method Detail

      • getOptsEnvironmentVar

        @Input
@Optional
public String getOptsEnvironmentVar()
        The environment variable to use to provide additional options to the JVM.

      • getExitEnvironmentVar

        @Input
@Optional
public String getExitEnvironmentVar()
        The environment variable to use to control exit value (Windows only).

      • getUnixScript

        @Internal
public File getUnixScript()
        Returns the full path to the Unix script. The target directory is represented by the output directory, the file name is the application name without a file extension.

      • getWindowsScript

        @Internal
public File getWindowsScript()
        Returns the full path to the Windows script. The target directory is represented by the output directory, the file name is the application name plus the file extension .bat.

      • getOutputDir

        @OutputDirectory
public File getOutputDir()
        The directory to write the scripts into.

      • setOutputDir

        public void setOutputDir​(File outputDir)

      • getMainClassName

        @Input
public String getMainClassName()
        The main classname used to start the Java application.

      • setMainClassName

        public void setMainClassName​(String mainClassName)

      • getDefaultJvmOpts

        @Input
@Optional
public Iterable<String> getDefaultJvmOpts()
        The application's default JVM options. Defaults to an empty list.

      • setDefaultJvmOpts

        public void setDefaultJvmOpts​(Iterable<String> defaultJvmOpts)

      • getApplicationName

        @Input
public String getApplicationName()
        The application's name.

      • setApplicationName

        public void setApplicationName​(String applicationName)

      • setOptsEnvironmentVar

        public void setOptsEnvironmentVar​(String optsEnvironmentVar)

      • setExitEnvironmentVar

        public void setExitEnvironmentVar​(String exitEnvironmentVar)

      • setClasspath

        public void setClasspath​(FileCollection classpath)

      • setUnixStartScriptGenerator

        public void setUnixStartScriptGenerator​(ScriptGenerator unixStartScriptGenerator)

      • setWindowsStartScriptGenerator

        public void setWindowsStartScriptGenerator​(ScriptGenerator windowsStartScriptGenerator)

      • generate

        public void generate()