Class JavaFXJLinkMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openjfx.JavaFXBaseMojo

org.openjfx.JavaFXJLinkMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="jlink",
      requiresDependencyResolution=RUNTIME)
public class JavaFXJLinkMojo
extends JavaFXBaseMojo

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	bindServices	Add the option --bind-services or not, default false.
private Integer	compress	Compression level of the resources being used, equivalent to: -c, --compress=level.
private boolean	ignoreSigningInformation	--ignore-signing-information, default false
private String	jlinkExecutable	The executable.
private String	jlinkImageName	The name of the folder with the resulting runtime image, equivalent to --output <path>
private boolean	jlinkVerbose	Turn on verbose mode, equivalent to: --verbose, default false
private String	jlinkZipName	When set, creates a zip of the resulting runtime image.
private String	jmodsPath	Optional jmodsPath path for local builds.
private String	launcher	Add a launcher script, equivalent to: --launcher <name>=<module>[/<mainclass>].
private boolean	noHeaderFiles	Remove the includes directory in the resulting runtime image, equivalent to: --no-header-files, default false
private boolean	noManPages	Remove the man directory in the resulting Java runtime image, equivalent to: --no-man-pages, default false
private boolean	stripDebug	Strips debug information out, equivalent to -G, --strip-debug, default false
private org.codehaus.plexus.archiver.zip.ZipArchiver	zipArchiver	The JAR archiver needed for archiving the environments.

Fields inherited from class JavaFXBaseMojo

basedir, builddir, classpathElements, commandlineArgs, JAVAFX_PREFIX, mainClass, moduleDescriptor, modulepathElements, options, outputFile, pathElements, project, skip, workingDirectory

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
JavaFXJLinkMojo()

Method Summary

Modifier and Type	Method	Description
private List<String>	createCommandArguments()
private File	createZipArchiveFromImage()
void	execute()

Methods inherited from class JavaFXBaseMojo

executeCommandLine, executeCommandLine, getExecutablePath, getParent, handleSystemEnvVariables, handleWorkingDirectory, isMavenUsingJava8, isTargetUsingJava8, preparePaths

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

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

Field Details

stripDebug

@Parameter(property="javafx.stripDebug",
           defaultValue="false")
private boolean stripDebug

Strips debug information out, equivalent to -G, --strip-debug, default false

compress

@Parameter(property="javafx.compress",
           defaultValue="2")
private Integer compress

Compression level of the resources being used, equivalent to: -c, --compress=level. Valid values: 0, 1, 2, default 2

noHeaderFiles

@Parameter(property="javafx.noHeaderFiles",
           defaultValue="false")
private boolean noHeaderFiles

Remove the includes directory in the resulting runtime image, equivalent to: --no-header-files, default false

noManPages

@Parameter(property="javafx.noManPages",
           defaultValue="false")
private boolean noManPages

Remove the man directory in the resulting Java runtime image, equivalent to: --no-man-pages, default false

bindServices

@Parameter(property="javafx.bindServices",
           defaultValue="false")
private boolean bindServices

Add the option --bind-services or not, default false.

ignoreSigningInformation

@Parameter(property="javafx.ignoreSigningInformation",
           defaultValue="false")
private boolean ignoreSigningInformation

--ignore-signing-information, default false

jlinkVerbose

@Parameter(property="javafx.jlinkVerbose",
           defaultValue="false")
private boolean jlinkVerbose

Turn on verbose mode, equivalent to: --verbose, default false

launcher

@Parameter(property="javafx.launcher")
private String launcher

Add a launcher script, equivalent to: --launcher <name>=<module>[/<mainclass>].

jlinkImageName

@Parameter(property="javafx.jlinkImageName",
           defaultValue="image")
private String jlinkImageName

The name of the folder with the resulting runtime image, equivalent to --output <path>

jlinkZipName

@Parameter(property="javafx.jlinkZipName")
private String jlinkZipName

When set, creates a zip of the resulting runtime image.

jlinkExecutable

@Parameter(property="javafx.jlinkExecutable",
           defaultValue="jlink")
private String jlinkExecutable

The executable. Can be a full path or the name of the executable. In the latter case, the executable must be in the PATH for the execution to work.

jmodsPath

@Parameter(property="javafx.jmodsPath")
private String jmodsPath

Optional jmodsPath path for local builds.

zipArchiver

@Component(role=org.codehaus.plexus.archiver.Archiver.class,
           hint="zip")
private org.codehaus.plexus.archiver.zip.ZipArchiver zipArchiver

The JAR archiver needed for archiving the environments.

Constructor Details

JavaFXJLinkMojo

public JavaFXJLinkMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

createCommandArguments

private List<String> createCommandArguments()
                                     throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

createZipArchiveFromImage

private File createZipArchiveFromImage()
                                throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException