From aef407be4d33de09861a1f9677b2f15ea5ea8fdf Mon Sep 17 00:00:00 2001 From: Tomas Zezula Date: Tue, 8 Mar 2016 21:39:19 +0100 Subject: [PATCH] Updated Java task manual. Added since tags. --- manual/Tasks/java.html | 62 ++++++++++++++++++- .../org/apache/tools/ant/taskdefs/Java.java | 8 +-- .../tools/ant/types/CommandlineJava.java | 24 +++---- 3 files changed, 75 insertions(+), 19 deletions(-) diff --git a/manual/Tasks/java.html b/manual/Tasks/java.html index a83b0aff2..36d50ce53 100644 --- a/manual/Tasks/java.html +++ b/manual/Tasks/java.html @@ -54,9 +54,9 @@ attributes.

Required - classname + classname the Java class to execute. - Either jar or classname + Either jar, classname or module jar @@ -64,7 +64,7 @@ attributes.

Main-Class entry in the manifest). Fork must be set to true if this option is selected. See notes below for more details. - Either jar or classname + Either jar, classname or module args @@ -119,6 +119,25 @@ attributes.

(ignored if fork is disabled) No + + module + The initial or main module to resolve. To specify + the module main class use the classname attribute. + Fork must be set to true if this option is selected.since Ant 1.9.7 + Either jar, classname or module + + + modulepath + Specify where to find application modules. A list of directories of modules, module files or exploded modules.since Ant 1.9.7 + No + + + modulepathref + The modulepath to use, given as reference to a PATH defined elsewhere. + since Ant 1.9.7 + No + failonerror Stop the buildprocess if the command exits with a @@ -312,6 +331,18 @@ error and would mean the build exits. , then <java> must return 0 otherwise the build will exit, as the class was run by the build JVM.

+

modulepath

+Since Ant 1.9.7 +

Java's modulepath attribute is a PATH like structure and can also be set via a nested +modulepath element.

+ +

upgrademodulepath

+Since Ant 1.9.7 +

The location of modules that replace upgradeable modules in the runtime image +can be specified using this PATH like structure.

+ +

JAR file execution

The parameter of the jar attribute is of type File; @@ -400,6 +431,31 @@ log-prefix to [java1.4]. JVM, as it takes different parameters for other JVMs, That JVM can be started from <exec> if required.

+
+       <java
+           fork="true"
+           failonerror="true"
+           maxmemory="128m"
+           module="TestModule"
+           modulepath="lib:dist/test.jar"/>
+
+Runs the module TestModule resolved on the modulepath lib/:dist/test.jar +with a maximum memory of 128MB. Any non zero return code breaks the build. +
+       <java
+           fork="true"
+           failonerror="true"
+           maxmemory="128m"
+           module="TestModule"
+           classname="Main">
+         <modulepath>
+           <pathelement location="lib"/>
+           <pathelement location="dist/test.jar"/>
+         </modulepath>
+       </java>
+
+Runs the class Main in module TestModule resolved on the modulepath lib/:dist/test.jar +with a maximum memory of 128MB. Any non zero return code breaks the build. diff --git a/src/main/org/apache/tools/ant/taskdefs/Java.java b/src/main/org/apache/tools/ant/taskdefs/Java.java index 99e23429f..623a7c18e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Java.java +++ b/src/main/org/apache/tools/ant/taskdefs/Java.java @@ -298,7 +298,7 @@ public class Java extends Task { * Set the modulepath to be used when running the Java class. * * @param mp an Ant Path object containing the modulepath. - * @since ??? + * @since 1.9.7 */ public void setModulepath(Path mp) { createModulepath().append(mp); @@ -308,7 +308,7 @@ public class Java extends Task { * Add a path to the modulepath. * * @return created modulepath. - * @since ??? + * @since 1.9.7 */ public Path createModulepath() { return getCommandLine().createModulepath(getProject()).createPath(); @@ -318,7 +318,7 @@ public class Java extends Task { * Add a path to the upgrademodulepath. * * @return created upgrademodulepath. - * @since ??? + * @since 1.9.7 */ public Path createUpgrademodulepath() { return getCommandLine().createUpgrademodulepath(getProject()).createPath(); @@ -379,7 +379,7 @@ public class Java extends Task { * @param module the name of the module. * * @throws BuildException if the jar attribute has been set. - * @since ??? + * @since 1.9.7 */ public void setModule(String module) throws BuildException { if (getCommandLine().getJar() != null) { diff --git a/src/main/org/apache/tools/ant/types/CommandlineJava.java b/src/main/org/apache/tools/ant/types/CommandlineJava.java index cf36a67c9..97b2bcd79 100644 --- a/src/main/org/apache/tools/ant/types/CommandlineJava.java +++ b/src/main/org/apache/tools/ant/types/CommandlineJava.java @@ -374,7 +374,7 @@ public class CommandlineJava implements Cloneable { /** * Set the module to execute. * @param module the module name. - * @since ??? + * @since 1.9.7 */ public void setModule(final String module) { if (executableType == null) { @@ -404,7 +404,7 @@ public class CommandlineJava implements Cloneable { * @return the name of the module to run or null if there is no module. * @see #getJar() * @see #getClassname() - * @since ??? + * @since 1.9.7 */ public String getModule() { if(executableType == ExecutableType.MODULE) { @@ -442,7 +442,7 @@ public class CommandlineJava implements Cloneable { * Create a modulepath. * @param p the project to use to create the path. * @return a path to be configured. - * @since ??? + * @since 1.9.7 */ public Path createModulepath(Project p) { if (modulepath == null) { @@ -455,7 +455,7 @@ public class CommandlineJava implements Cloneable { * Create an upgrademodulepath. * @param p the project to use to create the path. * @return a path to be configured. - * @since ??? + * @since 1.9.7 */ public Path createUpgrademodulepath(Project p) { if (upgrademodulepath == null) { @@ -672,7 +672,7 @@ public class CommandlineJava implements Cloneable { /** * Get the modulepath. * @return modulepath or null. - * @since ??? + * @since 1.9.7 */ public Path getModulepath() { return modulepath; @@ -681,7 +681,7 @@ public class CommandlineJava implements Cloneable { /** * Get the upgrademodulepath. * @return upgrademodulepath or null. - * @since ??? + * @since 1.9.7 */ public Path getUpgrademodulepath() { return upgrademodulepath; @@ -783,7 +783,7 @@ public class CommandlineJava implements Cloneable { /** * Determine whether the modulepath has been specified. * @return true if the modulepath is to be used. - * @since ??? + * @since 1.9.7 */ public boolean haveModulepath() { Path fullClasspath = modulepath != null @@ -795,7 +795,7 @@ public class CommandlineJava implements Cloneable { /** * Determine whether the upgrademodulepath has been specified. * @return true if the upgrademodulepath is to be used. - * @since ??? + * @since 1.9.7 */ public boolean haveUpgrademodulepath() { Path fullClasspath = upgrademodulepath != null @@ -846,7 +846,7 @@ public class CommandlineJava implements Cloneable { * @param module the module name. * @param classname the classname or null. * @return the main module with optional classname command line argument. - * @since ??? + * @since 1.9.7 */ private static String createModuleClassPair(final String module, final String classname) { return classname == null ? @@ -858,7 +858,7 @@ public class CommandlineJava implements Cloneable { * Parses a module name from JDK 9 main module command line argument. * @param moduleClassPair a module with optional classname or null. * @return the module name or null. - * @since ??? + * @since 1.9.7 */ private static String parseModuleFromModuleClassPair(final String moduleClassPair) { if (moduleClassPair == null) { @@ -872,7 +872,7 @@ public class CommandlineJava implements Cloneable { * Parses a classname from JDK 9 main module command line argument. * @param moduleClassPair a module with optional classname or null. * @return the classname or null. - * @since ??? + * @since 1.9.7 */ private static String parseClassFromModuleClassPair(final String moduleClassPair) { if (moduleClassPair == null) { @@ -886,7 +886,7 @@ public class CommandlineJava implements Cloneable { /** * Type of execution. - * @since ??? + * @since 1.9.7 */ private enum ExecutableType { /**