Submitted by: Larry Shatzer (larry dot shatzer at servent dot com) git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@275232 13f79535-47bb-0310-9956-ffa450edef68master
@@ -1,7 +1,7 @@ | |||
/* | |||
* The Apache Software License, Version 1.1 | |||
* | |||
* Copyright (c) 2000-2002 The Apache Software Foundation. All rights | |||
* Copyright (c) 2000-2003 The Apache Software Foundation. All rights | |||
* reserved. | |||
* | |||
* Redistribution and use in source and binary forms, with or without | |||
@@ -66,7 +66,7 @@ public class BuildException extends RuntimeException { | |||
/** Exception that might have caused this one. */ | |||
private Throwable cause; | |||
/** Location in the build file where the exception occured */ | |||
/** Location in the build file where the exception occurred */ | |||
private Location location = Location.UNKNOWN_LOCATION; | |||
/** | |||
@@ -78,7 +78,7 @@ public class ExitException extends SecurityException { | |||
/** | |||
* Constructs an exit exception. | |||
* @param msg the messge to be displayed. | |||
* @param msg the message to be displayed. | |||
* @param status the status code returned via System.exit() | |||
*/ | |||
public ExitException(String msg, int status) { | |||
@@ -71,7 +71,7 @@ import org.apache.tools.ant.launch.AntMain; | |||
/** | |||
* Command line entry point into Ant. This class is entered via the | |||
* cannonical `public static void main` entry point and reads the | |||
* canonical `public static void main` entry point and reads the | |||
* command line arguments. It then assembles and executes an Ant | |||
* project. | |||
* <p> | |||
@@ -462,7 +462,7 @@ public class Main implements AntMain { | |||
} | |||
// make sure it's not a directory (this falls into the ultra | |||
// paranoid lets check everything catagory | |||
// paranoid lets check everything category | |||
if (buildFile.isDirectory()) { | |||
System.out.println("What? Buildfile: " + buildFile + " is a dir!"); | |||
@@ -540,7 +540,7 @@ public class Main implements AntMain { | |||
* Search parent directories for the build file. | |||
* <p> | |||
* Takes the given target as a suffix to append to each | |||
* parent directory in seach of a build file. Once the | |||
* parent directory in search of a build file. Once the | |||
* root of the file-system has been reached an exception | |||
* is thrown. | |||
* | |||
@@ -618,7 +618,7 @@ public class Main implements AntMain { | |||
oldsm = System.getSecurityManager(); | |||
//SecurityManager can not be installed here for backwards | |||
//compatability reasons (PD). Needs to be loaded prior to | |||
//compatibility reasons (PD). Needs to be loaded prior to | |||
//ant class if we are going to implement it. | |||
//System.setSecurityManager(new NoExitSecurityManager()); | |||
} | |||
@@ -228,11 +228,11 @@ public class Project { | |||
/** | |||
* Set the default System input stream. Normally this stream is set to | |||
* System.in. This inputStream is used when no task inptu redirection is | |||
* System.in. This inputStream is used when no task input redirection is | |||
* being performed. | |||
* | |||
* @param defaultInputStream the default input stream to use when input | |||
* is reuested. | |||
* is requested. | |||
* @since Ant 1.6 | |||
*/ | |||
public void setDefaultInputStream(InputStream defaultInputStream) { | |||
@@ -242,7 +242,7 @@ public class Project { | |||
/** | |||
* Get this project's input stream | |||
* | |||
* @return the InputStream instance in use by this Porject instance to | |||
* @return the InputStream instance in use by this Project instance to | |||
* read input | |||
*/ | |||
public InputStream getDefaultInputStream() { | |||
@@ -332,7 +332,7 @@ public class Project { | |||
* Factory method to create a class loader for loading classes from | |||
* a given path | |||
* | |||
* @param path the path from whcih clases are to be loaded. | |||
* @param path the path from which classes are to be loaded. | |||
* | |||
* @return an appropriate classloader | |||
*/ | |||
@@ -1656,7 +1656,7 @@ public class Project { | |||
* @param visiting A stack of targets which are currently being visited. | |||
* Must not be <code>null</code>. | |||
* @param ret The list to add target names to. This will end up | |||
* containing the complete list of depenencies in | |||
* containing the complete list of dependencies in | |||
* dependency order. | |||
* Must not be <code>null</code>. | |||
* | |||
@@ -2007,7 +2007,7 @@ public class Project { | |||
} | |||
/** | |||
* Get the current task assopciated with a thread, if any | |||
* Get the current task associated with a thread, if any | |||
* | |||
* @param thread the thread for which the task is required. | |||
* @return the task which is currently registered for the given thread or | |||
@@ -72,8 +72,8 @@ import org.xml.sax.AttributeList; | |||
* | |||
* This class also provide static wrappers for common introspection. | |||
* | |||
* All helper plugins must provide backward compatiblity with the | |||
* original ant patterns, unless a different behavior is explicitely | |||
* All helper plugins must provide backward compatibility with the | |||
* original ant patterns, unless a different behavior is explicitly | |||
* specified. For example, if namespace is used on the <project> tag | |||
* the helper can expect the entire build file to be namespace-enabled. | |||
* Namespaces or helper-specific tags can provide meta-information to | |||
@@ -115,7 +115,7 @@ public class ProjectHelper { | |||
* @param buildFile An XML file giving the project's configuration. | |||
* Must not be <code>null</code>. | |||
* | |||
* @deprecated Use the non-statuc parse method | |||
* @deprecated Use the non-static parse method | |||
* @exception BuildException if the configuration is invalid or cannot | |||
* be read | |||
*/ | |||
@@ -198,7 +198,7 @@ public class ProjectHelper { | |||
public static ProjectHelper getProjectHelper() | |||
throws BuildException { | |||
// Identify the class loader we will be using. Ant may be | |||
// in a webapp or embeded in a different app | |||
// in a webapp or embedded in a different app | |||
ProjectHelper helper = null; | |||
// First, try the system property | |||
@@ -63,7 +63,7 @@ import java.util.Enumeration; | |||
- ns param. It could be used to provide "namespaces" for properties, which | |||
may be more flexible. | |||
- Object value. In ant1.5 String is used for Properties - but it would be nice | |||
to support generic Objects (the property remains imutable - you can't change | |||
to support generic Objects (the property remains immutable - you can't change | |||
the associated object). This will also allow JSP-EL style setting using the | |||
Object if an attribute contains only the property (name="${property}" could | |||
avoid Object->String->Object conversion) | |||
@@ -117,7 +117,7 @@ public class PropertyHelper { | |||
/** | |||
* Set the project for which this helper is performing property resolution | |||
* | |||
* @param p the projetc instance. | |||
* @param p the project instance. | |||
*/ | |||
public void setProject(Project p) { | |||
this.project = p; | |||
@@ -140,7 +140,7 @@ public class PropertyHelper { | |||
/** | |||
* Get the next property helper in the chain. | |||
* | |||
* @return the next proprty helper. | |||
* @return the next property helper. | |||
*/ | |||
public PropertyHelper getNext() { | |||
return next; | |||
@@ -149,7 +149,7 @@ public class PropertyHelper { | |||
/** | |||
* Factory method to create a property processor. | |||
* Users can provide their own or replace it using "ant.PropertyHelper" | |||
* reference. User tasks can also add themself to the chain, and provide | |||
* reference. User tasks can also add themselves to the chain, and provide | |||
* dynamic properties. | |||
* | |||
* @param project the project fro which the property helper is required. | |||
@@ -245,7 +245,7 @@ public class PropertyHelper { | |||
* <code>null</code> entries in the first list indicate a property | |||
* reference from the second list. | |||
* | |||
* It can be overriden with a more efficient or customized version. | |||
* It can be overridden with a more efficient or customized version. | |||
* | |||
* @param value Text to parse. Must not be <code>null</code>. | |||
* @param fragments List to add text fragments to. | |||
@@ -508,7 +508,7 @@ public class PropertyHelper { | |||
} | |||
// There is a better way to save the context. This shouldn't | |||
// delegate to next, it's for backward compat only. | |||
// delegate to next, it's for backward compatibility only. | |||
return propertiesCopy; | |||
} | |||
@@ -583,7 +583,7 @@ public class PropertyHelper { | |||
// this is used for backward compatibility (for code that calls | |||
// the parse method in ProjectHelper). | |||
/** Default parsing method. It is here only to support backward compat | |||
/** Default parsing method. It is here only to support backward compatibility | |||
* for the static ProjectHelper.parsePropertyString(). | |||
*/ | |||
static void parsePropertyStringDefault(String value, Vector fragments, | |||
@@ -104,7 +104,7 @@ public class RuntimeConfigurable implements Serializable { | |||
* preserving the order ( AFAIK ), some ant tests do rely on the | |||
* exact order. The following code is copied from AttributeImpl. | |||
* We could also just use SAX2 Attributes and convert to SAX1 ( DOM | |||
* attribute Nodes can also be stored in SAX2 Attributges ) | |||
* attribute Nodes can also be stored in SAX2 Attributes ) | |||
* XXX under JDK 1.4 you can just use a LinkedHashMap for this purpose -jglick | |||
*/ | |||
private List/*<String>*/ attributeNames = null; | |||
@@ -202,7 +202,7 @@ public abstract class Task extends ProjectComponent { | |||
* Called by the project to let the task initialize properly. | |||
* The default implementation is a no-op. | |||
* | |||
* @exception BuildException if someting goes wrong with the build | |||
* @exception BuildException if something goes wrong with the build | |||
*/ | |||
public void init() throws BuildException { | |||
} | |||
@@ -373,7 +373,7 @@ public abstract class Task extends ProjectComponent { | |||
} | |||
/** | |||
* Logs a mesage with the given priority. This delegates | |||
* Logs a message with the given priority. This delegates | |||
* the actual logging to the project. | |||
* | |||
* @param msg The message to be logged. Should not be <code>null</code>. | |||
@@ -80,7 +80,7 @@ public interface TypeAdapter { | |||
* Sets the proxy object, whose methods are going to be | |||
* invoked by ant. | |||
* A proxy object is normally the object defined by | |||
* a <typedef/> task that is adapted by the "adapter" | |||
* a <typedef/> task that is adapted by the "adapter" | |||
* attribute. | |||
* | |||
* @param o The target object. Must not be <code>null</code>. | |||
@@ -253,7 +253,7 @@ public class XmlLogger implements BuildLogger { | |||
/** | |||
* Fired when a target starts building, this pushes a timed element | |||
* for the target onto the stack of elements for the current thread, | |||
* rememebering the current time and the name of the target. | |||
* remembering the current time and the name of the target. | |||
* | |||
* @param event An event with any relevant extra information. | |||
* Will not be <code>null</code>. | |||
@@ -309,7 +309,7 @@ public class XmlLogger implements BuildLogger { | |||
/** | |||
* Fired when a task starts building, this pushes a timed element | |||
* for the task onto the stack of elements for the current thread, | |||
* rememebering the current time and the name of the task. | |||
* remembering the current time and the name of the task. | |||
* | |||
* @param event An event with any relevant extra information. | |||
* Will not be <code>null</code>. | |||
@@ -61,7 +61,7 @@ import java.io.Reader; | |||
* those lexical tokens out for purposes of simple Java parsing. | |||
* (if you have more complex Java parsing needs, use a real lexer). | |||
* Since this class heavily relies on the single char read function, | |||
* you are reccomended to make it work on top of a buffered reader. | |||
* you are recommended to make it work on top of a buffered reader. | |||
* | |||
* @author Not Specified. | |||
*/ | |||
@@ -240,7 +240,7 @@ public final class TailFilter extends BaseParamFilterReader | |||
* implement a tail filter on a stream of lines. | |||
* line = null is the end of the stream. | |||
* @return "" while reading in the lines, | |||
* line while outputing the lines | |||
* line while outputting the lines | |||
* null at the end of outputting the lines | |||
*/ | |||
private String tailFilter(String line) { | |||
@@ -191,9 +191,9 @@ public class TokenFilter extends BaseFilterReader | |||
} | |||
/** | |||
* set the output delimitor. | |||
* set the output delimiter. | |||
* @param delimOutput replaces the delim string returned by the | |||
* tokenizer, it it present. | |||
* tokenizer, if present. | |||
*/ | |||
public void setDelimOutput(String delimOutput) { | |||
@@ -231,7 +231,7 @@ public class TokenFilter extends BaseFilterReader | |||
} | |||
/** | |||
* add an arbirarty tokenizer | |||
* add an arbitrary tokenizer | |||
* @param tokenizer the tokenizer to all, only one allowed | |||
*/ | |||
@@ -296,14 +296,14 @@ public class TokenFilter extends BaseFilterReader | |||
/** | |||
* delete chars | |||
* @param filter the delete chaarcters filter | |||
* @param filter the delete characters filter | |||
*/ | |||
public void addDeleteCharacters(DeleteCharacters filter) { | |||
filters.addElement(filter); | |||
} | |||
/** | |||
* Add an arbitary filter | |||
* Add an arbitrary filter | |||
* @param filter the filter to add | |||
*/ | |||
public void add(Filter filter) { | |||
@@ -342,7 +342,7 @@ public class TokenFilter extends BaseFilterReader | |||
} | |||
/** | |||
* class to tokenize the input as areas seperated | |||
* class to tokenize the input as areas separated | |||
* by white space, or by a specified list of | |||
* delim characters. Behaves like java.util.StringTokenizer. | |||
* if the stream starts with delim characters, the first | |||
@@ -359,7 +359,7 @@ public class TokenFilter extends BaseFilterReader | |||
private boolean includeDelims = false; | |||
/** | |||
* attribute delims - the delimeter characters | |||
* attribute delims - the delimiter characters | |||
* @param delims a string containing the delimiter characters | |||
*/ | |||
public void setDelims(String delims) { | |||
@@ -388,7 +388,7 @@ public class TokenFilter extends BaseFilterReader | |||
* attribute includedelims - treat delimiters as part | |||
* of the token. | |||
* default - false | |||
* @param includeDelims if true add deliters to the token | |||
* @param includeDelims if true add delimiters to the token | |||
*/ | |||
public void setIncludeDelims(boolean includeDelims) { | |||
this.includeDelims = includeDelims; | |||
@@ -489,7 +489,7 @@ public class TokenFilter extends BaseFilterReader | |||
private boolean byLine = true; | |||
/** | |||
* set wheter to use filetokenizer or line tokenizer | |||
* set whether to use filetokenizer or line tokenizer | |||
* @param byLine if true use a linetokenizer (default) otherwise | |||
* use a filetokenizer | |||
*/ | |||
@@ -539,7 +539,7 @@ public class TokenFilter extends BaseFilterReader | |||
} | |||
/** | |||
* Filter a string 'line' replaceing from with to | |||
* Filter a string 'line' replacing from with to | |||
* (C&P from the Replace task) | |||
* @param line the string to be filtered | |||
* @return the filtered line | |||
@@ -752,7 +752,7 @@ public class TokenFilter extends BaseFilterReader | |||
/** Filter to trim white space */ | |||
public static class Trim extends ChainableReaderFilter { | |||
/** | |||
* @param line the string to be trimed | |||
* @param line the string to be trimmed | |||
* @return the trimmed string | |||
*/ | |||
public String filter(String line) { | |||
@@ -766,7 +766,7 @@ public class TokenFilter extends BaseFilterReader | |||
public static class IgnoreBlank extends ChainableReaderFilter { | |||
/** | |||
* @param line the line to modify | |||
* @return the trimed line | |||
* @return the trimmed line | |||
*/ | |||
public String filter(String line) { | |||
if (line.trim().length() == 0) { | |||
@@ -852,9 +852,9 @@ public class TokenFilter extends BaseFilterReader | |||
// -------------------------------------------------------- | |||
/** | |||
* xml does not do "c" like interpetation of strings. | |||
* xml does not do "c" like interpretation of strings. | |||
* i.e. \n\r\t etc. | |||
* this methid processes \n, \r, \t, \f, \\ | |||
* this method processes \n, \r, \t, \f, \\ | |||
* also subs \s -> " \n\r\t\f" | |||
* a trailing '\' will be ignored | |||
* | |||
@@ -423,7 +423,7 @@ public class ProjectHelper2 extends ProjectHelper { | |||
/** | |||
* Resolves file: URIs relative to the build file. | |||
* | |||
* @param publicId The public identifer, or <code>null</code> | |||
* @param publicId The public identifier, or <code>null</code> | |||
* if none is available. Ignored in this | |||
* implementation. | |||
* @param systemId The system identifier provided in the XML | |||
@@ -631,7 +631,7 @@ public class ProjectHelper2 extends ProjectHelper { | |||
* | |||
* If we eventually switch to ( or add support for ) DOM, | |||
* things will work smoothly - UE can be avoided almost completely | |||
* ( it could still be created on demand, for backward compat ) | |||
* ( it could still be created on demand, for backward compatibility ) | |||
*/ | |||
for (int i = 0; i < attrs.getLength(); i++) { | |||
@@ -695,7 +695,7 @@ public class ProjectHelper2 extends ProjectHelper { | |||
// no further processing | |||
return; | |||
} | |||
// set explicitely before starting ? | |||
// set explicitly before starting ? | |||
if (project.getProperty("basedir") != null) { | |||
project.setBasedir(project.getProperty("basedir")); | |||
} else { | |||
@@ -820,7 +820,7 @@ public class ProjectHelper2 extends ProjectHelper { | |||
Hashtable currentTargets = project.getTargets(); | |||
// If the name has already beend defined ( import for example ) | |||
// If the name has already been defined ( import for example ) | |||
if (currentTargets.containsKey(name)) { | |||
// Alter the name. | |||
if (context.getCurrentProjectName() != null) { | |||
@@ -960,7 +960,7 @@ public class ProjectHelper2 extends ProjectHelper { | |||
// PR: Hack for ant-type value | |||
// an ant-type is a component name which can | |||
// be namespaced, need to extract the name | |||
// and convert from qualifed name to uri/name | |||
// and convert from qualified name to uri/name | |||
if (name.equals("ant-type")) { | |||
int index = value.indexOf(":"); | |||
if (index != -1) { | |||
@@ -233,7 +233,7 @@ public class ProjectHelperImpl extends ProjectHelper { | |||
/** Helper impl. With non-static internal classes, the compiler will generate | |||
this automatically - but this will fail with some compilers ( reporting | |||
"Expecting to find object/array on stack" ). If we pass it | |||
explicitely it'll work with more compilers. | |||
explicitly it'll work with more compilers. | |||
*/ | |||
ProjectHelperImpl helperImpl; | |||
@@ -322,7 +322,7 @@ public class ProjectHelperImpl extends ProjectHelper { | |||
/** | |||
* Resolves file: URIs relative to the build file. | |||
* | |||
* @param publicId The public identifer, or <code>null</code> | |||
* @param publicId The public identifier, or <code>null</code> | |||
* if none is available. Ignored in this | |||
* implementation. | |||
* @param systemId The system identifier provided in the XML | |||
@@ -501,7 +501,7 @@ public class ProjectHelperImpl extends ProjectHelper { | |||
} | |||
/** | |||
* Handles a target defintion element by creating a target handler | |||
* Handles a target definition element by creating a target handler | |||
* and initialising is with the details of the element. | |||
* | |||
* @param tag The name of the element to be handled. | |||
@@ -176,13 +176,13 @@ public final class Locator { | |||
/** | |||
* Get the File necessary to load the Sun compiler tools. If the classes | |||
* are available to this class, then no additional URL is required and | |||
* null is returned. This may be because the classes are explcitly in the | |||
* null is returned. This may be because the classes are explicitly in the | |||
* class path or provided by the JVM directly | |||
* | |||
* @return the tools jar as a File if required, null otherwise | |||
*/ | |||
public static File getToolsJar() { | |||
// firstly check if the tols jar is alreayd n the classpath | |||
// firstly check if the tools jar is already in the classpath | |||
boolean toolsJarAvailable = false; | |||
try { | |||
@@ -225,7 +225,7 @@ public abstract class AbstractCvsTask extends Task { | |||
* if the stream has not yet been set, if the attribute output | |||
* has been set, the output stream will go to the output file | |||
* otherwise the output will go to ant's logging system | |||
* @return output stream to which cvs'stdout should go to | |||
* @return output stream to which cvs' stdout should go to | |||
*/ | |||
protected OutputStream getOutputStream() { | |||
@@ -264,7 +264,7 @@ public abstract class AbstractCvsTask extends Task { | |||
* if the stream has not yet been set, if the attribute error | |||
* has been set, the output stream will go to the file denoted by the error attribute | |||
* otherwise the stderr output will go to ant's logging system | |||
* @return output stream to which cvs'stderr should go to | |||
* @return output stream to which cvs' stderr should go to | |||
*/ | |||
protected OutputStream getErrorStream() { | |||
@@ -499,7 +499,7 @@ public abstract class AbstractCvsTask extends Task { | |||
} | |||
/** | |||
* access the the CVSROOT variable | |||
* access the CVSROOT variable | |||
* @return CVSROOT | |||
*/ | |||
public String getCvsRoot() { | |||
@@ -631,7 +631,7 @@ public abstract class AbstractCvsTask extends Task { | |||
* add a command line argument to an external command | |||
* | |||
* I do not understand what this method does in this class ??? | |||
* particulary not why it is public ???? | |||
* particularly not why it is public ???? | |||
* AntoineLL July 23d 2003 | |||
* | |||
* @param c command line to which one argument should be added | |||
@@ -567,7 +567,7 @@ public class Ant extends Task { | |||
/** | |||
* Copies all properties from the given table to the new project - | |||
* ommiting those that have already been set in the new project as | |||
* omitting those that have already been set in the new project as | |||
* well as properties named basedir or ant.file. | |||
* @param props properties to copy to the new project | |||
* @since Ant 1.6 | |||
@@ -360,13 +360,13 @@ public class AntStructure extends Task { | |||
/** | |||
* Does this String match the XML-NMTOKEN production? | |||
* @param s the string to test | |||
* @return true if the string matche the XML-NMTOKEN | |||
* @return true if the string matches the XML-NMTOKEN | |||
*/ | |||
protected boolean isNmtoken(String s) { | |||
final int length = s.length(); | |||
for (int i = 0; i < length; i++) { | |||
char c = s.charAt(i); | |||
// XXX - we are ommitting CombiningChar and Extender here | |||
// XXX - we are committing CombiningChar and Extender here | |||
if (!Character.isLetterOrDigit(c) | |||
&& c != '.' && c != '-' && c != '_' && c != ':') { | |||
return false; | |||
@@ -164,7 +164,7 @@ public class Antlib extends Task implements TaskContainer { | |||
/** | |||
* add a task to the list of tasks | |||
* | |||
* @param nestedTask Nested task to execute in antlibe | |||
* @param nestedTask Nested task to execute in antlib | |||
*/ | |||
public void addTask(Task nestedTask) { | |||
tasks.add(nestedTask); | |||
@@ -57,7 +57,7 @@ package org.apache.tools.ant.taskdefs; | |||
/** | |||
* Interface for tasks that should be informed when | |||
* they are loaded in antlib's. | |||
* For handling uri and and class loading. | |||
* For handling uri and class loading. | |||
* | |||
* @author Peter Reilly | |||
* | |||
@@ -328,7 +328,7 @@ public class Available extends Task implements Condition { | |||
} | |||
/** | |||
* Search for file/directory either either relative to project's | |||
* Search for file/directory either relative to project's | |||
* basedir or in the path given as filepath. | |||
* | |||
* <p>filepath can be a list of directory and/or file names (gen'd | |||