@@ -31,16 +31,16 @@ import java.util.Locale; | |||||
/** | /** | ||||
* The Locator is a utility class which is used to find certain items | * The Locator is a utility class which is used to find certain items | ||||
* in the environment. | * in the environment. | ||||
* | |||||
* <p> | |||||
* It is used at boot time in the launcher, and cannot make use of any of Ant's other classes. | * It is used at boot time in the launcher, and cannot make use of any of Ant's other classes. | ||||
* | |||||
* This is a surprisingly brittle piece of code, and has had lots of bugs filed against it. | |||||
* {@link <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42275">running ant off a network share can cause Ant to fail</a>} | |||||
* {@link <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=8031">use File.toURI().toURL().toExternalForm()</a>} | |||||
* {@link <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42222">Locator implementation not encoding URI strings properly: spaces in paths</a>} | |||||
* It also breaks Eclipse 3.3 Betas | |||||
* {@link <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=183283">Exception if installation path has spaces</a>} | |||||
* | |||||
* <p> | |||||
* This is a surprisingly brittle piece of code, and has had lots of bugs filed against it: | |||||
* <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42275">running ant off a network share can cause Ant to fail</a>, | |||||
* <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=8031">use File.toURI().toURL().toExternalForm()</a>, | |||||
* <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=42222">Locator implementation not encoding URI strings properly: spaces in paths</a>. | |||||
* It also breaks Eclipse 3.3 Betas: | |||||
* <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=183283">Exception if installation path has spaces</a>. | |||||
* <p> | |||||
* Be very careful when making changes to this class, as a break will upset a lot of people. | * Be very careful when making changes to this class, as a break will upset a lot of people. | ||||
* @since Ant 1.6 | * @since Ant 1.6 | ||||
*/ | */ | ||||
@@ -385,7 +385,7 @@ public class Funtest extends Task { | |||||
/** | /** | ||||
* Run the functional test sequence. | * Run the functional test sequence. | ||||
* <p/> | |||||
* <p> | |||||
* This is a fairly complex workflow -what is going on is that we try to clean up | * This is a fairly complex workflow -what is going on is that we try to clean up | ||||
* no matter how the run ended, and to retain the innermost exception that got thrown | * no matter how the run ended, and to retain the innermost exception that got thrown | ||||
* during cleanup. That is, if teardown fails after the tests themselves failed, it is the | * during cleanup. That is, if teardown fails after the tests themselves failed, it is the | ||||
@@ -64,7 +64,7 @@ public class Date implements ResourceSelector { | |||||
/** | /** | ||||
* Set the date and time as a String. | * Set the date and time as a String. | ||||
* @param s the date & time to use. | |||||
* @param s the date and time to use. | |||||
*/ | */ | ||||
public synchronized void setDateTime(String s) { | public synchronized void setDateTime(String s) { | ||||
dateTime = s; | dateTime = s; | ||||
@@ -72,8 +72,8 @@ public class Date implements ResourceSelector { | |||||
} | } | ||||
/** | /** | ||||
* Get the date & time in String format. | |||||
* @return a String representing a date & time. | |||||
* Get the date and time in String format. | |||||
* @return a String representing a date and time. | |||||
*/ | */ | ||||
public synchronized String getDatetime() { | public synchronized String getDatetime() { | ||||
return dateTime; | return dateTime; | ||||
@@ -56,7 +56,7 @@ public class DOMUtils { | |||||
* <b/> | * <b/> | ||||
* </a> | * </a> | ||||
* </pre> | * </pre> | ||||
* and returns <code><b></code>.</p> | |||||
* and returns <code><b></code>. | |||||
* | * | ||||
* @param parent element that will receive the new element as child. | * @param parent element that will receive the new element as child. | ||||
* @param name name of the new element. | * @param name name of the new element. | ||||
@@ -80,7 +80,6 @@ public class DOMUtils { | |||||
* <pre> | * <pre> | ||||
* <a>b</a> | * <a>b</a> | ||||
* </pre> | * </pre> | ||||
* </p> | |||||
* | * | ||||
* @param parent element that will receive the new element as child. | * @param parent element that will receive the new element as child. | ||||
* @param content text content. | * @param content text content. | ||||
@@ -102,7 +101,6 @@ public class DOMUtils { | |||||
* <pre> | * <pre> | ||||
* <a><[!CDATA[b]]></a> | * <a><[!CDATA[b]]></a> | ||||
* </pre> | * </pre> | ||||
* </p> | |||||
* | * | ||||
* @param parent element that will receive the new element as child. | * @param parent element that will receive the new element as child. | ||||
* @param content text content. | * @param content text content. | ||||
@@ -126,7 +124,6 @@ public class DOMUtils { | |||||
* <b>c</b> | * <b>c</b> | ||||
* </a> | * </a> | ||||
* </pre> | * </pre> | ||||
* </p> | |||||
* | * | ||||
* @param parent element that will receive the new element as child. | * @param parent element that will receive the new element as child. | ||||
* @param name of the child element. | * @param name of the child element. | ||||
@@ -148,11 +145,9 @@ public class DOMUtils { | |||||
* creates | * creates | ||||
* <pre> | * <pre> | ||||
* <a> | * <a> | ||||
* <b><![CDATA[c]]></b> | |||||
* <b><![CDATA[c]]></b> | |||||
* </a> | * </a> | ||||
* </pre> | * </pre> | ||||
* </pre> | |||||
* </p> | |||||
* | * | ||||
* @param parent element that will receive the new element as child. | * @param parent element that will receive the new element as child. | ||||
* @param name of the child element. | * @param name of the child element. | ||||
@@ -1346,21 +1346,21 @@ public class FileUtils { | |||||
* test whether a file or directory exists, with an error in the | * test whether a file or directory exists, with an error in the | ||||
* upper/lower case spelling of the name. | * upper/lower case spelling of the name. | ||||
* Using this method is only interesting on case insensitive file systems | * Using this method is only interesting on case insensitive file systems | ||||
* (Windows).<br/> | |||||
* (Windows).<br> | |||||
* It will return true only if 3 conditions are met : | * It will return true only if 3 conditions are met : | ||||
* <br/> | |||||
* <br> | |||||
* <ul> | * <ul> | ||||
* <li>operating system is case insensitive</li> | * <li>operating system is case insensitive</li> | ||||
* <li>file exists</li> | * <li>file exists</li> | ||||
* <li>actual name from directory reading is different from the | * <li>actual name from directory reading is different from the | ||||
* supplied argument</li> | * supplied argument</li> | ||||
* </ul> | * </ul> | ||||
* <br/> | |||||
* <br> | |||||
* the purpose is to identify files or directories on case-insensitive | * the purpose is to identify files or directories on case-insensitive | ||||
* filesystems whose case is not what is expected.<br/> | |||||
* filesystems whose case is not what is expected.<br> | |||||
* Possibly to rename them afterwards to the desired upper/lowercase | * Possibly to rename them afterwards to the desired upper/lowercase | ||||
* combination. | * combination. | ||||
* <br/> | |||||
* | |||||
* @param localFile file to test | * @param localFile file to test | ||||
* @return true if the file exists and the case of the actual file | * @return true if the file exists and the case of the actual file | ||||
* is not the case of the parameter | * is not the case of the parameter | ||||
@@ -1591,7 +1591,7 @@ public class FileUtils { | |||||
/** | /** | ||||
* Calculates the relative path between two files. | * Calculates the relative path between two files. | ||||
* <p> | * <p> | ||||
* Implementation note:<br/> This function may throw an IOException if an I/O error occurs | |||||
* Implementation note:<br>This function may throw an IOException if an I/O error occurs | |||||
* because its use of the canonical pathname may require filesystem queries. | * because its use of the canonical pathname may require filesystem queries. | ||||
* </p> | * </p> | ||||
* | * | ||||
@@ -24,7 +24,7 @@ import org.apache.tools.ant.BuildException; | |||||
* Implementation of FileNameMapper that does simple wildcard pattern | * Implementation of FileNameMapper that does simple wildcard pattern | ||||
* replacements. | * replacements. | ||||
* | * | ||||
* <p>This does simple translations like *.foo -> *.bar where the | |||||
* <p>This does simple translations like *.foo -> *.bar where the | |||||
* prefix to .foo will be left unchanged. It only handles a single * | * prefix to .foo will be left unchanged. It only handles a single * | ||||
* character, use regular expressions for more complicated | * character, use regular expressions for more complicated | ||||
* situations.</p> | * situations.</p> | ||||
@@ -32,7 +32,6 @@ import java.io.InputStream; | |||||
* in.close(); | * in.close(); | ||||
* } | * } | ||||
* </pre> | * </pre> | ||||
* </p> | |||||
* | * | ||||
* @since Ant 1.6 | * @since Ant 1.6 | ||||
*/ | */ | ||||
@@ -29,11 +29,10 @@ import java.io.PrintStream; | |||||
* <p> | * <p> | ||||
* In code-language it means that it is not necessary to do: | * In code-language it means that it is not necessary to do: | ||||
* <pre> | * <pre> | ||||
* if (out != System.out && out!= System.err) { | |||||
* if (out != System.out && out != System.err) { | |||||
* out.close(); | * out.close(); | ||||
* } | * } | ||||
* </pre> | * </pre> | ||||
* </p> | |||||
* | * | ||||
*/ | */ | ||||
public class KeepAliveOutputStream extends FilterOutputStream { | public class KeepAliveOutputStream extends FilterOutputStream { | ||||
@@ -40,7 +40,7 @@ import java.util.Properties; | |||||
* class to there, but it also keeps track of the contents of the | * class to there, but it also keeps track of the contents of the | ||||
* input stream from which it was loaded (if applicable), so that it can | * input stream from which it was loaded (if applicable), so that it can | ||||
* write out the properties in as close a form as possible to the input.</p> | * write out the properties in as close a form as possible to the input.</p> | ||||
* If no changes occur to property values, the output should be the same | |||||
* <p>If no changes occur to property values, the output should be the same | |||||
* as the input, except for the leading date stamp, as normal for a | * as the input, except for the leading date stamp, as normal for a | ||||
* properties file. Properties added are appended to the file. Properties | * properties file. Properties added are appended to the file. Properties | ||||
* whose values are changed are changed in place. Properties that are | * whose values are changed are changed in place. Properties that are | ||||
@@ -63,7 +63,7 @@ import java.util.Properties; | |||||
* | * | ||||
* # and finally | * # and finally | ||||
* gamma=rays</pre> | * gamma=rays</pre> | ||||
* </p>The resulting collection sequence of logical lines depends on whether | |||||
* <p>The resulting collection sequence of logical lines depends on whether | |||||
* or not <code>removeComments</code> was set at the time the second stream | * or not <code>removeComments</code> was set at the time the second stream | ||||
* is loaded. If it is set, then the resulting list of lines is</p> | * is loaded. If it is set, then the resulting list of lines is</p> | ||||
* <pre> # the first line | * <pre> # the first line | ||||
@@ -103,7 +103,7 @@ public class LeadPipeInputStream extends PipedInputStream { | |||||
/** | /** | ||||
* Set the size of the buffer. | * Set the size of the buffer. | ||||
* @param size the new buffer size. Ignored if <= current size. | |||||
* @param size the new buffer size. Ignored if <= current size. | |||||
*/ | */ | ||||
public synchronized void setBufferSize(int size) { | public synchronized void setBufferSize(int size) { | ||||
if (size > buffer.length) { | if (size > buffer.length) { | ||||
@@ -34,7 +34,6 @@ public class ProxySetup { | |||||
/** | /** | ||||
* Java1.5 property that enables use of system proxies. | * Java1.5 property that enables use of system proxies. | ||||
* @value | |||||
*/ | */ | ||||
public static final String USE_SYSTEM_PROXIES = "java.net.useSystemProxies"; | public static final String USE_SYSTEM_PROXIES = "java.net.useSystemProxies"; | ||||
/** the http proxyhost property */ | /** the http proxyhost property */ | ||||
@@ -86,7 +86,7 @@ public class ScriptFixBSFPath { | |||||
* </ol> | * </ol> | ||||
* | * | ||||
* Assume a simple model for the loader: | * Assume a simple model for the loader: | ||||
* thisloader<-customloader | |||||
* thisloader<-customloader | |||||
* or | * or | ||||
* thisloader | * thisloader | ||||
* | * | ||||
@@ -140,7 +140,7 @@ public final class StringUtils { | |||||
* xml does not do "c" like interpretation of strings. | * xml does not do "c" like interpretation of strings. | ||||
* i.e. \n\r\t etc. | * i.e. \n\r\t etc. | ||||
* this method processes \n, \r, \t, \f, \\ | * this method processes \n, \r, \t, \f, \\ | ||||
* also subs \s -> " \n\r\t\f" | |||||
* also subs \s -> " \n\r\t\f" | |||||
* a trailing '\' will be ignored | * a trailing '\' will be ignored | ||||
* | * | ||||
* @param input raw string with possible embedded '\'s | * @param input raw string with possible embedded '\'s | ||||
@@ -46,7 +46,7 @@ public class Watchdog implements Runnable { | |||||
/** | /** | ||||
* Constructor for Watchdog. | * Constructor for Watchdog. | ||||
* @param timeout the timeout to use in milliseconds (must be >= 1). | |||||
* @param timeout the timeout to use in milliseconds (must be >= 1). | |||||
*/ | */ | ||||
public Watchdog(long timeout) { | public Watchdog(long timeout) { | ||||
if (timeout < 1) { | if (timeout < 1) { | ||||
@@ -26,7 +26,7 @@ import org.apache.tools.ant.Task; | |||||
* After the run, any exception thrown is turned into a buildexception, which can be | * After the run, any exception thrown is turned into a buildexception, which can be | ||||
* rethrown, the finished attribute is set, then notifyAll() is called, | * rethrown, the finished attribute is set, then notifyAll() is called, | ||||
* so that anyone waiting on the same notify object gets woken up. | * so that anyone waiting on the same notify object gets woken up. | ||||
* </p> | |||||
* <p> | |||||
* This class is effectively a superset of | * This class is effectively a superset of | ||||
* {@link org.apache.tools.ant.taskdefs.Parallel.TaskRunnable} | * {@link org.apache.tools.ant.taskdefs.Parallel.TaskRunnable} | ||||
* | * | ||||
@@ -49,7 +49,7 @@ public class WorkerAnt extends Thread { | |||||
/** | /** | ||||
* Create the worker. | * Create the worker. | ||||
* <p/> | |||||
* <p> | |||||
* This does not start the thread, merely configures it. | * This does not start the thread, merely configures it. | ||||
* @param task the task | * @param task the task | ||||
* @param notify what to notify | * @param notify what to notify | ||||
@@ -61,7 +61,7 @@ public class WorkerAnt extends Thread { | |||||
/** | /** | ||||
* Create the worker, using the worker as the notification point. | * Create the worker, using the worker as the notification point. | ||||
* <p/> | |||||
* <p> | |||||
* This does not start the thread, merely configures it. | * This does not start the thread, merely configures it. | ||||
* @param task the task | * @param task the task | ||||
*/ | */ | ||||
@@ -83,7 +83,7 @@ public class WorkerAnt extends Thread { | |||||
/** | /** | ||||
* Get whatever was thrown, which may or may not be a buildException. | * Get whatever was thrown, which may or may not be a buildException. | ||||
* Assertion: getException() instanceof BuildException <=> getBuildException()==getException() | |||||
* Assertion: getException() instanceof BuildException <=> getBuildException()==getException() | |||||
* @return the exception. | * @return the exception. | ||||
*/ | */ | ||||
public synchronized Throwable getException() { | public synchronized Throwable getException() { | ||||
@@ -613,7 +613,7 @@ public class CBZip2OutputStream extends OutputStream | |||||
* @throws IOException | * @throws IOException | ||||
* if an I/O error occurs in the specified stream. | * if an I/O error occurs in the specified stream. | ||||
* @throws IllegalArgumentException | * @throws IllegalArgumentException | ||||
* if <code>(blockSize < 1) || (blockSize > 9)</code>. | |||||
* if <code>(blockSize < 1) || (blockSize > 9)</code>. | |||||
* @throws NullPointerException | * @throws NullPointerException | ||||
* if <code>out == null</code>. | * if <code>out == null</code>. | ||||
* | * | ||||