mbenson 2005/02/07 15:36:02
Modified: src/main/org/apache/tools/ant/taskdefs ExecuteJava.java
Log:
Javadoc
Revision Changes Path
1.47 +31 -13
ant/src/main/org/apache/tools/ant/taskdefs/ExecuteJava.java
Index: ExecuteJava.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/ExecuteJava.java,v
retrieving revision 1.46
retrieving revision 1.47
diff -u -r1.46 -r1.47
--- ExecuteJava.java 7 Feb 2005 23:25:03 -0000 1.46
+++ ExecuteJava.java 7 Feb 2005 23:36:02 -0000 1.47
@@ -38,7 +38,7 @@
import org.apache.tools.ant.util.Watchdog;
/**
- *
+ * Execute a Java class.
* @since Ant 1.2
*/
public class ExecuteJava implements Runnable, TimeoutObserver {
@@ -53,12 +53,16 @@
private boolean timedOut = false;
private Thread thread = null;
+ /**
+ * Set the Java "command" for this ExecuteJava.
+ * @param javaCommand the classname and arguments in a Commandline.
+ */
public void setJavaCommand(Commandline javaCommand) {
this.javaCommand = javaCommand;
}
/**
- * Set the classpath to be used when running the Java class
+ * Set the classpath to be used when running the Java class.
*
* @param p an Ant Path object containing the classpath.
*/
@@ -66,35 +70,45 @@
classpath = p;
}
+ /**
+ * Set the system properties to use when running the Java class.
+ * @param s CommandlineJava system properties.
+ */
public void setSystemProperties(CommandlineJava.SysProperties s) {
sysProperties = s;
}
/**
- * Permissions for the application run.
+ * Set the permissions for the application run.
+ * @param permissions the Permissions to use.
* @since Ant 1.6
- * @param permissions
*/
public void setPermissions(Permissions permissions) {
perm = permissions;
}
/**
- * All output (System.out as well as System.err) will be written
- * to this Stream.
- *
- * @deprecated manage output at the task level
+ * Set the stream to which all output (System.out as well as System.err)
+ * will be written.
+ * @param out the PrintStream where output should be sent.
+ * @deprecated manage output at the task level.
*/
public void setOutput(PrintStream out) {
}
/**
+ * Set the timeout for this ExecuteJava.
+ * @param timeout timeout as Long.
* @since Ant 1.5
*/
public void setTimeout(Long timeout) {
this.timeout = timeout;
}
+ /**
+ * Execute the Java class against the specified Ant Project.
+ * @param project the Project to use.
+ */
public void execute(Project project) throws BuildException {
final String classname = javaCommand.getExecutable();
@@ -180,6 +194,7 @@
}
/**
+ * Run this ExecuteJava in a Thread.
* @since Ant 1.5
*/
public void run() {
@@ -207,6 +222,8 @@
}
/**
+ * Mark timeout as having occurred.
+ * @param w the responsible Watchdog.
* @since Ant 1.5
*/
public synchronized void timeoutOccured(Watchdog w) {
@@ -218,6 +235,8 @@
}
/**
+ * Get whether the process was killed.
+ * @return <code>true</code> if the process was killed, false otherwise.
* @since 1.19, Ant 1.5
*/
public synchronized boolean killedProcess() {
@@ -225,10 +244,10 @@
}
/**
- * Runs the Java command in a separate VM, this does not give you
+ * Run the Java command in a separate VM, this does not give you
* the full flexibility of the Java task, but may be enough for
* simple needs.
- *
+ * @param pc the ProjectComponent to use for logging, etc.
* @since Ant 1.6.3
*/
public int fork(ProjectComponent pc) throws BuildException {
@@ -244,7 +263,6 @@
if (sysProperties != null) {
cmdl.addSysproperties(sysProperties);
}
-
Redirector redirector = new Redirector(pc);
Execute exe
= new Execute(redirector.createHandler(),
@@ -272,8 +290,8 @@
* containing the arguments and classpath for the java command.
* The special file is supported by the "-V" switch on the VMS JVM.
*
- * @param exe
- * @param command
+ * @param exe the Execute instance to alter.
+ * @param command the command-line.
*/
public static void setupCommandLineForVMS(Execute exe, String[] command)
{
//Use the VM launcher instead of shell launcher on VMS
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
