Creates a linkable .jmod file from a modular jar file, and optionally from other resource files such as native libraries and documents. Equivalent to the JDK's jmod tool.

Supported attributes:

destFile

Required, jmod file to create.

classpath

classpathref

Where to locate files to be placed in the jmod file.

modulepath

modulepathref

Where to locate dependencies.

commandpath

commandpathref

Directories containing native commands to include in jmod.

headerpath

headerpathref

Directories containing header files to include in jmod.

configpath

configpathref

Directories containing user-editable configuration files to include in jmod.

legalpath

legalpathref

Directories containing legal licenses and notices to include in jmod.

nativelibpath

nativelibpathref

Directories containing native libraries to include in jmod.

manpath

manpathref

Directories containing man pages to include in jmod.

version

Module version.

mainclass

Main class of module.

platform

The target platform for the jmod. A particular JDK's platform can be seen by running jmod describe $JDK_HOME/jmods/java.base.jmod | grep -i platform.

hashModulesPattern

Regular expression for names of modules in the module path which depend on the jmod being created, and which should have hashes generated for them and included in the new jmod.

resolveByDefault

Boolean indicating whether the jmod should be one of the default resolved modules in an application. Default is true.

moduleWarnings

Whether to emit warnings when resolving modules which are not recommended for use. Comma-separated list of one of more of the following:

deprecated: Warn if module is deprecated
leaving: Warn if module is deprecated for removal
incubating: Warn if module is an incubating (not yet official) module

Supported nested elements:

<classpath>: Path indicating where to locate files to be placed in the jmod file.
<modulepath>: Path indicating where to locate dependencies.
<commandpath>: Path of directories containing native commands to include in jmod.
<headerpath>: Path of directories containing header files to include in jmod.
<configpath>: Path of directories containing user-editable configuration files to include in jmod.
<legalpath>: Path of directories containing legal notices to include in jmod.
<nativelibpath>: Path of directories containing native libraries to include in jmod.
<manpath>: Path of directories containing man pages to include in jmod.
<version>: Module version of jmod. Must have a required number attribute. May also have optional preRelease and build attributes.
<moduleWarning>: Has one required attribute, reason. See moduleWarnings attribute above. This element may be specified multiple times.

destFile and classpath are required data.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Jmod.ResolutionWarningReason Permissible reasons for jmod creation to emit warnings.
public class	Jmod.ResolutionWarningSpec Child element which enables jmod tool warnings.

Field Summary

Modifier and Type	Field and Description
private Path	classpath Path of files (usually jar files or directories containing compiled classes) from which to create jmod.
private Path	commandPath Path of directories containing executable files to bundle in the created jmod.
private Path	configPath Path of directories containing configuration files to bundle in the created jmod.
private String	hashModulesPattern Regular expression matching names of modules which depend on the the created jmod's module, for which hashes should be added to the created jmod.
private Path	headerPath Path of directories containing includable header files (such as for other languages) to bundle in the created jmod.
private File	jmodFile Location of jmod file to be created.
private Path	legalPath Path of directories containing legal license files to bundle in the created jmod.
private String	mainClass Main class to execute, if Java attempts to execute jmod's module without specifying a main class explicitly.
private Path	manPath Path of directories containing manual pages to bundle in the created jmod.
private Path	modulePath Path of directories containing modules on which the modules in the classpath depend.
private ModuleVersion	moduleVersion Module version of jmod.
private final List<Jmod.ResolutionWarningSpec>	moduleWarnings Reasons why module resolution during jmod creation may emit warnings.
private Path	nativeLibPath Path of directories containing native libraries needed by classes in the modules comprising the created jmod.
private String	platform Target platform of created jmod.
private boolean	resolveByDefault Whether the created jmod should be seen by Java when present in a module path, even if not explicitly named.
private String	version Module version of jmod.

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	Jmod()

Method Summary

Modifier and Type	Method and Description
private Collection<String>	Returns: new list of `jmod` arguments buildJmodArgs() Creates list of arguments to `jmod` tool, based on this instance's current state.
private void	checkDirPaths() Checks that all paths which are required to be directories only, refer only to directories.
public Path	Returns: new, unconfigured child element createClasspath() Adds an unconfigured `<classpath>` child element which can specify the files which will comprise the created jmod.
public Path	Returns: new, unconfigured child element createCommandPath() Creates a child element which can contain a list of directories containing native executable files to include in the created jmod.
public Path	Returns: new, unconfigured child element createConfigPath() Creates a child element which can contain a list of directories containing user configuration files to include in the created jmod.
public Path	Returns: new, unconfigured child element createHeaderPath() Creates a child element which can contain a list of directories containing compile-time header files for third party use, to include in the created jmod.
public Path	Returns: new, unconfigured child element createLegalPath() Creates a child element which can contain a list of directories containing license files to include in the created jmod.
public Path	Returns: new, unconfigured child element createManPath() Creates a child element which can contain a list of directories containing man pages (program manuals, typically in troff format) to include in the created jmod.
public Path	Returns: new, unconfigured child element createModulePath() Creates a child `<modulePath>` element which can contain a path of directories containing modules upon which modules in the classpath depend.
public Jmod.ResolutionWarningSpec	Returns: new, unconfigured child element createModuleWarning() Creates a child element which can specify the circumstances under which jmod creation emits warnings.
public Path	Returns: new, unconfigured child element createNativeLibPath() Creates a child element which can contain a list of directories containing native libraries to include in the created jmod.
public ModuleVersion	Returns: new, unconfigured child element createVersion() Creates an uninitialized child element representing the version of the module represented by the created jmod.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Creates a jmod file according to this task's properties and child elements.
public Path	Returns: path of constituent files getClasspath() Attribute which specifies the files (usually modular .jar files) which will comprise the created jmod file.
public Path	Returns: list of directories containing native executables getCommandPath() Attribute containing path of directories which contain native executable files to include in the created jmod.
public Path	Returns: list of directories containing user configuration files getConfigPath() Attribute containing list of directories which contain user configuration files.
public File	Returns: location of jmod file getDestFile() Attribute containing the location of the jmod file to create.
public String	Returns: regex specifying which dependent modules should have their generated hashes included getHashModulesPattern() Attribute containing a regular expression which specifies which of the modules that depend on the jmod being created should have hashes generated and added to the jmod.
public Path	Returns: path of directories containing header files getHeaderPath() Attribute containing a path of directories which hold compile-time header files for third party use, all of which will be included in the created jmod.
public Path	Returns: path containing directories which hold license files getLegalPath() Attribute containing list of directories which hold license files to include in the created jmod.
public String	Returns: fully-qualified name of jmod's main class getMainClass() Attribute containing the class that acts as the executable entry point of the created jmod.
public Path	Returns: path containing directories which hold man pages to include in jmod getManPath() Attribute containing list of directories containing man pages to include in created jmod.
public Path	Returns: path of directories containing modules needed by classpath modules getModulePath() Attribute containing path of directories which contain modules on which the created jmod's constituent modules depend.
public Path	Returns: path of directories containing native libraries getNativeLibPath() Attribute containing list of directories which hold native libraries to include in the created jmod.
public String	Returns: OS and architecture for which jmod will be built, or `null` getPlatform() Attribute containing the platform for which the jmod will be built.
public boolean	Returns: whether jmod should be visible in module paths getResolveByDefault() Attribute indicating whether the created jmod should be visible in a module path, even when not specified explicitly.
public String	Returns: module version for created jmod getVersion() Attribute which specifies a module version for created jmod.
private static boolean	Returns: true if resource exists and is not a directory, false if it is a directory or does not exist isRegularFile(Resource resource to check resource) Checks whether a resource is a directory.
public void	setClasspath(final Path path of files that will comprise jmod path) Sets attribute specifying the files that will comprise the created jmod file.
public void	setClasspathRef(final Reference reference to path which will act as classpath ref) Sets classpath attribute from a path reference.
public void	setCommandPath(final Path list of directories containing native executables path) Sets attribute containing path of directories which contain native executable files to include in the created jmod.
public void	setCommandPathRef(final Reference reference to path which will act as command path ref) Sets command path from a path reference.
public void	setConfigPath(final Path list of directories containing user configuration files path) Sets attribute containing list of directories which contain user configuration files.
public void	setConfigPathRef(final Reference reference to path which will act as configuration file path ref) Sets configuration file path from a path reference.
public void	setDestFile(final File location where jmod file will be created. file) Sets attribute containing the location of the jmod file to create.
public void	setHashModulesPattern(final String regex specifying which dependent modules should have their generated hashes included pattern) Sets attribute containing a regular expression which specifies which of the modules that depend on the jmod being created should have hashes generated and added to the jmod.
public void	setHeaderPath(final Path path of directories containing header files path) Sets attribute containing a path of directories which hold compile-time header files for third party use, all of which will be included in the created jmod.
public void	setHeaderPathRef(final Reference reference to path which will act as header path ref) Sets header path from a path reference.
public void	setLegalPath(final Path path containing directories which hold license files path) Sets attribute containing list of directories which hold license files to include in the created jmod.
public void	setLegalPathRef(final Reference reference to path which will act as legal path ref) Sets legal licenses path from a path reference.
public void	setMainClass(final String fully-qualified name of jmod's main class className) Sets attribute containing the class that acts as the executable entry point of the created jmod.
public void	setManPath(final Path path containing directories which hold man pages to include in jmod path) Sets attribute containing list of directories containing man pages to include in created jmod.
public void	setManPathRef(final Reference reference to path which will act as module path ref) Sets man pages path from a path reference.
public void	setModulePath(final Path path of directories containing modules needed by classpath modules path) Sets attribute containing path of directories which contain modules on which the created jmod's constituent modules depend.
public void	setModulePathRef(final Reference reference to path which will act as module path ref) Sets module path from a path reference.
public void	setModuleWarnings(final String list containing one or more of the above values, separated by commas warningList) Sets attribute containing a comma-separated list of reasons for jmod creation to emit warnings.
public void	setNativeLibPath(final Path path of directories containing native libraries path) Sets attribute containing list of directories which hold native libraries to include in the created jmod.
public void	setNativeLibPathRef(final Reference reference to path which will act as native library path ref) Sets native library path from a path reference.
public void	setPlatform(final String platform for which jmod will be created, or `null` platform) Sets attribute containing the platform for which the jmod will be built.
public void	setResolveByDefault(final boolean whether jmod should be visible in module paths resolve) Sets attribute indicating whether the created jmod should be visible in a module path, even when not specified explicitly.
public void	setVersion(final String module version of created jmod version) Sets the module version for the created jmod.

Field Detail

classpath	back to summary
private Path classpath Path of files (usually jar files or directories containing compiled classes) from which to create jmod.

commandPath	back to summary
private Path commandPath Path of directories containing executable files to bundle in the created jmod.

configPath	back to summary
private Path configPath Path of directories containing configuration files to bundle in the created jmod.

hashModulesPattern	back to summary
private String hashModulesPattern Regular expression matching names of modules which depend on the the created jmod's module, for which hashes should be added to the created jmod.

headerPath	back to summary
private Path headerPath Path of directories containing includable header files (such as for other languages) to bundle in the created jmod.

jmodFile	back to summary
private File jmodFile Location of jmod file to be created.

legalPath	back to summary
private Path legalPath Path of directories containing legal license files to bundle in the created jmod.

mainClass	back to summary
private String mainClass Main class to execute, if Java attempts to execute jmod's module without specifying a main class explicitly.

manPath	back to summary
private Path manPath Path of directories containing manual pages to bundle in the created jmod.

modulePath	back to summary
private Path modulePath Path of directories containing modules on which the modules in the classpath depend.

moduleVersion	back to summary
private ModuleVersion moduleVersion Module version of jmod. Either this or `version` may be set.

moduleWarnings	back to summary
private final List<Jmod.ResolutionWarningSpec> moduleWarnings Reasons why module resolution during jmod creation may emit warnings.

nativeLibPath	back to summary
private Path nativeLibPath Path of directories containing native libraries needed by classes in the modules comprising the created jmod.

platform	back to summary
private String platform Target platform of created jmod. Examples are `windows-amd64` and `linux-amd64`. Target platform is an attribute of each JDK, which can be seen by executing `jmod describe $JDK_HOME/jmods/java.base.jmod` and searching the output for a line starting with `platform`.

resolveByDefault	back to summary
private boolean resolveByDefault Whether the created jmod should be seen by Java when present in a module path, even if not explicitly named. Normally true.

version	back to summary
private String version Module version of jmod. Either this or `moduleVersion` may be set.

Constructor Detail

Jmod	back to summary
public Jmod()

Method Detail

buildJmodArgs back to summary

buildJmodArgs	back to summary
private Collection<String> buildJmodArgs() Creates list of arguments to `jmod` tool, based on this instance's current state. Returns:Collection<String> new list of `jmod` arguments

private Collection<String> buildJmodArgs()

Creates list of arguments to jmod tool, based on this instance's current state.

Returns:Collection<String>: new list of jmod arguments

checkDirPaths	back to summary
private void checkDirPaths() Checks that all paths which are required to be directories only, refer only to directories. Exceptions BuildException: if any path has an existing file which is a non-directory

checkDirPaths

Modifier and Type	Field and Description
public static final String	DEPRECATED String value indicating warnings are emitted for modules marked as deprecated (but not deprecated for removal).
public static final String	INCUBATING String value indicating warnings are emitted for modules designated as "incubating" in the JDK.
public static final String	LEAVING String value indicating warnings are emitted for modules marked as deprecated for removal.
private static final Map<String, String>	VALUES_TO_OPTIONS Maps Ant task values to jmod option values.

Modifier and Type	Method and Description
public String[]	getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement.
pack-priv String	Returns: jmod option value toCommandLineOption() Converts this object's current value to a jmod tool option value.
public static Jmod.ResolutionWarningReason	Returns: `ResolutionWarningReason` instance corresponding to string argument valueOf(String string to convert s) Converts a string to a `ResolutionWarningReason` instance.

Access	Constructor and Description
public	ResolutionWarningSpec() Creates an uninitialized element.
public	ResolutionWarningSpec(String non`null` `Jmod.ResolutionWarningReason` value reason) Creates an element with the given reason attribute.

Modifier and Type	Method and Description
public Jmod.ResolutionWarningReason	Returns: condition which triggers jmod warnings getReason() Required attribute containing reason for emitting jmod warnings.
public void	setReason(Jmod.ResolutionWarningReason condition which triggers jmod warnings reason) Sets attribute containing reason for emitting jmod warnings.
public void	validate() Verifies this object's state.

public Class Jmod

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Jmod.ResolutionWarningReason

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Jmod.ResolutionWarningSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail