Class Jmod
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.modules.Jmod
- All Implemented Interfaces:
java.lang.Cloneable
public class Jmod extends Task
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.
classpathclasspathref- Where to locate files to be placed in the jmod file.
modulepathmodulepathref- Where to locate dependencies.
commandpathcommandpathref- Directories containing native commands to include in jmod.
headerpathheaderpathref- Directories containing header files to include in jmod.
configpathconfigpathref- Directories containing user-editable configuration files to include in jmod.
legalpathlegalpathref- Directories containing legal licenses and notices to include in jmod.
nativelibpathnativelibpathref- Directories containing native libraries to include in jmod.
manpathmanpathref- 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
numberattribute. May also have optionalpreReleaseandbuildattributes. <moduleWarning>- Has one required attribute,
reason. SeemoduleWarningsattribute above. This element may be specified multiple times.
destFile and classpath are required data.
- Since:
- 1.10.6
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classJmod.ResolutionWarningReasonPermissible reasons for jmod creation to emit warnings.classJmod.ResolutionWarningSpecChild element which enables jmod tool warnings. -
Field Summary
-
Constructor Summary
Constructors Constructor Description Jmod() -
Method Summary
Modifier and Type Method Description PathcreateClasspath()Adds an unconfigured<classpath>child element which can specify the files which will comprise the created jmod.PathcreateCommandPath()Creates a child element which can contain a list of directories containing native executable files to include in the created jmod.PathcreateConfigPath()Creates a child element which can contain a list of directories containing user configuration files to include in the created jmod.PathcreateHeaderPath()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.PathcreateLegalPath()Creates a child element which can contain a list of directories containing license files to include in the created jmod.PathcreateManPath()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.PathcreateModulePath()Creates a child<modulePath>element which can contain a path of directories containing modules upon which modules in the classpath depend.Jmod.ResolutionWarningSpeccreateModuleWarning()Creates a child element which can specify the circumstances under which jmod creation emits warnings.PathcreateNativeLibPath()Creates a child element which can contain a list of directories containing native libraries to include in the created jmod.ModuleVersioncreateVersion()Creates an uninitialized child element representing the version of the module represented by the created jmod.voidexecute()Creates a jmod file according to this task's properties and child elements.PathgetClasspath()Attribute which specifies the files (usually modular .jar files) which will comprise the created jmod file.PathgetCommandPath()Attribute containing path of directories which contain native executable files to include in the created jmod.PathgetConfigPath()Attribute containing list of directories which contain user configuration files.java.io.FilegetDestFile()Attribute containing the location of the jmod file to create.java.lang.StringgetHashModulesPattern()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.PathgetHeaderPath()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.PathgetLegalPath()Attribute containing list of directories which hold license files to include in the created jmod.java.lang.StringgetMainClass()Attribute containing the class that acts as the executable entry point of the created jmod.PathgetManPath()Attribute containing list of directories containing man pages to include in created jmod.PathgetModulePath()Attribute containing path of directories which contain modules on which the created jmod's constituent modules depend.PathgetNativeLibPath()Attribute containing list of directories which hold native libraries to include in the created jmod.java.lang.StringgetPlatform()Attribute containing the platform for which the jmod will be built.booleangetResolveByDefault()Attribute indicating whether the created jmod should be visible in a module path, even when not specified explicitly.java.lang.StringgetVersion()Attribute which specifies a module version for created jmod.voidsetClasspath(Path path)Sets attribute specifying the files that will comprise the created jmod file.voidsetClasspathRef(Reference ref)Sets classpath attribute from a path reference.voidsetCommandPath(Path path)Sets attribute containing path of directories which contain native executable files to include in the created jmod.voidsetCommandPathRef(Reference ref)Sets command path from a path reference.voidsetConfigPath(Path path)Sets attribute containing list of directories which contain user configuration files.voidsetConfigPathRef(Reference ref)Sets configuration file path from a path reference.voidsetDestFile(java.io.File file)Sets attribute containing the location of the jmod file to create.voidsetHashModulesPattern(java.lang.String 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.voidsetHeaderPath(Path 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.voidsetHeaderPathRef(Reference ref)Sets header path from a path reference.voidsetLegalPath(Path path)Sets attribute containing list of directories which hold license files to include in the created jmod.voidsetLegalPathRef(Reference ref)Sets legal licenses path from a path reference.voidsetMainClass(java.lang.String className)Sets attribute containing the class that acts as the executable entry point of the created jmod.voidsetManPath(Path path)Sets attribute containing list of directories containing man pages to include in created jmod.voidsetManPathRef(Reference ref)Sets man pages path from a path reference.voidsetModulePath(Path path)Sets attribute containing path of directories which contain modules on which the created jmod's constituent modules depend.voidsetModulePathRef(Reference ref)Sets module path from a path reference.voidsetModuleWarnings(java.lang.String warningList)Sets attribute containing a comma-separated list of reasons for jmod creation to emit warnings.voidsetNativeLibPath(Path path)Sets attribute containing list of directories which hold native libraries to include in the created jmod.voidsetNativeLibPathRef(Reference ref)Sets native library path from a path reference.voidsetPlatform(java.lang.String platform)Sets attribute containing the platform for which the jmod will be built.voidsetResolveByDefault(boolean resolve)Sets attribute indicating whether the created jmod should be visible in a module path, even when not specified explicitly.voidsetVersion(java.lang.String version)Sets the module version for the created jmod.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
Jmod
public Jmod()
-
-
Method Details
-
getDestFile
public java.io.File getDestFile()Attribute containing the location of the jmod file to create.- Returns:
- location of jmod file
- See Also:
setDestFile(File)
-
setDestFile
public void setDestFile(java.io.File file)Sets attribute containing the location of the jmod file to create. This value is required.- Parameters:
file- location where jmod file will be created.
-
createClasspath
Adds an unconfigured<classpath>child element which can specify the files which will comprise the created jmod.- Returns:
- new, unconfigured child element
- See Also:
setClasspath(Path)
-
getClasspath
Attribute which specifies the files (usually modular .jar files) which will comprise the created jmod file.- Returns:
- path of constituent files
- See Also:
setClasspath(Path)
-
setClasspath
Sets attribute specifying the files that will comprise the created jmod file. Usually this contains a single modular .jar file.The classpath is required and must not be empty.
- Parameters:
path- path of files that will comprise jmod- See Also:
createClasspath()
-
setClasspathRef
Sets classpath attribute from a path reference.- Parameters:
ref- reference to path which will act as classpath
-
createModulePath
Creates a child<modulePath>element which can contain a path of directories containing modules upon which modules in the classpath depend.- Returns:
- new, unconfigured child element
- See Also:
setModulePath(Path)
-
getModulePath
Attribute containing path of directories which contain modules on which the created jmod's constituent modules depend.- Returns:
- path of directories containing modules needed by classpath modules
- See Also:
setModulePath(Path)
-
setModulePath
Sets attribute containing path of directories which contain modules on which the created jmod's constituent modules depend.- Parameters:
path- path of directories containing modules needed by classpath modules- See Also:
createModulePath()
-
setModulePathRef
Sets module path from a path reference.- Parameters:
ref- reference to path which will act as module path
-
createCommandPath
Creates a child element which can contain a list of directories containing native executable files to include in the created jmod.- Returns:
- new, unconfigured child element
- See Also:
setCommandPath(Path)
-
getCommandPath
Attribute containing path of directories which contain native executable files to include in the created jmod.- Returns:
- list of directories containing native executables
- See Also:
setCommandPath(Path)
-
setCommandPath
Sets attribute containing path of directories which contain native executable files to include in the created jmod.- Parameters:
path- list of directories containing native executables- See Also:
createCommandPath()
-
setCommandPathRef
Sets command path from a path reference.- Parameters:
ref- reference to path which will act as command path
-
createConfigPath
Creates a child element which can contain a list of directories containing user configuration files to include in the created jmod.- Returns:
- new, unconfigured child element
- See Also:
setConfigPath(Path)
-
getConfigPath
Attribute containing list of directories which contain user configuration files.- Returns:
- list of directories containing user configuration files
- See Also:
setConfigPath(Path)
-
setConfigPath
Sets attribute containing list of directories which contain user configuration files.- Parameters:
path- list of directories containing user configuration files- See Also:
createConfigPath()
-
setConfigPathRef
Sets configuration file path from a path reference.- Parameters:
ref- reference to path which will act as configuration file path
-
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.- Returns:
- new, unconfigured child element
- See Also:
setHeaderPath(Path)
-
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.- Returns:
- path of directories containing header files
-
setHeaderPath
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.- Parameters:
path- path of directories containing header files- See Also:
createHeaderPath()
-
setHeaderPathRef
Sets header path from a path reference.- Parameters:
ref- reference to path which will act as header path
-
createLegalPath
Creates a child element which can contain a list of directories containing license files to include in the created jmod.- Returns:
- new, unconfigured child element
- See Also:
setLegalPath(Path)
-
getLegalPath
Attribute containing list of directories which hold license files to include in the created jmod.- Returns:
- path containing directories which hold license files
-
setLegalPath
Sets attribute containing list of directories which hold license files to include in the created jmod.- Parameters:
path- path containing directories which hold license files- See Also:
createLegalPath()
-
setLegalPathRef
Sets legal licenses path from a path reference.- Parameters:
ref- reference to path which will act as legal path
-
createNativeLibPath
Creates a child element which can contain a list of directories containing native libraries to include in the created jmod.- Returns:
- new, unconfigured child element
- See Also:
setNativeLibPath(Path)
-
getNativeLibPath
Attribute containing list of directories which hold native libraries to include in the created jmod.- Returns:
- path of directories containing native libraries
-
setNativeLibPath
Sets attribute containing list of directories which hold native libraries to include in the created jmod.- Parameters:
path- path of directories containing native libraries- See Also:
createNativeLibPath()
-
setNativeLibPathRef
Sets native library path from a path reference.- Parameters:
ref- reference to path which will act as native library path
-
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.- Returns:
- new, unconfigured child element
- See Also:
setManPath(Path)
-
getManPath
Attribute containing list of directories containing man pages to include in created jmod. Man pages are textual program manuals, typically in troff format.- Returns:
- path containing directories which hold man pages to include in jmod
-
setManPath
Sets attribute containing list of directories containing man pages to include in created jmod. Man pages are textual program manuals, typically in troff format.- Parameters:
path- path containing directories which hold man pages to include in jmod- See Also:
createManPath()
-
setManPathRef
Sets man pages path from a path reference.- Parameters:
ref- reference to path which will act as module path
-
createVersion
Creates an uninitialized child element representing the version of the module represented by the created jmod.- Returns:
- new, unconfigured child element
- See Also:
setVersion(String)
-
getVersion
public java.lang.String getVersion()Attribute which specifies a module version for created jmod.- Returns:
- module version for created jmod
-
setVersion
public void setVersion(java.lang.String version)Sets the module version for the created jmod.- Parameters:
version- module version of created jmod- See Also:
createVersion()
-
getMainClass
public java.lang.String getMainClass()Attribute containing the class that acts as the executable entry point of the created jmod.- Returns:
- fully-qualified name of jmod's main class
-
setMainClass
public void setMainClass(java.lang.String className)Sets attribute containing the class that acts as the executable entry point of the created jmod.- Parameters:
className- fully-qualified name of jmod's main class
-
getPlatform
public java.lang.String getPlatform()Attribute containing the platform for which the jmod will be built. Platform values are defined in thejava.base.jmodof JDKs, and usually take the form OS-architecture. If unset, current platform is used.- Returns:
- OS and architecture for which jmod will be built, or
null
-
setPlatform
public void setPlatform(java.lang.String platform)Sets attribute containing the platform for which the jmod will be built. Platform values are defined in thejava.base.jmodof JDKs, and usually take the form OS-architecture. If unset, current platform is used.A JDK's platform can be viewed with a command like:
jmod describe $JDK_HOME/jmods/java.base.jmod | grep -i platform. o *- Parameters:
platform- platform for which jmod will be created, ornull
-
getHashModulesPattern
public java.lang.String 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.- Returns:
- regex specifying which dependent modules should have their generated hashes included
-
setHashModulesPattern
public void setHashModulesPattern(java.lang.String 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.- Parameters:
pattern- regex specifying which dependent modules should have their generated hashes included
-
getResolveByDefault
public boolean getResolveByDefault()Attribute indicating whether the created jmod should be visible in a module path, even when not specified explicitly. True by default.- Returns:
- whether jmod should be visible in module paths
-
setResolveByDefault
public void setResolveByDefault(boolean resolve)Sets attribute indicating whether the created jmod should be visible in a module path, even when not specified explicitly. True by default.- Parameters:
resolve- whether jmod should be visible in module paths
-
createModuleWarning
Creates a child element which can specify the circumstances under which jmod creation emits warnings.- Returns:
- new, unconfigured child element
- See Also:
setModuleWarnings(String)
-
setModuleWarnings
public void setModuleWarnings(java.lang.String warningList)Sets attribute containing a comma-separated list of reasons for jmod creation to emit warnings. Valid values in list are:deprecated,leaving,incubating.- Parameters:
warningList- list containing one or more of the above values, separated by commas- See Also:
createModuleWarning(),Jmod.ResolutionWarningReason
-
execute
Creates a jmod file according to this task's properties and child elements.- Overrides:
executein classTask- Throws:
BuildException- if destFile is not setBuildException- if classpath is not set or is emptyBuildException- if any path other than classpath refers to an existing file which is not a directoryBuildException- if bothversionattribute and<version>child element are presentBuildException- ifhashModulesPatternis set, but module path is not defined
-