diff --git a/src/etc/checkstyle/checkstyle-frames-sortby-check.xsl b/src/etc/checkstyle/checkstyle-frames-sortby-check.xsl index e7a19b2a63..0d43c1434d 100644 --- a/src/etc/checkstyle/checkstyle-frames-sortby-check.xsl +++ b/src/etc/checkstyle/checkstyle-frames-sortby-check.xsl @@ -43,7 +43,7 @@ - + @@ -83,7 +83,7 @@ -The value is the count of all the remote method calls in all of the methods +The value is the count of all the remote method calls in all the methods and constructors of the class. @@ -276,7 +276,7 @@ and constructors of the class. NLM is defined for classes and interfaces. A local method is defined as a method that is declared in the class or interface. NLM can be configured to -include the local methods of all of the class's superclasses. Methods with +include the local methods of all the class's superclasses. Methods with public, protected, package and private visibility can be independently counted by setting configuration parameters. @@ -324,7 +324,7 @@ typically require a deeper understanding of the potential interactions that objects of the class can have with the rest of the system.

RFC is defined as the sum of NLM and NRM for the class. The local methods -include all of the public, protected, package and private methods, but not +include all the public, protected, package and private methods, but not methods declared only in a superclass. @@ -399,7 +399,7 @@ If a class exhibits low method cohesion it indicates that the design of the class has probably been partitioned incorrectly, and could benefit by being split into more classes with individually higher cohesion. On the other hand, a high value of cohesion (a low lack of cohesion) implies that the -class is well designed. A cohesive class will tend to provide a high degree +class is well-designed. A cohesive class will tend to provide a high degree of encapsulation, whereas a lack of cohesion decreases encapsulation and increases complexity.

diff --git a/src/etc/testcases/taskdefs/exec/exec.xml b/src/etc/testcases/taskdefs/exec/exec.xml index 998cb06584..25b3a210ce 100644 --- a/src/etc/testcases/taskdefs/exec/exec.xml +++ b/src/etc/testcases/taskdefs/exec/exec.xml @@ -20,9 +20,9 @@ - + - + diff --git a/src/etc/testcases/taskdefs/jmod.xml b/src/etc/testcases/taskdefs/jmod.xml index 38ab346450..18af6009c2 100644 --- a/src/etc/testcases/taskdefs/jmod.xml +++ b/src/etc/testcases/taskdefs/jmod.xml @@ -720,7 +720,7 @@ Change the user\*(Aqs office phone number\&. .PP If none of the options are selected, \fBchfn\fR -operates in an interactive fashion, prompting the user with the current values for all of the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of +operates in an interactive fashion, prompting the user with the current values for all the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of \fB[ ]\fR marks\&. Without options, \fBchfn\fR @@ -1135,7 +1135,7 @@ Change the user\*(Aqs office phone number\&. .PP If none of the options are selected, \fBchfn\fR -operates in an interactive fashion, prompting the user with the current values for all of the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of +operates in an interactive fashion, prompting the user with the current values for all the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of \fB[ ]\fR marks\&. Without options, \fBchfn\fR diff --git a/src/etc/testcases/taskdefs/link.xml b/src/etc/testcases/taskdefs/link.xml index cc479d540d..7a9a412deb 100644 --- a/src/etc/testcases/taskdefs/link.xml +++ b/src/etc/testcases/taskdefs/link.xml @@ -249,7 +249,7 @@ Change the user\*(Aqs office phone number\&. .PP If none of the options are selected, \fBchfn\fR -operates in an interactive fashion, prompting the user with the current values for all of the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of +operates in an interactive fashion, prompting the user with the current values for all the fields\&. Enter the new value to change the field, or leave the line blank to use the current value\&. The current value is displayed between a pair of \fB[ ]\fR marks\&. Without options, \fBchfn\fR diff --git a/src/etc/testcases/taskdefs/optional/antlr/java.g b/src/etc/testcases/taskdefs/optional/antlr/java.g index e585750285..0c6a9a76d3 100644 --- a/src/etc/testcases/taskdefs/optional/antlr/java.g +++ b/src/etc/testcases/taskdefs/optional/antlr/java.g @@ -442,7 +442,7 @@ parameterModifier // Inside a class definition without "static": // it is an instance initializer // As the body of a method -// As a completely indepdent braced block of code inside a method +// As a completely independent braced block of code inside a method // it starts a new scope for variable definitions compoundStatement diff --git a/src/etc/testcases/taskdefs/optional/unix/symlink.xml b/src/etc/testcases/taskdefs/optional/unix/symlink.xml index 99c0bbb169..1294f73bdb 100644 --- a/src/etc/testcases/taskdefs/optional/unix/symlink.xml +++ b/src/etc/testcases/taskdefs/optional/unix/symlink.xml @@ -19,11 +19,11 @@ diff --git a/src/etc/testcases/types/assertions.xml b/src/etc/testcases/types/assertions.xml index 8b1e6bcfd7..f60abc8fce 100644 --- a/src/etc/testcases/types/assertions.xml +++ b/src/etc/testcases/types/assertions.xml @@ -83,7 +83,7 @@ - @@ -99,7 +99,7 @@ - loaderPackages = new Vector<>(); /** - * Whether or not this classloader will ignore the base + * Whether this classloader will ignore the base * classloader if it can't find a class. * * @see #setIsolated(boolean) @@ -259,7 +259,7 @@ private void findNextResource() { private ClassLoader savedContextLoader = null; /** - * Whether or not the context loader is currently saved. + * Whether the context loader is currently saved. */ private boolean isContextLoaderSaved = false; @@ -316,7 +316,7 @@ public AntClassLoader(final Project project, final Path classpath) { * elements are set up to start with. * @param parentFirst If true, indicates that the parent * classloader should be consulted before trying to - * load the a class through this loader. + * load the class through this loader. */ public AntClassLoader(final ClassLoader parent, final Project project, final Path classpath, final boolean parentFirst) { @@ -338,7 +338,7 @@ public AntClassLoader(final ClassLoader parent, final Project project, * elements are set up to start with. * @param parentFirst If true, indicates that the parent * classloader should be consulted before trying to - * load the a class through this loader. + * load the class through this loader. */ public AntClassLoader(final Project project, final Path classpath, final boolean parentFirst) { @@ -356,7 +356,7 @@ public AntClassLoader(final Project project, final Path classpath, * class is used as the parent. * @param parentFirst If true, indicates that the parent * classloader should be consulted before trying to - * load the a class through this loader. + * load the class through this loader. */ public AntClassLoader(final ClassLoader parent, final boolean parentFirst) { setParent(parent); @@ -581,7 +581,7 @@ public String getClasspath() { * not be referred to the parent class loader but will cause a * ClassNotFoundException. * - * @param isolated Whether or not this classloader should run in + * @param isolated Whether this classloader should run in * isolated mode. */ public synchronized void setIsolated(final boolean isolated) { @@ -830,7 +830,7 @@ private InputStream getResourceStream(final File file, final String resourceName } /** - * Tests whether or not the parent classloader should be checked for a + * Tests whether the parent classloader should be checked for a * resource before this one. If the resource matches both the "use parent * classloader first" and the "use this classloader first" lists, the latter * takes priority. @@ -839,7 +839,7 @@ private InputStream getResourceStream(final File file, final String resourceName * The name of the resource to check. Must not be * null. * - * @return whether or not the parent classloader should be checked for a + * @return whether the parent classloader should be checked for a * resource before this one is. */ private boolean isParentFirst(final String resourceName) { @@ -868,7 +868,7 @@ private ClassLoader getRootLoader() { /** * Finds the resource with the given name. A resource is - * some data (images, audio, text, etc) that can be accessed by class + * some data (images, audio, text, etc.) that can be accessed by class * code in a way that is independent of the location of the code. * * @param name The name of the resource for which a stream is required. @@ -892,7 +892,7 @@ public URL getResource(final String name) { url = getUrl(name); } if (url == null && !isParentFirst(name)) { - // this loader was first but it didn't find it - try the parent + // this loader was first, but it didn't find it - try the parent if (ignoreBase) { url = getRootLoader() == null ? null : getRootLoader().getResource(name); } else { @@ -933,7 +933,7 @@ private URL getUrl(String name) { /** * Finds all the resources with the given name. A resource is some - * data (images, audio, text, etc) that can be accessed by class + * data (images, audio, text, etc.) that can be accessed by class * code in a way that is independent of the location of the code. * * @param name name of the resource @@ -1076,7 +1076,7 @@ protected URL getResourceURL(final File file, final String resourceName) { * Loads a class with this class loader. * * This class attempts to load the class in an order determined by whether - * or not the class matches the system/loader package lists, with the + * the class matches the system/loader package lists, with the * loader package list taking priority. If the classloader is in isolated * mode, failure to load the class in this loader will result in a * ClassNotFoundException. @@ -1204,12 +1204,12 @@ protected void definePackage(final File container, final String className) throw } /** - * Get the manifest from the given jar, if it is indeed a jar and it has a + * Get the manifest from the given jar, if it is indeed a jar, and it has a * manifest * * @param container the File from which a manifest is required. * - * @return the jar's manifest or null is the container is not a jar or it + * @return the jar's manifest or null is the container is not a jar, or it * has no manifest. * * @exception IOException if the manifest cannot be read. @@ -1232,7 +1232,7 @@ private Manifest getJarManifest(final File container) throws IOException { * @param entry the entry of which the certificates are requested * * @return the entry's certificates or null is the container is - * not a jar or it has no certificates. + * not a jar, or it has no certificates. */ private Certificate[] getCertificates(final File container, final String entry) { if (container.isDirectory()) { diff --git a/src/main/org/apache/tools/ant/AntTypeDefinition.java b/src/main/org/apache/tools/ant/AntTypeDefinition.java index c645a948d0..6498aa7538 100644 --- a/src/main/org/apache/tools/ant/AntTypeDefinition.java +++ b/src/main/org/apache/tools/ant/AntTypeDefinition.java @@ -74,7 +74,7 @@ public String getName() { /** * Set the class of the definition. - * As a side-effect may set the classloader and classname. + * As a side effect may set the classloader and classname. * @param clazz the class of this definition. */ public void setClass(Class clazz) { diff --git a/src/main/org/apache/tools/ant/ArgumentProcessor.java b/src/main/org/apache/tools/ant/ArgumentProcessor.java index ec08f0035f..eb596f8302 100644 --- a/src/main/org/apache/tools/ant/ArgumentProcessor.java +++ b/src/main/org/apache/tools/ant/ArgumentProcessor.java @@ -25,7 +25,7 @@ *

* Arguments supported by third party code should not conflict with Ant core * ones. It is then recommended to chose specific 'enough' argument name, - * avoiding for instance one letter arguments. By the way, if there any + * avoiding for instance one letter arguments. By the way, if there is any * conflict, Ant will take precedence. * * @since 1.9 diff --git a/src/main/org/apache/tools/ant/ComponentHelper.java b/src/main/org/apache/tools/ant/ComponentHelper.java index 0011c19c88..0eeb42f84b 100644 --- a/src/main/org/apache/tools/ant/ComponentHelper.java +++ b/src/main/org/apache/tools/ant/ComponentHelper.java @@ -351,7 +351,7 @@ public void addTaskDefinition(String taskName, Class taskClass) { } /** - * Checks whether or not a class is suitable for serving as Ant task. + * Checks whether a class is suitable for serving as Ant task. * Ant task implementation classes must be public, concrete, and have * a no-arg constructor. * diff --git a/src/main/org/apache/tools/ant/DefaultLogger.java b/src/main/org/apache/tools/ant/DefaultLogger.java index af503ea215..d2ad8493df 100644 --- a/src/main/org/apache/tools/ant/DefaultLogger.java +++ b/src/main/org/apache/tools/ant/DefaultLogger.java @@ -62,7 +62,7 @@ public class DefaultLogger implements BuildLogger { protected static final String lSep = StringUtils.LINE_SEP; // CheckStyle:ConstantNameCheck ON - /** Whether or not to use emacs-style output */ + /** Whether to use emacs-style output */ protected boolean emacsMode = false; // CheckStyle:VisibilityModifier ON diff --git a/src/main/org/apache/tools/ant/DemuxOutputStream.java b/src/main/org/apache/tools/ant/DemuxOutputStream.java index 648ed358d7..a17be05912 100644 --- a/src/main/org/apache/tools/ant/DemuxOutputStream.java +++ b/src/main/org/apache/tools/ant/DemuxOutputStream.java @@ -72,7 +72,7 @@ private static class BufferInfo { private Project project; /** - * Whether or not this stream represents an error stream. + * Whether this stream represents an error stream. */ private boolean isErrorStream; @@ -83,7 +83,7 @@ private static class BufferInfo { * demultiplexed. Must not be null. * @param isErrorStream true if this is the error string, * otherwise a normal output stream. This is - * passed to the project so it knows + * passed to the project, so it knows * which stream it is receiving. */ public DemuxOutputStream(Project project, boolean isErrorStream) { diff --git a/src/main/org/apache/tools/ant/DirectoryScanner.java b/src/main/org/apache/tools/ant/DirectoryScanner.java index 045fdbfe5b..506818948f 100644 --- a/src/main/org/apache/tools/ant/DirectoryScanner.java +++ b/src/main/org/apache/tools/ant/DirectoryScanner.java @@ -295,11 +295,11 @@ public class DirectoryScanner */ protected Vector dirsDeselected; - /** Whether or not our results were built by a slow scan. */ + /** Whether our results were built by a slow scan. */ protected boolean haveSlowResults = false; /** - * Whether or not the file system should be treated as a case sensitive + * Whether the file system should be treated as a case-sensitive * one. */ protected boolean isCaseSensitive = true; @@ -311,13 +311,13 @@ public class DirectoryScanner protected boolean errorOnMissingDir = true; /** - * Whether or not symbolic links should be followed. + * Whether symbolic links should be followed. * * @since Ant 1.5 */ private boolean followSymlinks = true; - /** Whether or not everything tested so far has been included. */ + /** Whether everything tested so far has been included. */ protected boolean everythingIncluded = true; // CheckStyle:VisibilityModifier ON @@ -335,7 +335,7 @@ public class DirectoryScanner * *

Maps pattern string to TokenizedPath.

* - *

If this instance is not case sensitive, the file names get + *

If this instance is not case-sensitive, the file names get * turned to upper case.

* *

Gets lazily initialized on the first invocation of @@ -352,7 +352,7 @@ public class DirectoryScanner * *

Maps pattern string to TokenizedPath.

* - *

If this instance is not case sensitive, the file names get + *

If this instance is not case-sensitive, the file names get * turned to upper case.

* *

Gets lazily initialized on the first invocation of @@ -443,7 +443,7 @@ public class DirectoryScanner private final Set notFollowedSymlinks = new HashSet<>(); /** - * Test whether or not a given path matches the start of a given + * Test whether a given path matches the start of a given * pattern up to the first "**". *

* This is not a general purpose test and should only be used if you @@ -455,7 +455,7 @@ public class DirectoryScanner * @param str The path to match, as a String. Must not be * null. * - * @return whether or not a given path matches the start of a given + * @return whether a given path matches the start of a given * pattern up to the first "**". */ protected static boolean matchPatternStart(final String pattern, final String str) { @@ -463,7 +463,7 @@ protected static boolean matchPatternStart(final String pattern, final String st } /** - * Test whether or not a given path matches the start of a given + * Test whether a given path matches the start of a given * pattern up to the first "**". *

* This is not a general purpose test and should only be used if you @@ -474,10 +474,10 @@ protected static boolean matchPatternStart(final String pattern, final String st * null. * @param str The path to match, as a String. Must not be * null. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * - * @return whether or not a given path matches the start of a given + * @return whether a given path matches the start of a given * pattern up to the first "**". */ protected static boolean matchPatternStart(final String pattern, final String str, @@ -486,7 +486,7 @@ protected static boolean matchPatternStart(final String pattern, final String st } /** - * Test whether or not a given path matches a given pattern. + * Test whether a given path matches a given pattern. * * @param pattern The pattern to match against. Must not be * null. @@ -501,14 +501,14 @@ protected static boolean matchPath(final String pattern, final String str) { } /** - * Test whether or not a given path matches a given pattern. + * Test whether a given path matches a given pattern. * * @param pattern The pattern to match against. Must not be * null. * @param str The path to match, as a String. Must not be * null. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * * @return true if the pattern matches against the string, * or false otherwise. @@ -519,7 +519,7 @@ protected static boolean matchPath(final String pattern, final String str, } /** - * Test whether or not a string matches against a pattern. + * Test whether a string matches against a pattern. * The pattern may contain two special characters:
* '*' means zero or more characters
* '?' means one and only one character @@ -537,7 +537,7 @@ public static boolean match(final String pattern, final String str) { } /** - * Test whether or not a string matches against a pattern. + * Test whether a string matches against a pattern. * The pattern may contain two special characters:
* '*' means zero or more characters
* '?' means one and only one character @@ -546,8 +546,8 @@ public static boolean match(final String pattern, final String str) { * Must not be null. * @param str The string which must be matched against the pattern. * Must not be null. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * * * @return true if the string matches against the pattern, @@ -658,8 +658,8 @@ public synchronized File getBasedir() { /** * Find out whether include exclude patterns are matched in a - * case sensitive way. - * @return whether or not the scanning is case sensitive. + * case-sensitive way. + * @return whether the scanning is case-sensitive. * @since Ant 1.6 */ public synchronized boolean isCaseSensitive() { @@ -667,11 +667,11 @@ public synchronized boolean isCaseSensitive() { } /** - * Set whether or not include and exclude patterns are matched - * in a case sensitive way. + * Set whether include and exclude patterns are matched + * in a case-sensitive way. * - * @param isCaseSensitive whether or not the file system should be - * regarded as a case sensitive one. + * @param isCaseSensitive whether the file system should be + * regarded as a case-sensitive one. */ @Override public synchronized void setCaseSensitive(final boolean isCaseSensitive) { @@ -679,9 +679,9 @@ public synchronized void setCaseSensitive(final boolean isCaseSensitive) { } /** - * Sets whether or not a missing base directory is an error + * Sets whether a missing base directory is an error * - * @param errorOnMissingDir whether or not a missing base directory + * @param errorOnMissingDir whether a missing base directory * is an error * @since Ant 1.7.1 */ @@ -690,7 +690,7 @@ public void setErrorOnMissingDir(final boolean errorOnMissingDir) { } /** - * Get whether or not a DirectoryScanner follows symbolic links. + * Get whether a DirectoryScanner follows symbolic links. * * @return flag indicating whether symbolic links should be followed. * @@ -701,9 +701,9 @@ public synchronized boolean isFollowSymlinks() { } /** - * Set whether or not symbolic links should be followed. + * Set whether symbolic links should be followed. * - * @param followSymlinks whether or not symbolic links should be followed. + * @param followSymlinks whether symbolic links should be followed. */ public synchronized void setFollowSymlinks(final boolean followSymlinks) { this.followSymlinks = followSymlinks; @@ -819,7 +819,7 @@ public synchronized void setSelectors(final FileSelector[] selectors) { } /** - * Return whether or not the scanner has included all the files or + * Return whether the scanner has included all the files or * directories it has come across so far. * * @return true if all files and directories which have @@ -972,9 +972,9 @@ private void checkIncludePatterns() { File myfile = new File(basedir, currentelement); if (myfile.exists()) { - // may be on a case insensitive file system. We want + // may be on a case-insensitive file system. We want // the results to show what's really on the disk, so - // we need to double check. + // we need to double-check. try { final String path = (basedir == null) ? myfile.getCanonicalPath() @@ -1142,7 +1142,7 @@ private void processSlowScan(final String[] arr) { * @param vpath The path relative to the base directory (needed to * prevent problems with an absolute path when using * dir). Must not be null. - * @param fast Whether or not this call is part of a fast scan. + * @param fast Whether this call is part of a fast scan. * * @see #filesIncluded * @see #filesNotIncluded @@ -1166,7 +1166,7 @@ protected void scandir(final File dir, final String vpath, final boolean fast) { * @param path The path relative to the base directory (needed to * prevent problems with an absolute path when using * dir). Must not be null. - * @param fast Whether or not this call is part of a fast scan. + * @param fast Whether this call is part of a fast scan. * * @see #filesIncluded * @see #filesNotIncluded @@ -1344,7 +1344,7 @@ private void processIncluded(final TokenizedPath path, } /** - * Test whether or not a name matches against at least one include + * Test whether a name matches against at least one include * pattern. * * @param name The path to match. Must not be null. @@ -1356,7 +1356,7 @@ protected boolean isIncluded(final String name) { } /** - * Test whether or not a name matches against at least one include + * Test whether a name matches against at least one include * pattern. * * @param path The tokenized path to match. Must not be null. @@ -1375,7 +1375,7 @@ private boolean isIncluded(final TokenizedPath path) { } /** - * Test whether or not a name matches the start of at least one include + * Test whether a name matches the start of at least one include * pattern. * * @param name The name to match. Must not be null. @@ -1387,7 +1387,7 @@ protected boolean couldHoldIncluded(final String name) { } /** - * Test whether or not a name matches the start of at least one include + * Test whether a name matches the start of at least one include * pattern. * * @param tokenizedName The name to match. Must not be null. @@ -1401,7 +1401,7 @@ private boolean couldHoldIncluded(final TokenizedPath tokenizedName) { } /** - * Test whether or not a name matches the start of the given + * Test whether a name matches the start of the given * include pattern. * * @param tokenizedName The name to match. Must not be null. @@ -1463,7 +1463,7 @@ private boolean isMorePowerfulThanExcludes(final String name) { } /** - * Test whether or not a name matches against at least one exclude + * Test whether a name matches against at least one exclude * pattern. * * @param name The name to match. Must not be null. @@ -1475,7 +1475,7 @@ protected boolean isExcluded(final String name) { } /** - * Test whether or not a name matches against at least one exclude + * Test whether a name matches against at least one exclude * pattern. * * @param name The name to match. Must not be null. @@ -1498,7 +1498,7 @@ private boolean isExcluded(final TokenizedPath name) { * * @param name the filename to check for selecting. * @param file the java.io.File object for this filename. - * @return false when the selectors says that the file + * @return false when the selectors say that the file * should not be selected, true otherwise. */ protected boolean isSelected(final String name, final File file) { diff --git a/src/main/org/apache/tools/ant/FileScanner.java b/src/main/org/apache/tools/ant/FileScanner.java index 0afd919f41..28c5e666de 100644 --- a/src/main/org/apache/tools/ant/FileScanner.java +++ b/src/main/org/apache/tools/ant/FileScanner.java @@ -149,10 +149,10 @@ public interface FileScanner { void setIncludes(String[] includes); /** - * Sets whether or not the file system should be regarded as case sensitive. + * Sets whether the file system should be regarded as case-sensitive. * - * @param isCaseSensitive whether or not the file system should be - * regarded as a case sensitive one + * @param isCaseSensitive whether the file system should be + * regarded as a case-sensitive one */ void setCaseSensitive(boolean isCaseSensitive); } diff --git a/src/main/org/apache/tools/ant/IntrospectionHelper.java b/src/main/org/apache/tools/ant/IntrospectionHelper.java index b61a6de087..c59c789936 100644 --- a/src/main/org/apache/tools/ant/IntrospectionHelper.java +++ b/src/main/org/apache/tools/ant/IntrospectionHelper.java @@ -530,7 +530,7 @@ public void throwNotSupported(final Project project, final Object parent, final * @param parentUri URI of the parent. * @param parent the parent class * @param elementName element to work with. This can contain - * a URI,localname tuple of of the form uri:localname + * a URI,localname tuple of the form uri:localname * @param child the bit of XML to work with * @return a nested creator that can handle the child elements. * @throws BuildException if the parent does not support child elements of that name @@ -925,9 +925,9 @@ public Method getAttributeMethod(final String attributeName) throws BuildExcepti } /** - * Returns whether or not the introspected class supports PCDATA. + * Returns whether the introspected class supports PCDATA. * - * @return whether or not the introspected class supports PCDATA. + * @return whether the introspected class supports PCDATA. */ public boolean supportsCharacters() { return addText != null; @@ -1361,7 +1361,7 @@ private Creator(final Project project, final Object parent, final NestedCreator /** * Used to override the class used to create the object. * - * @param polyType a ant component type name + * @param polyType an ant component type name */ public void setPolyType(final String polyType) { this.polyType = polyType; diff --git a/src/main/org/apache/tools/ant/Main.java b/src/main/org/apache/tools/ant/Main.java index bb07cabac6..6612a7dd00 100644 --- a/src/main/org/apache/tools/ant/Main.java +++ b/src/main/org/apache/tools/ant/Main.java @@ -55,7 +55,7 @@ * command line arguments. It then assembles and executes an Ant * project. *

- * If you integrating Ant into some other tool, this is not the class + * If you are integrating Ant into some other tool, this is not the class * to use as an entry point. Please see the source code of this * class to see how it manipulates the Ant project classes. * @@ -105,7 +105,7 @@ public class Main implements AntMain { /** * The Ant logger class. There may be only one logger. It will have - * the right to use the 'out' PrintStream. The class must implements the + * the right to use the 'out' PrintStream. The class must implement the * BuildLogger interface. */ private String loggerClassname = null; @@ -117,29 +117,29 @@ public class Main implements AntMain { private String inputHandlerClassname = null; /** - * Whether or not output to the log is to be unadorned. + * Whether output to the log is to be unadorned. */ private boolean emacsMode = false; /** - * Whether or not log output should be reduced to the minimum + * Whether log output should be reduced to the minimum */ private boolean silent = false; /** - * Whether or not this instance has successfully been + * Whether this instance has successfully been * constructed and is ready to run. */ private boolean readyToRun = false; /** - * Whether or not we should only parse and display the project help + * Whether we should only parse and display the project help * information. */ private boolean projectHelp = false; /** - * Whether or not a logfile is being used. This is used to + * Whether a logfile is being used. This is used to * check if the output streams must be closed. */ private boolean isLogFileUsed = false; @@ -415,7 +415,7 @@ private void processArgs(final String[] args) { throw new BuildException(""); } } else { - // if it's no other arg, it may be the target + // if it isn't another arg, it may be the target targets.addElement(arg); } } @@ -872,7 +872,7 @@ private void setProperties(final Project project) { // this list doesn't contain the build files default target, // which may be added later unless targets have been specified - // on the command line. Therefore the property gets set again + // on the command line. Therefore, the property gets set again // in Project#executeTargets when we can be sure the list is // complete. // Setting it here allows top-level tasks to access the @@ -1066,7 +1066,7 @@ public static synchronized String getAntVersion() throws BuildException { * @return the short Ant version information as a String * (always non-null) * - * @throws BuildException BuildException if the version information is unavailable + * @throws BuildException if the version information is unavailable * @since Ant 1.9.3 */ public static String getShortAntVersion() throws BuildException { @@ -1119,7 +1119,7 @@ private static Map removeDuplicateTargets(final Mapnull. - * @param printSubTargets Whether or not subtarget names should also be + * @param printSubTargets Whether subtarget names should also be * printed. */ private static void printTargets(final Project project, boolean printSubTargets, @@ -1180,7 +1180,7 @@ private static void printTargets(final Project project, boolean printSubTargets, } /** - * Searches for the correct place to insert a name into a list so as + * Searches for the correct place to insert a name into a list * to keep the list sorted alphabetically. * * @param names The current list of names. Must not be null. @@ -1217,7 +1217,7 @@ private static int findTargetPosition(final Vector names, final String n * Should not be null. * @param maxlen The maximum length of the names of the targets. * If descriptions are given, they are padded to this - * position so they line up (so long as the names really + * position, so they line up (so long as the names really * are shorter than this). */ private static void printTargets(final Project project, final Vector names, diff --git a/src/main/org/apache/tools/ant/NoBannerLogger.java b/src/main/org/apache/tools/ant/NoBannerLogger.java index 628390d1fd..9710deaea0 100644 --- a/src/main/org/apache/tools/ant/NoBannerLogger.java +++ b/src/main/org/apache/tools/ant/NoBannerLogger.java @@ -40,7 +40,7 @@ public NoBannerLogger() { } /** - * Notes the name of the target so it can be logged + * Notes the name of the target, so it can be logged * if it generates any messages. * * @param event A BuildEvent containing target information. diff --git a/src/main/org/apache/tools/ant/PathTokenizer.java b/src/main/org/apache/tools/ant/PathTokenizer.java index 0afb42c037..fe9112c800 100644 --- a/src/main/org/apache/tools/ant/PathTokenizer.java +++ b/src/main/org/apache/tools/ant/PathTokenizer.java @@ -51,7 +51,7 @@ public class PathTokenizer { private boolean onNetWare = Os.isFamily("netware"); /** - * Flag to indicate whether or not we are running on a platform with a + * Flag to indicate whether we are running on a platform with a * DOS style filesystem */ private boolean dosStyleFilesystem; diff --git a/src/main/org/apache/tools/ant/Project.java b/src/main/org/apache/tools/ant/Project.java index 2cd2ba9c5a..35a3996ba7 100644 --- a/src/main/org/apache/tools/ant/Project.java +++ b/src/main/org/apache/tools/ant/Project.java @@ -263,7 +263,7 @@ public Project() { } /** - * Create and initialize a subproject. By default the subproject will be of + * Create and initialize a subproject. By default, the subproject will be of * the same type as its parent. If a no-arg constructor is unavailable, the * Project class will be used. * @return a Project instance configured as a subproject of this Project. @@ -308,7 +308,7 @@ public void init() throws BuildException { /** * Initializes the properties. - * @exception BuildException if an vital property could not be set. + * @exception BuildException if a vital property could not be set. * @since Ant 1.7 */ public void initProperties() throws BuildException { @@ -837,7 +837,7 @@ public Hashtable getFilters() { * @param baseD The project base directory. * Must not be null. * - * @exception BuildException if the directory if invalid. + * @exception BuildException if the directory is invalid. */ public void setBasedir(final String baseD) throws BuildException { setBaseDir(new File(baseD)); @@ -986,7 +986,7 @@ public void addTaskDefinition(final String taskName, final Class taskClass) } /** - * Check whether or not a class is suitable for serving as Ant task. + * Check whether a class is suitable for serving as Ant task. * Ant task implementation classes must be public, concrete, and have * a no-arg constructor. * @@ -1270,7 +1270,7 @@ public void executeTargets(final Vector names) throws BuildException { * the message is logged directly. * * @param output Message to handle. Should not be null. - * @param isWarning Whether the text represents an warning (true) + * @param isWarning Whether the text represents a warning (true) * or information (false). */ public void demuxOutput(final String output, final boolean isWarning) { @@ -1529,7 +1529,7 @@ public void copyFile(final String sourceFile, final String destFile) * Must not be null. * @param destFile Name of file to copy to. * Must not be null. - * @param filtering Whether or not token filtering should be used during + * @param filtering Whether token filtering should be used during * the copy. * * @exception IOException if the copying fails. @@ -1552,9 +1552,9 @@ public void copyFile(final String sourceFile, final String destFile, final boole * Must not be null. * @param destFile Name of file to copy to. * Must not be null. - * @param filtering Whether or not token filtering should be used during + * @param filtering Whether token filtering should be used during * the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. * * @exception IOException if the copying fails. @@ -1579,11 +1579,11 @@ public void copyFile(final String sourceFile, final String destFile, final boole * Must not be null. * @param destFile Name of file to copy to. * Must not be null. - * @param filtering Whether or not token filtering should be used during + * @param filtering Whether token filtering should be used during * the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @@ -1625,7 +1625,7 @@ public void copyFile(final File sourceFile, final File destFile) throws IOExcept * Must not be null. * @param destFile File to copy to. * Must not be null. - * @param filtering Whether or not token filtering should be used during + * @param filtering Whether token filtering should be used during * the copy. * * @exception IOException if the copying fails. @@ -1648,9 +1648,9 @@ public void copyFile(final File sourceFile, final File destFile, final boolean f * Must not be null. * @param destFile File to copy to. * Must not be null. - * @param filtering Whether or not token filtering should be used during + * @param filtering Whether token filtering should be used during * the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. * * @exception IOException if the file cannot be copied. @@ -1675,11 +1675,11 @@ public void copyFile(final File sourceFile, final File destFile, final boolean f * Must not be null. * @param destFile File to copy to. * Must not be null. - * @param filtering Whether or not token filtering should be used during + * @param filtering Whether token filtering should be used during * the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @@ -1971,7 +1971,7 @@ public void inheritIDReferences(final Project parent) { * Add an id reference. * Used for broken build files. * @param id the id to set. - * @param value the value to set it to (Unknown element in this case. + * @param value the value to set it to (Unknown element in this case). */ public void addIdReference(final String id, final Object value) { idReferences.put(id, value); diff --git a/src/main/org/apache/tools/ant/ProjectHelper.java b/src/main/org/apache/tools/ant/ProjectHelper.java index 5cc7527dac..1bdceb98c5 100644 --- a/src/main/org/apache/tools/ant/ProjectHelper.java +++ b/src/main/org/apache/tools/ant/ProjectHelper.java @@ -278,7 +278,7 @@ public static void setInIncludeMode(boolean includeMode) { * Must not be null. * @param source The source for XML configuration. A helper must support * at least File, for backward compatibility. Helpers may - * support URL, InputStream, etc or specialized types. + * support URL, InputStream, etc. or specialized types. * * @since Ant1.5 * @exception BuildException if the configuration is invalid or cannot @@ -292,7 +292,7 @@ public void parse(Project project, Object source) throws BuildException { /** * Get the first project helper found in the classpath * - * @return an project helper, never null + * @return a project helper, never null * @see org.apache.tools.ant.ProjectHelperRepository#getHelpers() */ public static ProjectHelper getProjectHelper() { diff --git a/src/main/org/apache/tools/ant/ProjectHelperRepository.java b/src/main/org/apache/tools/ant/ProjectHelperRepository.java index 8bee97f91d..680f39398c 100644 --- a/src/main/org/apache/tools/ant/ProjectHelperRepository.java +++ b/src/main/org/apache/tools/ant/ProjectHelperRepository.java @@ -200,7 +200,7 @@ private Constructor getProjectHelperByService(InputStre } /** - * Get the constructor with not argument of an helper from its class name. + * Get the constructor with not argument of a helper from its class name. * It'll first try the thread class loader, then Class.forName() will load * from the same loader that loaded this class. * diff --git a/src/main/org/apache/tools/ant/PropertyHelper.java b/src/main/org/apache/tools/ant/PropertyHelper.java index 99d1a29ae5..105528c50a 100644 --- a/src/main/org/apache/tools/ant/PropertyHelper.java +++ b/src/main/org/apache/tools/ant/PropertyHelper.java @@ -432,7 +432,7 @@ public Collection getExpanders() { * inside of Ant itself.

* * @param ns The namespace that the property is in (currently - * not used. + * not used). * @param name The name of property to set. * Must not be null. * @param value The new value of the property. @@ -572,7 +572,7 @@ public String replaceProperties(String value) throws BuildException { /** * Decode properties from a String representation. If the entire * contents of the String resolve to a single property, that value - * is returned. Otherwise a String is returned. + * is returned. Otherwise, a String is returned. * * @param value The string to be scanned for property references. * May be null, in which case this @@ -1064,7 +1064,7 @@ static void parsePropertyStringDefault(String value, Vector fragments, V prev = pos + 1; } else if (value.charAt(pos + 1) != '{') { //peek ahead to see if the next char is a property or not - //not a property: insert the char as a literal + //a property: insert the char as a literal /* fragments.addElement(value.substring(pos + 1, pos + 2)); prev = pos + 2; diff --git a/src/main/org/apache/tools/ant/Target.java b/src/main/org/apache/tools/ant/Target.java index af8bfad345..95d47a3efb 100644 --- a/src/main/org/apache/tools/ant/Target.java +++ b/src/main/org/apache/tools/ant/Target.java @@ -166,7 +166,7 @@ public static List parseDepends(String depends, list.add(token); // Make sure that depends attribute does not - // end in a , + // end in a "," if (tok.hasMoreTokens()) { token = tok.nextToken(); if (!tok.hasMoreTokens() || !",".equals(token)) { diff --git a/src/main/org/apache/tools/ant/Task.java b/src/main/org/apache/tools/ant/Task.java index ed22c0a342..6411b597de 100644 --- a/src/main/org/apache/tools/ant/Task.java +++ b/src/main/org/apache/tools/ant/Task.java @@ -79,7 +79,7 @@ public abstract class Task extends ProjectComponent { // CheckStyle:VisibilityModifier ON /** - * Whether or not this task is invalid. A task becomes invalid + * Whether this task is invalid. A task becomes invalid * if a conflicting class is specified as the implementation for * its type. */ diff --git a/src/main/org/apache/tools/ant/TaskAdapter.java b/src/main/org/apache/tools/ant/TaskAdapter.java index 77d8688aba..ecf0beb390 100644 --- a/src/main/org/apache/tools/ant/TaskAdapter.java +++ b/src/main/org/apache/tools/ant/TaskAdapter.java @@ -55,7 +55,7 @@ public TaskAdapter(Object proxy) { } /** - * Checks whether or not a class is suitable to be adapted by TaskAdapter. + * Checks whether a class is suitable to be adapted by TaskAdapter. * If the class is of type Dispatchable, the check is not performed because * the method that will be executed will be determined only at runtime of * the actual task and not during parse time. diff --git a/src/main/org/apache/tools/ant/UnsupportedElementException.java b/src/main/org/apache/tools/ant/UnsupportedElementException.java index 03548927cd..a457e69a6a 100644 --- a/src/main/org/apache/tools/ant/UnsupportedElementException.java +++ b/src/main/org/apache/tools/ant/UnsupportedElementException.java @@ -20,11 +20,11 @@ /** * Used to report attempts to set an unsupported element * When the attempt to set the element is made, - * the code does not not know the name of the task/type + * the code does not know the name of the task/type * based on a mapping from the classname to the task/type. - * However one class may be used by a lot of task/types. + * However, one class may be used by a lot of task/types. * This exception may be caught by code that does know - * the task/type and it will reset the message to the + * the task/type, and it will reset the message to the * correct message. * This will be done once (in the case of a recursive * call to handlechildren). diff --git a/src/main/org/apache/tools/ant/antlib.xml b/src/main/org/apache/tools/ant/antlib.xml index 68bdab0972..5e6841ec40 100644 --- a/src/main/org/apache/tools/ant/antlib.xml +++ b/src/main/org/apache/tools/ant/antlib.xml @@ -21,14 +21,14 @@ diff --git a/src/main/org/apache/tools/ant/filters/BaseFilterReader.java b/src/main/org/apache/tools/ant/filters/BaseFilterReader.java index bc97d1bbb3..6a375b9f18 100644 --- a/src/main/org/apache/tools/ant/filters/BaseFilterReader.java +++ b/src/main/org/apache/tools/ant/filters/BaseFilterReader.java @@ -122,7 +122,7 @@ public final long skip(final long n) /** * Sets the initialized status. * - * @param initialized Whether or not the filter is initialized. + * @param initialized Whether the filter is initialized. */ protected final void setInitialized(final boolean initialized) { this.initialized = initialized; @@ -131,7 +131,7 @@ protected final void setInitialized(final boolean initialized) { /** * Returns the initialized status. * - * @return whether or not the filter is initialized + * @return whether the filter is initialized */ protected final boolean getInitialized() { return initialized; diff --git a/src/main/org/apache/tools/ant/filters/ConcatFilter.java b/src/main/org/apache/tools/ant/filters/ConcatFilter.java index 65bbfdc056..a169714547 100644 --- a/src/main/org/apache/tools/ant/filters/ConcatFilter.java +++ b/src/main/org/apache/tools/ant/filters/ConcatFilter.java @@ -105,7 +105,7 @@ public int read() throws IOException { if (prependReader != null) { ch = prependReader.read(); if (ch == -1) { - // I am the only one so I have to close the reader + // I am the only one, so I have to close the reader prependReader.close(); prependReader = null; } @@ -119,7 +119,7 @@ public int read() throws IOException { if (appendReader != null) { ch = appendReader.read(); if (ch == -1) { - // I am the only one so I have to close the reader + // I am the only one, so I have to close the reader appendReader.close(); appendReader = null; } diff --git a/src/main/org/apache/tools/ant/filters/ExpandProperties.java b/src/main/org/apache/tools/ant/filters/ExpandProperties.java index 750681b5fb..66fd8c667f 100644 --- a/src/main/org/apache/tools/ant/filters/ExpandProperties.java +++ b/src/main/org/apache/tools/ant/filters/ExpandProperties.java @@ -79,7 +79,7 @@ public void add(PropertySet propertySet) { /** * Returns the next character in the filtered stream. The original * stream is first read in fully, and the Ant properties are expanded. - * The results of this expansion are then queued so they can be read + * The results of this expansion are then queued, so they can be read * character-by-character. * * @return the next character in the resulting stream, or -1 diff --git a/src/main/org/apache/tools/ant/filters/LineContains.java b/src/main/org/apache/tools/ant/filters/LineContains.java index cb2ffe17f0..56ca8a621d 100644 --- a/src/main/org/apache/tools/ant/filters/LineContains.java +++ b/src/main/org/apache/tools/ant/filters/LineContains.java @@ -103,7 +103,7 @@ public LineContains(final Reader in) { /** * Returns the next character in the filtered stream, only including - * lines from the original stream which contain all of the specified words. + * lines from the original stream which contain all the specified words. * * @return the next character in the resulting stream, or -1 * if the end of the resulting stream has been reached diff --git a/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java b/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java index 1312ff3ae1..7bb954185f 100644 --- a/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java +++ b/src/main/org/apache/tools/ant/filters/LineContainsRegExp.java @@ -91,7 +91,7 @@ public LineContainsRegExp(final Reader in) { /** * Returns the next character in the filtered stream, only including - * lines from the original stream which match all of the specified + * lines from the original stream which match all the specified * regular expressions. * * @return the next character in the resulting stream, or -1 @@ -200,7 +200,7 @@ public void setNegate(boolean b) { } /** - * Whether to match casesensitively. + * Whether to match case-sensitively. * @param b boolean * @since Ant 1.8.2 */ diff --git a/src/main/org/apache/tools/ant/filters/SortFilter.java b/src/main/org/apache/tools/ant/filters/SortFilter.java index 1478db3e32..88972a7cde 100644 --- a/src/main/org/apache/tools/ant/filters/SortFilter.java +++ b/src/main/org/apache/tools/ant/filters/SortFilter.java @@ -139,7 +139,7 @@ public final class SortFilter extends BaseParamFilterReader /** * Controls if the sorting process will be in ascendant/descendant order. If - * If has value true, then the line of the file will be + * it has value true, then the line of the file will be * sorted on descendant order. Default value: false. It will * be considered only if comparator is null. */ diff --git a/src/main/org/apache/tools/ant/filters/StringInputStream.java b/src/main/org/apache/tools/ant/filters/StringInputStream.java index 106c850c2d..9a3023c9b9 100644 --- a/src/main/org/apache/tools/ant/filters/StringInputStream.java +++ b/src/main/org/apache/tools/ant/filters/StringInputStream.java @@ -40,7 +40,7 @@ public StringInputStream(String source) { * Composes a stream from a String with the specified encoding * * @param source The string to read from. Must not be null. - * @param encoding The encoding scheme. Also must not be null. + * @param encoding The encoding scheme. Also, must not be null. */ public StringInputStream(String source, String encoding) { super(new StringReader(source), encoding); diff --git a/src/main/org/apache/tools/ant/filters/StripJavaComments.java b/src/main/org/apache/tools/ant/filters/StripJavaComments.java index 62c4624c2c..0216671d96 100644 --- a/src/main/org/apache/tools/ant/filters/StripJavaComments.java +++ b/src/main/org/apache/tools/ant/filters/StripJavaComments.java @@ -40,13 +40,13 @@ public final class StripJavaComments private int readAheadCh = -1; /** - * Whether or not the parser is currently in the middle of a string + * Whether the parser is currently in the middle of a string * literal. */ private boolean inString = false; /** - * Whether or not the last char has been a backslash. + * Whether the last char has been a backslash. */ private boolean quoted = false; diff --git a/src/main/org/apache/tools/ant/filters/TailFilter.java b/src/main/org/apache/tools/ant/filters/TailFilter.java index d50a473eb0..979097fa4a 100644 --- a/src/main/org/apache/tools/ant/filters/TailFilter.java +++ b/src/main/org/apache/tools/ant/filters/TailFilter.java @@ -55,7 +55,7 @@ public final class TailFilter extends BaseParamFilterReader /** Number of lines to be skipped. */ private long skip = 0; - /** Whether or not read-ahead been completed. */ + /** Whether read-ahead been completed. */ private boolean completedReadAhead = false; /** A line tokenizer */ diff --git a/src/main/org/apache/tools/ant/filters/TokenFilter.java b/src/main/org/apache/tools/ant/filters/TokenFilter.java index 67c9283df4..cf15619b6f 100644 --- a/src/main/org/apache/tools/ant/filters/TokenFilter.java +++ b/src/main/org/apache/tools/ant/filters/TokenFilter.java @@ -90,7 +90,7 @@ public TokenFilter(final Reader in) { /** * Returns the next character in the filtered stream, only including - * lines from the original stream which match all of the specified + * lines from the original stream which match all the specified * regular expressions. * * @return the next character in the resulting stream, or -1 diff --git a/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java b/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java index 99ec773c80..de23b7d8ba 100644 --- a/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java +++ b/src/main/org/apache/tools/ant/filters/util/ChainReaderHelper.java @@ -348,7 +348,7 @@ private Reader expandReader(final AntFilterReader filter, } } // Ant 1.7.1 and earlier ignore without a - // classname attribute, not sure this is a good idea - + // classname attribute, not sure whether this is a good idea - // backwards compatibility makes it hard to change, though. return ancestor; } diff --git a/src/main/org/apache/tools/ant/filters/util/JavaClassHelper.java b/src/main/org/apache/tools/ant/filters/util/JavaClassHelper.java index a98678c98f..d8d02304a1 100644 --- a/src/main/org/apache/tools/ant/filters/util/JavaClassHelper.java +++ b/src/main/org/apache/tools/ant/filters/util/JavaClassHelper.java @@ -33,7 +33,7 @@ public final class JavaClassHelper { /** * Get the constants declared in a file as name=value * - * @param bytes the class as a array of bytes + * @param bytes the class as an array of bytes * @return a StringBuffer contains the name=value pairs * @exception IOException if an error occurs */ diff --git a/src/main/org/apache/tools/ant/helper/ProjectHelper2.java b/src/main/org/apache/tools/ant/helper/ProjectHelper2.java index f5785b1377..b258543f30 100644 --- a/src/main/org/apache/tools/ant/helper/ProjectHelper2.java +++ b/src/main/org/apache/tools/ant/helper/ProjectHelper2.java @@ -427,7 +427,7 @@ public AntHandler onStartChild(String uri, String tag, String qname, Attributes } /** - * Handle the end of a element. + * Handle the end of an element. * * @param uri the namespace uri of the element * @param tag the tag of the element @@ -984,7 +984,7 @@ public void onStartElement(String uri, String tag, String qname, Attributes attr } Hashtable projectTargets = project.getTargets(); boolean usedTarget = false; - // If the name has not already been defined define it + // If the name has not already been defined, define it if (projectTargets.containsKey(name)) { project.log("Already defined in main or a previous import, ignore " + name, Project.MSG_VERBOSE); diff --git a/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java b/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java index 8bf889a5a9..4509739391 100644 --- a/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java +++ b/src/main/org/apache/tools/ant/helper/ProjectHelperImpl.java @@ -681,7 +681,7 @@ static class TaskHandler extends AbstractHandler { /** * Wrapper for this element which takes care of actually configuring * the element, if this element is contained within a target. - * Otherwise the configuration is performed with the configure method. + * Otherwise, the configuration is performed with the configure method. * @see ProjectHelper#configure(Object,AttributeList,Project) */ private RuntimeConfigurable wrapper = null; @@ -808,7 +808,7 @@ static class NestedElementHandler extends AbstractHandler { /** * Wrapper for this element which takes care of actually configuring * the element, if a parent wrapper is provided. - * Otherwise the configuration is performed with the configure method. + * Otherwise, the configuration is performed with the configure method. * @see ProjectHelper#configure(Object,AttributeList,Project) */ private RuntimeConfigurable childWrapper = null; diff --git a/src/main/org/apache/tools/ant/launch/Locator.java b/src/main/org/apache/tools/ant/launch/Locator.java index 9f616b5d13..cddd6125ef 100644 --- a/src/main/org/apache/tools/ant/launch/Locator.java +++ b/src/main/org/apache/tools/ant/launch/Locator.java @@ -33,7 +33,7 @@ * The Locator is a utility class which is used to find certain items * in the environment. *

- * 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 other Ant's classes. *

* This is a surprisingly brittle piece of code, and has had lots of bugs filed against it: * running ant off a network share can cause Ant to fail, @@ -223,7 +223,7 @@ public static String fromJarURI(String uri) { } /** - * Decodes an Uri with % characters. + * Decodes a Uri with % characters. * The URI is escaped * @param uri String with the uri possibly containing % characters. * @return The decoded Uri @@ -259,7 +259,7 @@ public static String decodeUri(String uri) throws UnsupportedEncodingException { } /** - * Encodes an Uri with % characters. + * Encodes a Uri with % characters. * The URI is escaped * @param path String to encode. * @return The encoded string, according to URI norms @@ -386,7 +386,7 @@ public static File getToolsJar() { } /** - * Get an array of URLs representing all of the jar files in the + * Get an array of URLs representing all the jar files in the * given location. If the location is a file, it is returned as the only * element of the array. If the location is a directory, it is scanned for * jar files. @@ -404,7 +404,7 @@ public static URL[] getLocationURLs(File location) } /** - * Get an array of URLs representing all of the files of a given set of + * Get an array of URLs representing all the files of a given set of * extensions in the given location. If the location is a file, it is * returned as the only element of the array. If the location is a * directory, it is scanned for matching files. diff --git a/src/main/org/apache/tools/ant/listener/BigProjectLogger.java b/src/main/org/apache/tools/ant/listener/BigProjectLogger.java index 952a67db59..339093c4f7 100644 --- a/src/main/org/apache/tools/ant/listener/BigProjectLogger.java +++ b/src/main/org/apache/tools/ant/listener/BigProjectLogger.java @@ -168,7 +168,7 @@ protected String getFooter() { } private void maybeRaiseSubBuildStarted(BuildEvent event) { - // double checked locking should be OK since the flag is write-once + // double-checked locking should be OK since the flag is write-once if (!subBuildStartedRaised) { synchronized (subBuildLock) { if (!subBuildStartedRaised) { diff --git a/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java b/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java index f813eba0e3..dead915ff7 100644 --- a/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java +++ b/src/main/org/apache/tools/ant/listener/CommonsLoggingListener.java @@ -299,7 +299,7 @@ private void realLog(final Log log, final String message, final int priority, fi // CheckStyle:VisibilityModifier ON /** - * Set the the output level. + * Set the output level. * This is not used, the logger config is used instead. * @param level ignored */ diff --git a/src/main/org/apache/tools/ant/listener/Log4jListener.java b/src/main/org/apache/tools/ant/listener/Log4jListener.java index 169fdf569c..593266db9c 100644 --- a/src/main/org/apache/tools/ant/listener/Log4jListener.java +++ b/src/main/org/apache/tools/ant/listener/Log4jListener.java @@ -28,7 +28,7 @@ /** * Listener which sends events to Log4j logging system. - * @deprecated Apache Log4j (1) is not developed any more. Last + * @deprecated Apache Log4j (1) is not developed anymore. Last * release is 1.2.17 from 26-May-2012 and contains vulnerability issues. * Use the standard listener or your own custom listener instead. */ diff --git a/src/main/org/apache/tools/ant/loader/AntClassLoader5.java b/src/main/org/apache/tools/ant/loader/AntClassLoader5.java index 0cc8df7984..95bb05e217 100644 --- a/src/main/org/apache/tools/ant/loader/AntClassLoader5.java +++ b/src/main/org/apache/tools/ant/loader/AntClassLoader5.java @@ -45,7 +45,7 @@ public class AntClassLoader5 extends AntClassLoader { * elements are set up to start with. * @param parentFirst If true, indicates that the parent * classloader should be consulted before trying to - * load the a class through this loader. + * load the class through this loader. */ public AntClassLoader5(ClassLoader parent, Project project, Path classpath, boolean parentFirst) { diff --git a/src/main/org/apache/tools/ant/property/ResolvePropertyMap.java b/src/main/org/apache/tools/ant/property/ResolvePropertyMap.java index a65cbf85ca..d2f9d6024a 100644 --- a/src/main/org/apache/tools/ant/property/ResolvePropertyMap.java +++ b/src/main/org/apache/tools/ant/property/ResolvePropertyMap.java @@ -72,7 +72,7 @@ public Object getProperty(String name) { // or we've been asked to prefix the value side (later // recursive calls via the GetProperty interface) the // prefix must be prepended when looking up the property - // outside of the map. + // outside the map. String fullKey = name; if (prefix != null && (expandingLHS || prefixValues)) { fullKey = prefix + name; @@ -80,7 +80,7 @@ public Object getProperty(String name) { Object masterValue = master.getProperty(fullKey); if (masterValue != null) { - // If the property already has a value outside of the + // If the property already has a value outside the // map, use that value to enforce property // immutability. @@ -92,7 +92,7 @@ public Object getProperty(String name) { String recursiveCallKey = name; if (prefix != null && !expandingLHS && !prefixValues) { // only look up nonprefixed properties inside the map - // if prefixValues is true or we are expanding the key + // if prefixValues is true, or we are expanding the key // itself recursiveCallKey = prefix + name; } diff --git a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java index 4dc2a77513..de3f5dba85 100644 --- a/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/AbstractCvsTask.java @@ -53,7 +53,7 @@ public abstract class AbstractCvsTask extends Task { * setCompression(true). */ public static final int DEFAULT_COMPRESSION_LEVEL = 3; - private static final int MAXIMUM_COMRESSION_LEVEL = 9; + private static final int MAXIMUM_COMPRESSION_LEVEL = 9; private Commandline cmd = new Commandline(); @@ -128,7 +128,7 @@ public abstract class AbstractCvsTask extends Task { private File dest; /** - * whether or not to append stdout/stderr to existing files + * whether to append stdout/stderr to existing files */ private boolean append = false; @@ -285,7 +285,7 @@ protected void runCommand(Commandline toExecute) throws BuildException { } /** - * Need a better cross platform integration with , so + * Need a better cross-platform integration with , so * use the same filename. */ if (passFile == null) { @@ -749,7 +749,7 @@ protected void configureCommandline(Commandline c) { c.createArgument().setValue(m.getName()); } if (this.compression > 0 - && this.compression <= MAXIMUM_COMRESSION_LEVEL) { + && this.compression <= MAXIMUM_COMPRESSION_LEVEL) { c.createArgument(true).setValue("-z" + this.compression); } if (quiet && !reallyquiet) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Ant.java b/src/main/org/apache/tools/ant/taskdefs/Ant.java index 2472ea5ce3..c6e5083434 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Ant.java +++ b/src/main/org/apache/tools/ant/taskdefs/Ant.java @@ -239,7 +239,7 @@ private void initializeProject() { /** * Handles output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param outputToHandle The string output to output. * @see Task#handleOutput(String) @@ -279,7 +279,7 @@ public int handleInput(byte[] buffer, int offset, int length) /** * Handles output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param toFlush The string to output. * @see Task#handleFlush(String) @@ -296,7 +296,7 @@ public void handleFlush(String toFlush) { /** * Handle error output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param errorOutputToHandle The string to output. * @@ -314,7 +314,7 @@ public void handleErrorOutput(String errorOutputToHandle) { /** * Handle error output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param errorOutputToFlush The string to output. * @see Task#handleErrorFlush(String) @@ -462,7 +462,7 @@ && getOwningTarget() != null) { /** * Get the default build file name to use when launching the task. *

- * This function may be overridden by providers of custom ProjectHelper so they can easily + * This function may be overridden by providers of custom ProjectHelper, so they can easily * implement their sublauncher. * * @return the name of the default file diff --git a/src/main/org/apache/tools/ant/taskdefs/Available.java b/src/main/org/apache/tools/ant/taskdefs/Available.java index ecd45b6ae7..c42eafb74b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Available.java +++ b/src/main/org/apache/tools/ant/taskdefs/Available.java @@ -59,7 +59,7 @@ public class Available extends Task implements Condition { /** * Set the searchParents attribute. - * This controls the behaviour of the the "file" type. + * This controls the behaviour of the "file" type. * If true, the path, parent path and grandparent path are * searched for the file. If false, only the path is searched. * The default value is false. diff --git a/src/main/org/apache/tools/ant/taskdefs/Basename.java b/src/main/org/apache/tools/ant/taskdefs/Basename.java index 7b6d4342c4..7f42803b28 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Basename.java +++ b/src/main/org/apache/tools/ant/taskdefs/Basename.java @@ -35,7 +35,7 @@ * * The file and property attributes are required. The * suffix attribute can be specified either with or without - * the ".", and the result will be the same (ie., the + * the ".", and the result will be the same (i.e., the * returned file name will be minus the .suffix). *

* When this task executes, it will set the specified property to the @@ -102,7 +102,7 @@ private String removeExtension(String s, String ext) { return s; } int clipFrom = s.length() - ext.length(); - // if the suffix does not starts with a '.' and the + // if the suffix does not start with a '.' and the // char preceding the suffix is a '.', we assume the user // wants to remove the '.' as well (see docs) if (ext.charAt(0) != '.' && clipFrom > 0 && s.charAt(clipFrom - 1) == '.') { diff --git a/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java b/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java index ce61ae2f88..3fc2972e72 100644 --- a/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java +++ b/src/main/org/apache/tools/ant/taskdefs/BuildNumber.java @@ -90,7 +90,7 @@ public void execute() throws BuildException { myFile = savedFile; } - //Finally set the property + // Finally, set the property getProject().setNewProperty(DEFAULT_PROPERTY_NAME, String.valueOf(buildNumber)); } diff --git a/src/main/org/apache/tools/ant/taskdefs/CVSPass.java b/src/main/org/apache/tools/ant/taskdefs/CVSPass.java index 5c58e03f3d..ae656108ac 100644 --- a/src/main/org/apache/tools/ant/taskdefs/CVSPass.java +++ b/src/main/org/apache/tools/ant/taskdefs/CVSPass.java @@ -31,7 +31,7 @@ import org.apache.tools.ant.util.FileUtils; /** - * Adds an new entry to a CVS password file. + * Adds a new entry to a CVS password file. * * * @since Ant 1.4 diff --git a/src/main/org/apache/tools/ant/taskdefs/CallTarget.java b/src/main/org/apache/tools/ant/taskdefs/CallTarget.java index 017490d8cd..8e8bb3c1f3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/CallTarget.java +++ b/src/main/org/apache/tools/ant/taskdefs/CallTarget.java @@ -169,7 +169,7 @@ public void addConfiguredTarget(Ant.TargetElement t) { /** * Handles output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param output The string output to output. * @see Task#handleOutput(String) @@ -207,7 +207,7 @@ public int handleInput(byte[] buffer, int offset, int length) /** * Handles output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param output The string to output. * @see Task#handleFlush(String) @@ -223,7 +223,7 @@ public void handleFlush(String output) { /** * Handle error output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param output The string to output. * @@ -240,7 +240,7 @@ public void handleErrorOutput(String output) { /** * Handle error output. - * Send it the the new project if is present, otherwise + * Send it the new project if is present, otherwise * call the super class. * @param output The string to output. * @see Task#handleErrorFlush(String) diff --git a/src/main/org/apache/tools/ant/taskdefs/Checksum.java b/src/main/org/apache/tools/ant/taskdefs/Checksum.java index a1b78aa812..be8df73237 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Checksum.java +++ b/src/main/org/apache/tools/ant/taskdefs/Checksum.java @@ -97,7 +97,7 @@ public void add(ResourceCollection rc) { */ private String provider = null; /** - * File Extension that is be to used to create or identify + * File Extension that will be used to create or identify * destination file */ private String fileext; @@ -123,7 +123,7 @@ public void add(ResourceCollection rc) { */ private String totalproperty; /** - * Whether or not to create a new file. + * Whether to create a new file. * Defaults to false. */ private boolean forceOverwrite; @@ -194,7 +194,7 @@ public void setProvider(String provider) { } /** - * Sets the file extension that is be to used to + * Sets the file extension that will be used to * create or identify destination file. * @param fileext a String value */ @@ -231,7 +231,7 @@ public void setVerifyproperty(String verifyProperty) { } /** - * Whether or not to overwrite existing file irrespective of + * Whether to overwrite existing file irrespective of * whether it is newer than * the source file. Defaults to false. * @param forceOverwrite a boolean value @@ -249,7 +249,7 @@ public void setReadBufferSize(int size) { } /** - * Select the in/output pattern via a well know format name. + * Select the in/output pattern via a well-known format name. * @param e an enumerated value * * @since 1.7.0 diff --git a/src/main/org/apache/tools/ant/taskdefs/Chmod.java b/src/main/org/apache/tools/ant/taskdefs/Chmod.java index 53c232ed6c..a3bf0e9f49 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Chmod.java +++ b/src/main/org/apache/tools/ant/taskdefs/Chmod.java @@ -177,7 +177,7 @@ protected void checkConfiguration() { public void execute() throws BuildException { /* * In Ant 1.1, means, change the permissions - * of directory foo, not anything inside of it. This is the case the + * of directory foo, not anything inside it. This is the case the * second branch of the if statement below catches for backwards * compatibility. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/Classloader.java b/src/main/org/apache/tools/ant/taskdefs/Classloader.java index a1a2f15d30..53581d9693 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Classloader.java +++ b/src/main/org/apache/tools/ant/taskdefs/Classloader.java @@ -34,7 +34,7 @@ * Create or modifies ClassLoader. The required pathRef parameter * will be used to add classpath elements. * - * The classpath is a regular path. Currently only file components are + * The classpath is a regular path. Currently, only file components are * supported (future extensions may allow URLs). * * You can modify the core loader by not specifying any name or using @@ -169,8 +169,8 @@ public void execute() { Object obj = getProject().getReference(loaderName); if (reset) { - // Are any other references held ? Can we 'close' the loader - // so it removes the locks on jars ? + // Are any other references held? Can we 'close' the loader, + // so it removes the locks on jars? obj = null; // a new one will be created. } diff --git a/src/main/org/apache/tools/ant/taskdefs/CloseResources.java b/src/main/org/apache/tools/ant/taskdefs/CloseResources.java index 1aac2ee4c8..771b1c1c2f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/CloseResources.java +++ b/src/main/org/apache/tools/ant/taskdefs/CloseResources.java @@ -31,7 +31,7 @@ /** * Not a real task but used during tests. * - * Closes the resources associated with an URL. In particular this is + * Closes the resources associated with a URL. In particular this is * going to close the jars associated with a jar:file: URL - and it * does so in a way that the Java VM still thinks it is open, so use * it at your own risk. diff --git a/src/main/org/apache/tools/ant/taskdefs/Concat.java b/src/main/org/apache/tools/ant/taskdefs/Concat.java index 09127a9600..688c05175d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Concat.java +++ b/src/main/org/apache/tools/ant/taskdefs/Concat.java @@ -517,7 +517,7 @@ public String getName() { private Resource dest; /** - * Whether or not the stream should be appended if the destination file + * Whether the stream should be appended if the destination file * exists. * Defaults to false. */ @@ -941,7 +941,7 @@ private void validate() { // treat empty nested text as no text sanitizeText(); - // if binary check if incompatible attributes are used + // if binary, check if incompatible attributes are used if (binary) { if (textBuffer != null) { throw new BuildException( diff --git a/src/main/org/apache/tools/ant/taskdefs/Copy.java b/src/main/org/apache/tools/ant/taskdefs/Copy.java index 4851bacd7b..510006308a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Copy.java +++ b/src/main/org/apache/tools/ant/taskdefs/Copy.java @@ -295,7 +295,7 @@ public void setIncludeEmptyDirs(final boolean includeEmpty) { * copied does not exist. * * @param quiet - * whether or not to display error messages when a file or + * whether to display error messages when a file or * directory does not exist. Default is false. */ public void setQuiet(final boolean quiet) { diff --git a/src/main/org/apache/tools/ant/taskdefs/DefBase.java b/src/main/org/apache/tools/ant/taskdefs/DefBase.java index d694060046..081cbcce51 100644 --- a/src/main/org/apache/tools/ant/taskdefs/DefBase.java +++ b/src/main/org/apache/tools/ant/taskdefs/DefBase.java @@ -37,8 +37,8 @@ public abstract class DefBase extends AntlibDefinition { private ClasspathUtils.Delegate cpDelegate; /** - * Check if classpath attributes have been set. - * (to be called before getCpDelegate() is used. + * Check if classpath attributes have been set + * to be called before getCpDelegate() is used. * @return true if cpDelegate has been created. */ protected boolean hasCpDelegate() { @@ -101,7 +101,7 @@ public void setClasspath(Path classpath) { /** * Create the classpath to be used when searching for component being * defined. - * @return the classpath of the this definition + * @return the classpath of this definition */ public Path createClasspath() { return getDelegate().createClasspath(); diff --git a/src/main/org/apache/tools/ant/taskdefs/DefaultExcludes.java b/src/main/org/apache/tools/ant/taskdefs/DefaultExcludes.java index 3f129438f4..2e8f4b9b9d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/DefaultExcludes.java +++ b/src/main/org/apache/tools/ant/taskdefs/DefaultExcludes.java @@ -27,7 +27,7 @@ import java.util.stream.Collectors; /** - * Alters the default excludes for the entire build.. + * Alters the default excludes for the entire build. * * @since Ant 1.6 * @@ -100,7 +100,7 @@ public void setRemove(String remove) { /** * If true, echo the default excludes. * - * @param echo whether or not to echo the contents of + * @param echo whether to echo the contents of * the default excludes. */ public void setEcho(boolean echo) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Definer.java b/src/main/org/apache/tools/ant/taskdefs/Definer.java index adfde30d13..29d7529aaf 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Definer.java +++ b/src/main/org/apache/tools/ant/taskdefs/Definer.java @@ -206,7 +206,7 @@ public void execute() throws BuildException { ClassLoader al = createLoader(); if (!definerSet) { - //we arent fully defined yet. this is an error unless + //we aren't fully defined yet. this is an error unless //we are in an antlib, in which case the resource name is determined //automatically. //NB: URIs in the ant core package will be "" at this point. diff --git a/src/main/org/apache/tools/ant/taskdefs/Delete.java b/src/main/org/apache/tools/ant/taskdefs/Delete.java index 82d84e10fa..c9cd81be48 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Delete.java +++ b/src/main/org/apache/tools/ant/taskdefs/Delete.java @@ -366,9 +366,9 @@ public void setCaseSensitive(boolean isCaseSensitive) { } /** - * Sets whether or not symbolic links should be followed. + * Sets whether symbolic links should be followed. * - * @param followSymlinks whether or not symbolic links should be followed + * @param followSymlinks whether symbolic links should be followed */ @Override public void setFollowSymlinks(boolean followSymlinks) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Ear.java b/src/main/org/apache/tools/ant/taskdefs/Ear.java index 1adb8119cf..55c548ff3e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Ear.java +++ b/src/main/org/apache/tools/ant/taskdefs/Ear.java @@ -145,7 +145,7 @@ protected void zipFile(File file, ZipOutputStream zOut, String vPath, } /** - * Make sure we don't think we already have a application.xml next + * Make sure we don't think we already have an application.xml next * time this task gets executed. */ @Override diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java index eebf6ae126..ce7dc0acfd 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ExecTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ExecTask.java @@ -97,7 +97,7 @@ public ExecTask(Task owner) { } /** - * Set whether or not you want the process to be spawned. + * Set whether you want the process to be spawned. * Default is false. * @param spawn if true you do not want Ant to wait for the end of the process. * @since Ant 1.6 @@ -589,7 +589,7 @@ protected boolean isValidOs() { return false; } //the Exec OS check is different from Os.isOs(), which - //probes for a specific OS. Instead it searches the os field + //probes for a specific OS. Instead, it searches the os field //for the current os.name String myos = System.getProperty("os.name"); log("Current OS is " + myos, Project.MSG_VERBOSE); @@ -645,7 +645,7 @@ protected Execute prepareExec() throws BuildException { } /** - * A Utility method for this classes and subclasses to run an + * A Utility method for these classes and subclasses to run an * Execute instance (an external command). * * @param exe instance of the execute class. diff --git a/src/main/org/apache/tools/ant/taskdefs/Execute.java b/src/main/org/apache/tools/ant/taskdefs/Execute.java index 402f3c765b..16b8cb295a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Execute.java +++ b/src/main/org/apache/tools/ant/taskdefs/Execute.java @@ -80,7 +80,7 @@ public class Execute { private boolean useVMLauncher = true; /** - * Set whether or not you want the process to be spawned. + * Set whether you want the process to be spawned. * Default is not spawned. * * @param spawn if true you do not want Ant @@ -617,10 +617,10 @@ private String[] patchEnvironment() { // Try without changing case first if (osEnv.remove(key) == null && environmentCaseInSensitive) { - // not found, maybe perform a case insensitive search + // not found, maybe perform a case-insensitive search for (String osEnvItem : osEnv.keySet()) { - // Nb: using default locale as key is a env name + // Nb: using default locale as key is an env name if (osEnvItem.equalsIgnoreCase(key)) { // Use the original case of the key key = osEnvItem; diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecuteOn.java b/src/main/org/apache/tools/ant/taskdefs/ExecuteOn.java index bbc9dbb52d..1748e38b32 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ExecuteOn.java +++ b/src/main/org/apache/tools/ant/taskdefs/ExecuteOn.java @@ -56,7 +56,7 @@ public class ExecuteOn extends ExecTask { // CheckStyle:VisibilityModifier OFF - bc - // filesets has been protected so we need to keep that even after + // filesets has been protected, so we need to keep that even after // switching to resource collections. In fact, they will still // get a different treatment form the other resource collections // even in execute since we have some subtle special features like diff --git a/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java b/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java index 7a29668fee..465013ba3e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java +++ b/src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java @@ -44,13 +44,13 @@ public class ExecuteWatchdog implements TimeoutObserver { /** the process to execute and watch for duration */ private Process process; - /** say whether or not the watchdog is currently monitoring a process */ + /** say whether the watchdog is currently monitoring a process */ private volatile boolean watch = false; /** exception that might be thrown during the process execution */ private Exception caught = null; - /** say whether or not the process was killed due to running overtime */ + /** say whether the process was killed due to running overtime */ private volatile boolean killedProcess = false; /** will tell us whether timeout has occurred */ @@ -145,9 +145,9 @@ protected synchronized void cleanUp() { /** * This method will rethrow the exception that was possibly caught during - * the run of the process. It will only remains valid once the process has + * the run of the process. It will only remain valid once the process has * been terminated either by 'error', timeout or manual intervention. - * Information will be discarded once a new process is ran. + * Information will be discarded once a new process has run. * @throws BuildException a wrapped exception over the one that was * silently swallowed and stored during the process run. */ @@ -159,7 +159,7 @@ public synchronized void checkException() throws BuildException { } /** - * Indicates whether or not the watchdog is still monitoring the process. + * Indicates whether the watchdog is still monitoring the process. * @return true if the process is still running, otherwise * false. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/Exit.java b/src/main/org/apache/tools/ant/taskdefs/Exit.java index 6ef274bd73..e16c5bc08d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Exit.java +++ b/src/main/org/apache/tools/ant/taskdefs/Exit.java @@ -204,7 +204,7 @@ private boolean testIfCondition() { /** * test the unless condition * @return true if there is no unless condition, - * or there is a named property but it doesn't exist + * or there is a named property, but it doesn't exist */ private boolean testUnlessCondition() { return PropertyHelper.getPropertyHelper(getProject()) diff --git a/src/main/org/apache/tools/ant/taskdefs/Expand.java b/src/main/org/apache/tools/ant/taskdefs/Expand.java index 19f27fb4b9..23feabae22 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Expand.java +++ b/src/main/org/apache/tools/ant/taskdefs/Expand.java @@ -61,7 +61,7 @@ public class Expand extends Task { public static final String NATIVE_ENCODING = "native-encoding"; - /** Error message when more that one mapper is defined */ + /** Error message when more than one mapper is defined */ public static final String ERROR_MULTIPLE_MAPPERS = "Cannot define more than one mapper"; private static final FileUtils FILE_UTILS = FileUtils.getFileUtils(); @@ -531,7 +531,7 @@ public boolean getScanForUnicodeExtraFields() { } /** - * Whether to allow the extracted file or directory to be outside of the dest directory. + * Whether to allow the extracted file or directory to be outside the dest directory. * * @param b the flag * @since Ant 1.10.4 @@ -541,7 +541,7 @@ public void setAllowFilesToEscapeDest(boolean b) { } /** - * Whether to allow the extracted file or directory to be outside of the dest directory. + * Whether to allow the extracted file or directory to be outside the dest directory. * * @return {@code null} if the flag hasn't been set explicitly, * otherwise the value set by the user. diff --git a/src/main/org/apache/tools/ant/taskdefs/Input.java b/src/main/org/apache/tools/ant/taskdefs/Input.java index f1f7212fa5..82425d6ada 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Input.java +++ b/src/main/org/apache/tools/ant/taskdefs/Input.java @@ -153,7 +153,7 @@ private InputHandler getInputHandler() { /** * Defines valid input parameters as comma separated strings. If set, input * task will reject any input not defined as accepted and requires the user - * to reenter it. Validargs are case sensitive. If you want 'a' and 'A' to + * to reenter it. Validargs are case-sensitive. If you want 'a' and 'A' to * be accepted you need to define both values as accepted arguments. * * @param validargs A comma separated String defining valid input args. diff --git a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java index 55e22f6772..0c26c65aa7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/JDBCTask.java @@ -383,7 +383,7 @@ protected Connection getConnection() throws BuildException { /** * Gets an instance of the required driver. - * Uses the ant class loader and the optionally the provided classpath. + * Uses the ant class loader and optionally the provided classpath. * @return Driver * @throws BuildException if something goes wrong */ @@ -397,8 +397,8 @@ private Driver getDriver() throws BuildException { Class dc; if (classpath != null) { // check first that it is not already loaded otherwise - // consecutive runs seems to end into an OutOfMemoryError - // or it fails when there is a native library to load + // consecutive runs seem to end with an OutOfMemoryError, + // or it fails when a native library is attempted to load // several times. // this is far from being perfect but should work // in most cases. diff --git a/src/main/org/apache/tools/ant/taskdefs/Jar.java b/src/main/org/apache/tools/ant/taskdefs/Jar.java index 0c7bff9528..e713c8fc81 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Jar.java +++ b/src/main/org/apache/tools/ant/taskdefs/Jar.java @@ -118,7 +118,7 @@ public class Jar extends Zip { /** * The file found from the 'manifest' attribute. This can be * either the location of a manifest, or the name of a jar added - * through a fileset. If its the name of an added jar, the + * through a fileset. If it's the name of an added jar, the * manifest is looked for in META-INF/MANIFEST.MF */ private File manifestFile; @@ -246,7 +246,7 @@ public void setJarfile(File jarFile) { } /** - * Set whether or not to create an index list for classes. + * Set whether to create an index list for classes. * This may speed up classloading in some cases. * @param flag a boolean value */ @@ -255,7 +255,7 @@ public void setIndex(boolean flag) { } /** - * Set whether or not to add META-INF and its children to the index. + * Set whether to add META-INF and its children to the index. * *

Doesn't have any effect if index is false.

* @@ -302,7 +302,7 @@ public void addConfiguredManifest(Manifest newManifest) /** * The manifest file to use. This can be either the location of a manifest, - * or the name of a jar added through a fileset. If its the name of an added + * or the name of a jar added through a fileset. If it's the name of an added * jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF. * * @param manifestFile the manifest file to use. @@ -371,7 +371,7 @@ private boolean jarHasIndex(File jarFile) throws IOException { /** * Behavior when a Manifest is found in a zipfileset or zipgroupfileset file. * Valid values are "skip", "merge", and "mergewithoutmain". - * "merge" will merge all of manifests together, and merge this into any + * "merge" will merge all manifests together, and merge this into any * other specified manifests. * "mergewithoutmain" merges everything but the Main section of the manifests. * Default value is "skip". @@ -476,7 +476,7 @@ public void setMergeClassPathAttributes(boolean b) { } /** - * Whether to flatten multi-valued attributes (i.e. Class-Path) + * Whether to flatten multivalued attributes (i.e. Class-Path) * into a single one. * * @param b boolean @@ -1040,7 +1040,7 @@ protected final void writeIndexLikeList(List dirs, List files, } // looks like nothing from META-INF should be added - // and the check is not case insensitive. + // and the check is not case-insensitive. // see sun.misc.JarIndex // see also // https://bugs.openjdk.java.net/browse/JDK-4408526 diff --git a/src/main/org/apache/tools/ant/taskdefs/Java.java b/src/main/org/apache/tools/ant/taskdefs/Java.java index 7c55bbe6e5..fd5d8312fe 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Java.java +++ b/src/main/org/apache/tools/ant/taskdefs/Java.java @@ -258,7 +258,7 @@ protected int executeJava(CommandlineJava commandLine) { } /** - * Set whether or not you want the process to be spawned; + * Set whether you want the process to be spawned; * default is not spawned. * @param spawn if true you do not want Ant to wait for the end of the process. * @since Ant 1.6 @@ -804,7 +804,7 @@ protected void handleOutput(String output) { @Override public int handleInput(byte[] buffer, int offset, int length) throws IOException { - // Should work whether or not redirector.inputStream == null: + // Should work regardless of redirector.inputStream == null: return redirector.handleInput(buffer, offset, length); } diff --git a/src/main/org/apache/tools/ant/taskdefs/Javac.java b/src/main/org/apache/tools/ant/taskdefs/Javac.java index f79a4aaca6..a0724f17af 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Javac.java +++ b/src/main/org/apache/tools/ant/taskdefs/Javac.java @@ -805,8 +805,8 @@ public void setIncludeantruntime(final boolean include) { } /** - * Gets whether or not the ant classpath is to be included in the classpath. - * @return whether or not the ant classpath is to be included in the classpath + * Gets whether the ant classpath is to be included in the classpath. + * @return whether the ant classpath is to be included in the classpath */ public boolean getIncludeantruntime() { return includeAntRuntime == null || includeAntRuntime; @@ -821,7 +821,7 @@ public void setIncludejavaruntime(final boolean include) { } /** - * Gets whether or not the java runtime should be included in this + * Gets whether the java runtime should be included in this * task's classpath. * @return the includejavaruntime attribute */ @@ -1378,7 +1378,7 @@ protected void compile() { } /** - * Adds an "compiler" attribute to Commandline$Attribute used to + * Adds a "compiler" attribute to Commandline$Attribute used to * filter command line attributes based on the current * implementation. */ @@ -1412,7 +1412,7 @@ private void lookForPackageInfos(final File srcDir, final File[] newFiles) { /** * Ensure that every {@code package-info.java} produced a {@code package-info.class}. - * Otherwise this task's up-to-date tracking mechanisms do not work. + * Otherwise, this task's up-to-date tracking mechanisms do not work. * @see Bug #43114 */ private void generateMissingPackageInfoClasses(final File dest) throws IOException { @@ -1439,9 +1439,9 @@ private void generateMissingPackageInfoClasses(final File dest) throws IOExcepti } /** - * Checks if a path exists and is non empty. + * Checks if a path exists and is non-empty. * @param path to be checked - * @return true if the path is non null and non empty. + * @return true if the path is non null and non-empty. * @since 1.9.7 */ private static boolean hasPath(final Path path) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java index efee9d3223..d3194e0c7d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java +++ b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java @@ -816,7 +816,7 @@ public void setPrivate(final boolean b) { /** * Set the scope to be processed. This is an alternative to the - * use of the setPublic, setPrivate, etc methods. It gives better build + * use of the setPublic, setPrivate, etc. methods. It gives better build * file control over what scope is processed. * * @param at the scope to be processed. @@ -1309,7 +1309,7 @@ public LinkArgument createLink() { /** * Represents a link triplet (href, whether link is offline, - * location of the package list if off line) + * location of the package list if offline) */ public class LinkArgument { private String href; @@ -1436,12 +1436,12 @@ public TagArgument createTag() { public class TagArgument extends FileSet { /** Name of the tag. */ private String name = null; - /** Whether or not the tag is enabled. */ + /** Whether the tag is enabled. */ private boolean enabled = true; /** * Scope string of the tag. This will form the middle * argument of the -tag parameter when the tag is enabled - * (with an X prepended for and is parsed from human-readable form. + * (with an X prepended for and is parsed from human-readable form). */ private String scope = "a"; @@ -1537,9 +1537,9 @@ public void setScope(String verboseScope) throws BuildException { } /** - * Sets whether or not the tag is enabled. + * Sets whether the tag is enabled. * - * @param enabled Whether or not this tag is enabled. + * @param enabled Whether this tag is enabled. */ public void setEnabled(final boolean enabled) { this.enabled = enabled; @@ -1652,7 +1652,7 @@ public void setCharset(final String src) { /** * Should the build process fail if Javadoc fails (as indicated by - * a non zero return code)? + * a non-zero return code)? * *

Default is false.

* @param b a boolean value diff --git a/src/main/org/apache/tools/ant/taskdefs/JikesOutputParser.java b/src/main/org/apache/tools/ant/taskdefs/JikesOutputParser.java index c53f9070a7..dc0b5b374d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/JikesOutputParser.java +++ b/src/main/org/apache/tools/ant/taskdefs/JikesOutputParser.java @@ -141,7 +141,7 @@ private void parseStandardOutput(BufferedReader reader) throws IOException { } else if (lower.contains("warning")) { setError(false); } else { - // If we don't know the type of the line + // If we don't know the type of the line, // and we are in emacs mode, it will be // an error, because in this mode, jikes won't // always print "error", but sometimes other diff --git a/src/main/org/apache/tools/ant/taskdefs/KeySubst.java b/src/main/org/apache/tools/ant/taskdefs/KeySubst.java index a6961bd408..95d19c19ac 100644 --- a/src/main/org/apache/tools/ant/taskdefs/KeySubst.java +++ b/src/main/org/apache/tools/ant/taskdefs/KeySubst.java @@ -119,7 +119,7 @@ public void setSep(String sep) { *

* name=value*name2=value *

- * Names are case sensitive. + * Names are case-sensitive. *

* Use the setSep() method to change the * to something else * if you need to use * as a name or value. diff --git a/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java b/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java index e46d34a65c..e8750718c2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java +++ b/src/main/org/apache/tools/ant/taskdefs/LoadProperties.java @@ -146,7 +146,7 @@ public void setPrefix(String prefix) { /** * Whether to apply the prefix when expanding properties on the - * right hand side of a properties file as well. + * right-hand side of a properties file as well. * * @param b boolean * @since Ant 1.8.2 diff --git a/src/main/org/apache/tools/ant/taskdefs/LoadResource.java b/src/main/org/apache/tools/ant/taskdefs/LoadResource.java index a9e4c629b1..70911969bb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/LoadResource.java +++ b/src/main/org/apache/tools/ant/taskdefs/LoadResource.java @@ -108,7 +108,7 @@ public final void setFailonerror(final boolean fail) { /** * If true, suppress the load error report and set the - * the failonerror value to false. + * failonerror value to false. * @param quiet The new Quiet value */ public void setQuiet(final boolean quiet) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Manifest.java b/src/main/org/apache/tools/ant/taskdefs/Manifest.java index 6417a8da21..f65105300c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Manifest.java +++ b/src/main/org/apache/tools/ant/taskdefs/Manifest.java @@ -316,7 +316,7 @@ public void write(PrintWriter writer) throws IOException { * Write the attribute out to a print writer. * * @param writer the Writer to which the attribute is written - * @param flatten whether to collapse multi-valued attributes + * @param flatten whether to collapse multivalued attributes * (i.e. potentially Class-Path) Class-Path into a * single attribute. * @@ -537,7 +537,7 @@ public void write(PrintWriter writer) throws IOException { * Write the section out to a print writer. * * @param writer the Writer to which the section is written - * @param flatten whether to collapse multi-valued attributes + * @param flatten whether to collapse multivalued attributes * (i.e. potentially Class-Path) Class-Path into a * single attribute. * @@ -557,7 +557,7 @@ public void write(PrintWriter writer, boolean flatten) } /** - * Get a attribute of the section + * Get an attribute of the section * * @param attributeName the name of the attribute * @return a Manifest.Attribute instance if the attribute is @@ -623,7 +623,7 @@ public void addConfiguredAttribute(Attribute attribute) * @param attribute the attribute to be added. * * @return the value of the attribute if it is a name - * attribute - null other wise + * attribute - null otherwise * * @exception ManifestException if the attribute already * exists in this section. @@ -835,7 +835,7 @@ public Manifest(Reader r) throws ManifestException, IOException { * * @param section the manifest section to be added * - * @exception ManifestException if the secti0on is not valid. + * @exception ManifestException if the section is not valid. */ public void addConfiguredSection(Section section) throws ManifestException { @@ -952,7 +952,7 @@ public void write(PrintWriter writer) throws IOException { * Write the manifest out to a print writer. * * @param writer the Writer to which the manifest is written - * @param flatten whether to collapse multi-valued attributes + * @param flatten whether to collapse multivalued attributes * (i.e. potentially Class-Path) Class-Path into a single * attribute. * diff --git a/src/main/org/apache/tools/ant/taskdefs/ManifestClassPath.java b/src/main/org/apache/tools/ant/taskdefs/ManifestClassPath.java index a1710bf9e8..aad144b99c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ManifestClassPath.java +++ b/src/main/org/apache/tools/ant/taskdefs/ManifestClassPath.java @@ -123,7 +123,7 @@ public void execute() { buffer.append(' '); } - // Finally assign the property with the manifest classpath + // Finally, assign the property with the manifest classpath getProject().setNewProperty(name, buffer.toString().trim()); } diff --git a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java index 2345b3137a..dd9a2d63b3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/ManifestTask.java @@ -141,7 +141,7 @@ public void addConfiguredAttribute(Manifest.Attribute attribute) * So the resulting regexp would be [A-Za-z0-9][A-Za-z0-9-_]*. * * Because of JDK 1.2 compliance and the possible absence of a - * regexp matcher we can not use regexps here. Instead we have to + * regexp matcher we can not use regexps here. Instead, we have to * check each character. * * @param attribute The attribute to check @@ -201,7 +201,7 @@ public void setMergeClassPathAttributes(boolean b) { } /** - * Whether to flatten multi-valued attributes (i.e. Class-Path) + * Whether to flatten multivalued attributes (i.e. Class-Path) * into a single one. * * @param b boolean diff --git a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java index 063b720d5f..c5a95f9841 100644 --- a/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/MatchingTask.java @@ -225,9 +225,9 @@ public void setCaseSensitive(boolean isCaseSensitive) { } /** - * Sets whether or not symbolic links should be followed. + * Sets whether symbolic links should be followed. * - * @param followSymlinks whether or not symbolic links should be followed + * @param followSymlinks whether symbolic links should be followed */ public void setFollowSymlinks(boolean followSymlinks) { fileset.setFollowSymlinks(followSymlinks); diff --git a/src/main/org/apache/tools/ant/taskdefs/Move.java b/src/main/org/apache/tools/ant/taskdefs/Move.java index 7dadc1bbf8..19b3af4e63 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Move.java +++ b/src/main/org/apache/tools/ant/taskdefs/Move.java @@ -256,7 +256,7 @@ private void copyFile(File fromFile, File toFile, boolean filtering, boolean ove } /** - * Its only ok to delete a directory tree if there are no files in it. + * It's only ok to delete a directory tree if there are no files in it. * @param d the directory to check * @return true if a deletion can go ahead */ diff --git a/src/main/org/apache/tools/ant/taskdefs/Parallel.java b/src/main/org/apache/tools/ant/taskdefs/Parallel.java index 757c8047af..9bc4822ef4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Parallel.java +++ b/src/main/org/apache/tools/ant/taskdefs/Parallel.java @@ -90,7 +90,7 @@ public void addTask(Task nestedTask) { private boolean timedOut; /** - * Indicates whether failure of any of the nested tasks should end + * Indicates whether failure of any nested task should end * execution */ private boolean failOnAny; @@ -169,8 +169,8 @@ public void setThreadsPerProcessor(int numThreadsPerProcessor) { /** * Statically determine the maximum number of tasks to execute - * simultaneously. If there are less tasks than threads then all will be - * executed at once, if there are more then only threadCount + * simultaneously. If there are fewer tasks than threads, then all will be + * executed at once; if there are more, then only threadCount * tasks will be executed at one time. If threadsPerProcessor * is set then this value is * ignored.; optional diff --git a/src/main/org/apache/tools/ant/taskdefs/PathConvert.java b/src/main/org/apache/tools/ant/taskdefs/PathConvert.java index 45b2a6e5b0..86f6e77498 100644 --- a/src/main/org/apache/tools/ant/taskdefs/PathConvert.java +++ b/src/main/org/apache/tools/ant/taskdefs/PathConvert.java @@ -134,8 +134,7 @@ public void accept(String t) { * Helper class, holds the nested <map> values. Elements will look like * this: <map from="d:" to="/foo"/> * - * When running on windows, the prefix comparison will be case - * insensitive. + * When running on windows, the prefix comparison will be case-insensitive. */ public class MapEntry { @@ -275,7 +274,7 @@ public void setTargetos(TargetOs target) { // Currently, we deal with only two path formats: Unix and Windows // And Unix is everything that is not Windows - // for NetWare and OS/2, piggy-back on Windows, since in the + // for NetWare and OS/2, piggyback on Windows, since in the // validateSetup code, the same assumptions can be made as // with windows - that ; is the path separator @@ -461,7 +460,7 @@ private Stream streamResources() { // And Unix is everything that is not Windows // (with the exception for NetWare and OS/2 below) - // for NetWare and OS/2, piggy-back on Windows, since here and + // for NetWare and OS/2, piggyback on Windows, since here and // in the apply code, the same assumptions can be made as with // windows - that \\ is an OK separator, and do comparisons // case-insensitive. diff --git a/src/main/org/apache/tools/ant/taskdefs/ProcessDestroyer.java b/src/main/org/apache/tools/ant/taskdefs/ProcessDestroyer.java index fd46e3cbe8..fca461cb83 100644 --- a/src/main/org/apache/tools/ant/taskdefs/ProcessDestroyer.java +++ b/src/main/org/apache/tools/ant/taskdefs/ProcessDestroyer.java @@ -37,10 +37,10 @@ class ProcessDestroyer implements Runnable { private Method removeShutdownHookMethod; private ProcessDestroyerImpl destroyProcessThread = null; - // whether or not this ProcessDestroyer has been registered as a + // whether this ProcessDestroyer has been registered as a // shutdown hook private boolean added = false; - // whether or not this ProcessDestroyer is currently running as + // whether this ProcessDestroyer is currently running as // shutdown hook private boolean running = false; @@ -135,7 +135,7 @@ private void removeShutdownHook() { e.printStackTrace(); //NOSONAR } } - // start the hook thread, a unstarted thread may not be + // start the hook thread, an unstarted thread may not be // eligible for garbage collection // Cf.: https://bugs.openjdk.java.net/browse/JDK-4533087 destroyProcessThread.setShouldDestroy(false); @@ -157,8 +157,8 @@ private void removeShutdownHook() { } /** - * Returns whether or not the ProcessDestroyer is registered as - * as shutdown hook + * Returns whether the ProcessDestroyer is registered as + * a shutdown hook * @return true if this is currently added as shutdown hook */ public boolean isAddedAsShutdownHook() { diff --git a/src/main/org/apache/tools/ant/taskdefs/Property.java b/src/main/org/apache/tools/ant/taskdefs/Property.java index cd930dbbd7..d2ed64d8fe 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Property.java +++ b/src/main/org/apache/tools/ant/taskdefs/Property.java @@ -71,7 +71,7 @@ *

The value part of the properties being set, might contain references to other * properties. These references are resolved at the time these properties are set. * This also holds for properties loaded from a property file.

- * Properties are case sensitive. + * Properties are case-sensitive. * * @since Ant 1.1 * @@ -168,7 +168,7 @@ public String getName() { * Sets the property to the absolute filename of the * given file. If the value of this attribute is an absolute path, it * is left unchanged (with / and \ characters converted to the - * current platforms conventions). Otherwise it is taken as a path + * current platforms conventions). Otherwise, it is taken as a path * relative to the project's basedir and expanded. * @param location path to set * @@ -298,7 +298,7 @@ public String getPrefix() { /** * Whether to apply the prefix when expanding properties on the - * right hand side of a properties file as well. + * right-hand side of a properties file as well. * * @param b boolean * @since Ant 1.8.2 @@ -309,7 +309,7 @@ public void setPrefixValues(boolean b) { /** * Whether to apply the prefix when expanding properties on the - * right hand side of a properties file as well. + * right-hand side of a properties file as well. * * @return boolean * @since Ant 1.8.2 @@ -359,7 +359,7 @@ public String getResource() { /** * Prefix to use when retrieving environment variables. - * Thus if you specify environment="myenv" + * Thus, if you specify environment="myenv" * you will be able to access OS-specific * environment variables via property names "myenv.PATH" or * "myenv.TERM". @@ -371,7 +371,7 @@ public String getResource() { * on select platforms. Feel free to send patches to increase the number of platforms * this functionality is supported on ;). *

- * Note also that properties are case sensitive, even if the + * Note also that properties are case-sensitive, even if the * environment variables on your operating system are not, e.g. it * will be ${env.Path} not ${env.PATH} on Windows 2000. * diff --git a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java index 0a856cb49a..c91aaddbff 100644 --- a/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java +++ b/src/main/org/apache/tools/ant/taskdefs/PumpStreamHandler.java @@ -48,7 +48,7 @@ public class PumpStreamHandler implements ExecuteStreamHandler { * @param err the error OutputStream, must not be null. * @param input the input InputStream. * @param nonBlockingRead set it to true if the input should be - * read with simulated non blocking IO. + * read with simulated non-blocking IO. */ public PumpStreamHandler(OutputStream out, OutputStream err, InputStream input, boolean nonBlockingRead) { @@ -281,8 +281,7 @@ protected Thread createPump(InputStream is, OutputStream os, * @param is the input stream to copy from. * @param os the output stream to copy to. * @param closeWhenExhausted if true close the inputstream. - * @param nonBlockingIO set it to true to use simulated non - * blocking IO. + * @param nonBlockingIO set it to true to use simulated non-blocking IO. * @return a thread object that does the pumping, subclasses * should return an instance of {@link ThreadWithPumper * ThreadWithPumper}. diff --git a/src/main/org/apache/tools/ant/taskdefs/Recorder.java b/src/main/org/apache/tools/ant/taskdefs/Recorder.java index 05beb8e881..e30dac3e11 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Recorder.java +++ b/src/main/org/apache/tools/ant/taskdefs/Recorder.java @@ -54,7 +54,7 @@ public class Recorder extends Task implements SubBuildListener { /** The name of the file to record to. */ private String filename = null; /** - * Whether or not to append. Need Boolean to record an unset state (null). + * Whether to append. Need Boolean to record an unset state (null). */ private Boolean append = null; /** @@ -110,7 +110,7 @@ public void setAction(ActionChoices action) { /** - * Whether or not the logger should append to a previous file. + * Whether the logger should append to a previous file. * @param append if true, append to a previous file. */ public void setAppend(boolean append) { diff --git a/src/main/org/apache/tools/ant/taskdefs/Rmic.java b/src/main/org/apache/tools/ant/taskdefs/Rmic.java index ece5a9475f..ff981061eb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Rmic.java +++ b/src/main/org/apache/tools/ant/taskdefs/Rmic.java @@ -411,7 +411,7 @@ public Vector getFileList() { } /** - * Sets whether or not to include ant's own classpath in this task's + * Sets whether to include ant's own classpath in this task's * classpath. * Optional; default is true. * @param include if true include ant's classpath @@ -421,7 +421,7 @@ public void setIncludeantruntime(boolean include) { } /** - * Gets whether or not the ant classpath is to be included in the + * Gets whether the ant classpath is to be included in the * task's classpath. * @return true if ant's classpath is to be included */ @@ -441,7 +441,7 @@ public void setIncludejavaruntime(boolean include) { } /** - * Gets whether or not the java runtime should be included in this + * Gets whether the java runtime should be included in this * task's classpath. * @return true if default run-time libraries are included */ @@ -636,8 +636,8 @@ public void execute() throws BuildException { if (f.isFile()) { scanDir(baseDir, new String[] {path}, adapter.getMapper()); } else { - // Does not exist, so checking whether it is up to - // date makes no sense. Compilation will fail + // Does not exist, so checking whether it is up-to-date + // makes no sense. Compilation will fail // later anyway, but tests expect a certain // output. compileList.add(classname); @@ -817,7 +817,7 @@ public ClassLoader getLoader() { } /** - * Adds an "compiler" attribute to Commandline$Attribute used to + * Adds a "compiler" attribute to Commandline$Attribute used to * filter command line attributes based on the current * implementation. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java index dc116a3438..38fb52b0f7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java +++ b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java @@ -469,7 +469,7 @@ public void setOnerror(OnError action) { } /** - * whether or not format should be preserved. + * whether format should be preserved. * Defaults to false. * * @param keepformat The keepformat to set @@ -759,7 +759,7 @@ protected void runStatements(Reader reader, PrintStream out) sql.append(keepformat ? "\n" : " ").append(line); // SQL defines "--" as a comment to EOL - // and in Oracle it may contain a hint + // and in Oracle it may contain a hint, // so we cannot just remove it, instead we must end it if (!keepformat && line.contains("--")) { sql.append("\n"); @@ -1005,7 +1005,7 @@ public class Transaction { * @param src the source file */ public void setSrc(File src) { - //there are places (in this file, and perhaps elsewhere, where it is assumed + //there are places (in this file, and perhaps elsewhere), where it is assumed //that null is an acceptable parameter. if (src != null) { setSrcResource(new FileResource(src)); diff --git a/src/main/org/apache/tools/ant/taskdefs/SignJar.java b/src/main/org/apache/tools/ant/taskdefs/SignJar.java index 6066d87f57..9767b47d06 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SignJar.java +++ b/src/main/org/apache/tools/ant/taskdefs/SignJar.java @@ -37,7 +37,7 @@ * Signs JAR or ZIP files with the javasign command line tool. The tool detailed * dependency checking: files are only signed if they are not signed. The * signjar attribute can point to the file to generate; if this file - * exists then its modification date is used as a cue as to whether to resign + * exists then its modification date is used as a cue whether to resign * any JAR file. * * Timestamp signature support is based on Java 8 diff --git a/src/main/org/apache/tools/ant/taskdefs/StreamPumper.java b/src/main/org/apache/tools/ant/taskdefs/StreamPumper.java index 2c4aaee8cd..f301dcba0c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/StreamPumper.java +++ b/src/main/org/apache/tools/ant/taskdefs/StreamPumper.java @@ -213,7 +213,7 @@ public synchronized Exception getException() { /** * Stop the pumper as soon as possible. - * Note that it may continue to block on the input stream + * Note that it may continue to block on the input stream, * but it will really stop the thread as soon as it gets EOF * or any byte, and it will be marked as finished. * @return Returns a {@link PostStopHandle} for the callers to @@ -266,7 +266,7 @@ private void doPostStop() throws IOException { } } // this can potentially be blocking, but that's OK since our post stop activity is allowed to - // cleanup/flush any data and the PostStopHandle let's the caller control over how long they want + // clean up/flush any data and the PostStopHandle lets the caller control over how long they want // this to go, before actually interrupting the thread os.flush(); } finally { diff --git a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java index 6e09032cc8..be80565fcd 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SubAnt.java +++ b/src/main/org/apache/tools/ant/taskdefs/SubAnt.java @@ -197,7 +197,7 @@ public void execute() { return; } /* - //REVISIT: there must be cleaner way of doing this, if it is merited at all + //REVISIT: there must be a cleaner way of doing this, if it is merited at all if (subTarget == null) { subTarget = getOwningTarget().getName(); } @@ -510,7 +510,7 @@ public void add(ResourceCollection rc) { } /** - * Set the buildpath to be used to find sub-projects. + * Set the buildpath to be used to find subprojects. * * @param s an Ant Path object containing the buildpath. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/Sync.java b/src/main/org/apache/tools/ant/taskdefs/Sync.java index 48eb6473d0..e9a21f971e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Sync.java +++ b/src/main/org/apache/tools/ant/taskdefs/Sync.java @@ -451,7 +451,7 @@ private Boolean getExplicitPreserveEmptyDirs() { } /** - * Subclass Copy in order to access it's file/dir maps. + * Subclass Copy in order to access its file/dir maps. */ public static class MyCopy extends Copy { diff --git a/src/main/org/apache/tools/ant/taskdefs/Tar.java b/src/main/org/apache/tools/ant/taskdefs/Tar.java index b5a254fbf6..69fe47d568 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Tar.java +++ b/src/main/org/apache/tools/ant/taskdefs/Tar.java @@ -364,7 +364,7 @@ protected void tarFile(final File file, final TarOutputStream tOut, final String final TarFileSet tarFileSet) throws IOException { if (file.equals(tarFile)) { - // If the archive is built for the first time and it is + // If the archive is built for the first time, and it is // matched by a resource collection, then it hasn't been // found in check (it hasn't been there) but will be // included now. @@ -526,7 +526,7 @@ protected void tarResource(final Resource r, final TarOutputStream tOut, String /** * Is the archive up to date in relationship to a list of files. * @param files the files to check - * @return true if the archive is up to date. + * @return true if the archive is up-to-date. * @deprecated since 1.5.x. * use the two-arg version instead. */ @@ -539,7 +539,7 @@ protected boolean archiveIsUpToDate(final String[] files) { * Is the archive up to date in relationship to a list of files. * @param files the files to check * @param dir the base directory for the files. - * @return true if the archive is up to date. + * @return true if the archive is up-to-date. * @since Ant 1.5.2 */ protected boolean archiveIsUpToDate(final String[] files, final File dir) { @@ -552,7 +552,7 @@ protected boolean archiveIsUpToDate(final String[] files, final File dir) { /** * Is the archive up to date in relationship to a list of files. * @param r the files to check - * @return true if the archive is up to date. + * @return true if the archive is up-to-date. * @since Ant 1.7 */ protected boolean archiveIsUpToDate(final Resource r) { @@ -853,7 +853,7 @@ public int getMode() { } /** - * Flag to indicates whether leading `/'s should + * Flag to indicate whether leading `/'s should * be preserved in the file names. * Optional, default is false. * @param b the leading slashes flag. diff --git a/src/main/org/apache/tools/ant/taskdefs/UpToDate.java b/src/main/org/apache/tools/ant/taskdefs/UpToDate.java index 5183c4f423..f1536fee44 100644 --- a/src/main/org/apache/tools/ant/taskdefs/UpToDate.java +++ b/src/main/org/apache/tools/ant/taskdefs/UpToDate.java @@ -37,7 +37,7 @@ /** * Sets the given property if the specified target has a timestamp - * greater than all of the source files. + * greater than all the source files. * * @since Ant 1.2 * @@ -250,7 +250,7 @@ public void execute() throws BuildException { * Scan a directory for files to check for "up to date"ness * @param srcDir the directory * @param files the files to scan for - * @return true if the files are up to date + * @return true if the files are up-to-date */ protected boolean scanDir(File srcDir, String[] files) { SourceFileScanner sfs = new SourceFileScanner(this); diff --git a/src/main/org/apache/tools/ant/taskdefs/War.java b/src/main/org/apache/tools/ant/taskdefs/War.java index 0d559f9103..87f6c841a4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/War.java +++ b/src/main/org/apache/tools/ant/taskdefs/War.java @@ -103,7 +103,7 @@ public void setWebxml(File descr) { } /** - * Set the policy on the web.xml file, that is, whether or not it is needed + * Set the policy on the web.xml file, that is, whether it is needed * @param needxmlfile whether a web.xml file is needed. Default: true */ public void setNeedxmlfile(boolean needxmlfile) { diff --git a/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java b/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java index 4e07c3a979..29c9813f72 100644 --- a/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java +++ b/src/main/org/apache/tools/ant/taskdefs/XmlProperty.java @@ -470,7 +470,7 @@ private void addProperty(String name, String value, String id) { // forcibly override the property if it already exists. // We need to put these properties into the project // when we read them, though (instead of keeping them - // outside of the project and batch adding them at the end) + // outside the project and batch adding them at the end) // to allow other properties to reference them. value = addedAttributes.get(name) + getDelimiter() + value; getProject().setProperty(name, value); @@ -520,7 +520,7 @@ private static boolean isSemanticAttribute(String attributeName) { /** * Return the value for the given attribute. - * If we are not using semantic attributes, its just the + * If we are not using semantic attributes, it's just the * literal string value of the attribute. * *

If we are using semantic attributes, then first diff --git a/src/main/org/apache/tools/ant/taskdefs/Zip.java b/src/main/org/apache/tools/ant/taskdefs/Zip.java index b694057564..afc1af6de4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Zip.java +++ b/src/main/org/apache/tools/ant/taskdefs/Zip.java @@ -519,11 +519,22 @@ public void setUseLanguageEncodingFlag(final boolean b) { useLanguageEncodingFlag = b; } + /** + * Whether the language encoding flag will be used. + * @return boolean + * @since Ant 1.10.13 + */ + public boolean getUseLanguageEncodingFlag() { + return useLanguageEncodingFlag; + } + /** * Whether the language encoding flag will be used. * @return boolean * @since Ant 1.8.0 + * @deprecated misspelled */ + @Deprecated public boolean getUseLanguageEnodingFlag() { return useLanguageEncodingFlag; } @@ -670,7 +681,7 @@ public void executeMain() throws BuildException { // can also handle empty archives final ArchiveState state = getResourcesToAdd(fss, zipFile, false); - // quick exit if the target is up to date + // quick exit if the target is up-to-date if (!state.isOutOfDate()) { return; } @@ -868,7 +879,7 @@ private void checkAttributesAndElements() { /** Process doupdate */ private void processDoUpdate() { - // Whether or not an actual update is required - + // Whether an actual update is required - // we don't need to update if the original file doesn't exist if (doUpdate && !zipFile.exists()) { doUpdate = false; @@ -1288,7 +1299,7 @@ protected ArchiveState getResourcesToAdd(final ResourceCollection[] rcs, /* * This is yet another hacky construct to extend the FileSet[] - * getResourcesToAdd method so we can pass the information whether + * getResourcesToAdd method, so we can pass the information whether * non-fileset resources have been available to it without having * to move the withEmpty behavior checks (since either would break * subclasses in several ways). @@ -1341,7 +1352,7 @@ protected ArchiveState getResourcesToAdd(final FileSet[] filesets, * for inline s. * * If we invoke createEmptyZip like Ant 1.5.2 did, - * we'll loose all stuff that has been in the + * we'll lose all stuff that has been in the * original archive (bugzilla report 17780). */ return new ArchiveState(true, initialResources); diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java b/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java index cf3ec45f3f..6bb1068c95 100644 --- a/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java +++ b/src/main/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.java @@ -227,7 +227,7 @@ protected Path getUpgrademodulepath() { } /** - * Builds the modulesourcepath for multi module compilation. + * Builds the modulesourcepath for multimodule compilation. * @return the modulesourcepath * @since 1.9.7 */ @@ -252,14 +252,14 @@ protected Commandline setupJavacCommandlineSwitches(final Commandline cmd) { * Does the command line argument processing common to classic and * modern. Doesn't add the files to compile. * @param cmd the command line - * @param useDebugLevel if true set set the debug level with the -g switch + * @param useDebugLevel if true set the debug level with the -g switch * @return the command line */ protected Commandline setupJavacCommandlineSwitches(final Commandline cmd, final boolean useDebugLevel) { final Path classpath = getCompileClasspath(); // For -sourcepath, use the "sourcepath" value if present. - // Otherwise default to the "srcdir" value. + // Otherwise, default to the "srcdir" value. Path sourcepath; if (compileSourcepath != null) { sourcepath = compileSourcepath; diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/Gcj.java b/src/main/org/apache/tools/ant/taskdefs/compilers/Gcj.java index 0d482862c4..8ca51f364c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/compilers/Gcj.java +++ b/src/main/org/apache/tools/ant/taskdefs/compilers/Gcj.java @@ -73,7 +73,7 @@ protected Commandline setupGCJCommand() { classpath.append(getCompileClasspath()); - // Gcj has no option for source-path so we + // Gcj has no option for source-path, so we // will add it to classpath. if (compileSourcepath != null) { classpath.append(compileSourcepath); diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/Jikes.java b/src/main/org/apache/tools/ant/taskdefs/compilers/Jikes.java index e6b5c37e1b..61ece2a731 100644 --- a/src/main/org/apache/tools/ant/taskdefs/compilers/Jikes.java +++ b/src/main/org/apache/tools/ant/taskdefs/compilers/Jikes.java @@ -36,7 +36,7 @@ public class Jikes extends DefaultCompilerAdapter { * Mostly of this code is identical to doClassicCompile() * However, it does not support all options like * extdirs, deprecation and so on, because - * there is no option in jikes and I don't understand + * there is no option in jikes, and I don't understand * what they should do. * * It has been successfully tested with jikes >1.10. @@ -50,7 +50,7 @@ public boolean execute() throws BuildException { Commandline cmd = new Commandline(); // For -sourcepath, use the "sourcepath" value if present. - // Otherwise default to the "srcdir" value. + // Otherwise, default to the "srcdir" value. Path sourcepath; if (compileSourcepath != null) { sourcepath = compileSourcepath; diff --git a/src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java b/src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java index fb659fe661..082a095f21 100644 --- a/src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java +++ b/src/main/org/apache/tools/ant/taskdefs/compilers/Jvc.java @@ -58,7 +58,7 @@ public boolean execute() throws BuildException { classpath.append(getCompileClasspath()); - // jvc has no option for source-path so we + // jvc has no option for source-path, so we // will add it to classpath. if (compileSourcepath != null) { classpath.append(compileSourcepath); diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Equals.java b/src/main/org/apache/tools/ant/taskdefs/condition/Equals.java index 44e3561fa2..763d08d13e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/Equals.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/Equals.java @@ -98,8 +98,8 @@ public void setTrim(boolean b) { } /** - * Should the comparison be case sensitive? - * @param b if true use a case sensitive comparison (this is the + * Should the comparison be case-sensitive? + * @param b if true use a case-sensitive comparison (this is the * default) * @since Ant 1.5 */ diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Http.java b/src/main/org/apache/tools/ant/taskdefs/condition/Http.java index b811e8de28..a45f4cf0f4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/Http.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/Http.java @@ -32,7 +32,7 @@ import org.apache.tools.ant.taskdefs.Get; /** - * Condition to wait for a HTTP request to succeed. Its attribute(s) are: + * Condition to wait for an HTTP request to succeed. Its attribute(s) are: * url - the URL of the request. * errorsBeginAt - number at which errors begin at; default=400. * requestMethod - HTTP request method to use; GET, HEAD, etc. default=GET @@ -100,7 +100,7 @@ public void setFollowRedirects(boolean f) { /** * Sets the read timeout. Any value < 0 will be ignored * - * @param t the timeout value in milli seconds + * @param t the timeout value in milliseconds * * @see java.net.HttpURLConnection#setReadTimeout * @since Ant 1.10.6 diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsFileSelected.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsFileSelected.java index e7cd9d640e..3fc912a639 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/IsFileSelected.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsFileSelected.java @@ -35,7 +35,7 @@ public class IsFileSelected extends AbstractSelectorContainer implements Conditi /** * The file to check. - * @param file the file to check if if passes the embedded selector. + * @param file the file to check if it passes the embedded selector. */ public void setFile(File file) { this.file = file; diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java index c0d46ee485..796e0a8899 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsReachable.java @@ -74,7 +74,7 @@ public class IsReachable extends ProjectComponent implements Condition { /** Error message when url and host are specified. */ public static final String ERROR_BOTH_TARGETS = "Both url and host have been specified"; - /** Error message when no reachably test avail. */ + /** Error message when no reachable test avail. */ public static final String MSG_NO_REACHABLE_TEST = "cannot do a proper reachability test on this Java version"; /** Error message when an invalid url is used. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogParser.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogParser.java index 7c862e9116..e8cdfc1819 100644 --- a/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogParser.java +++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/ChangeLogParser.java @@ -148,7 +148,7 @@ public void stdout(final String line) { private void processComment(final String line) { if ("=============================================================================" .equals(line)) { - //We have ended changelog for that particular file + //We have ended changelog for that particular file, //so we can save it final int end = comment.length() - System.lineSeparator().length(); //was -1 comment = comment.substring(0, end); diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsUser.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsUser.java index 85edc91505..b92e0b60d2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsUser.java +++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/CvsUser.java @@ -69,7 +69,7 @@ public String getDisplayname() { /** * Validate that this object is configured. * - * @exception BuildException if the instance has not be correctly + * @exception BuildException if the instance has not been correctly * configured. */ public void validate() throws BuildException { diff --git a/src/main/org/apache/tools/ant/taskdefs/cvslib/RCSFile.java b/src/main/org/apache/tools/ant/taskdefs/cvslib/RCSFile.java index 2aa42cd50e..fdeba598d0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/cvslib/RCSFile.java +++ b/src/main/org/apache/tools/ant/taskdefs/cvslib/RCSFile.java @@ -18,7 +18,7 @@ package org.apache.tools.ant.taskdefs.cvslib; /** - * Represents a RCS File change. + * Represents an RCS File change. * */ class RCSFile { diff --git a/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java b/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java index 7c00038a39..b6c089ee10 100644 --- a/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java +++ b/src/main/org/apache/tools/ant/taskdefs/email/Mailer.java @@ -269,7 +269,7 @@ protected boolean shouldIgnoreInvalidRecipients() { } /** - * Return the current Date in a format suitable for a SMTP date + * Return the current Date in a format suitable for an SMTP date * header. * * @return the current date in SMTP suitable format. diff --git a/src/main/org/apache/tools/ant/taskdefs/email/PlainMailer.java b/src/main/org/apache/tools/ant/taskdefs/email/PlainMailer.java index 806102ca42..51ece0d637 100644 --- a/src/main/org/apache/tools/ant/taskdefs/email/PlainMailer.java +++ b/src/main/org/apache/tools/ant/taskdefs/email/PlainMailer.java @@ -112,7 +112,7 @@ public void send() { /** * Attaches a file to this email * - * @param file The file to attache + * @param file The file to attach * @param out The message stream to add to * @throws IOException if errors occur */ diff --git a/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncherProxy.java b/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncherProxy.java index 021e4c134e..b31b9359ad 100644 --- a/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncherProxy.java +++ b/src/main/org/apache/tools/ant/taskdefs/launcher/CommandLauncherProxy.java @@ -23,7 +23,7 @@ /** * A command launcher that proxies another command - * launcher. Sub-classes override exec(args, env, workdir). + * launcher. Subclasses override exec(args, env, workdir). */ public class CommandLauncherProxy extends CommandLauncher { private final CommandLauncher myLauncher; diff --git a/src/main/org/apache/tools/ant/taskdefs/modules/Jmod.java b/src/main/org/apache/tools/ant/taskdefs/modules/Jmod.java index 47f0ef2245..8e10f45d34 100644 --- a/src/main/org/apache/tools/ant/taskdefs/modules/Jmod.java +++ b/src/main/org/apache/tools/ant/taskdefs/modules/Jmod.java @@ -232,7 +232,7 @@ public class Jmod /** * Regular expression matching names of modules which depend on the - * the created jmod's module, for which hashes should be added to the + * created jmod's module, for which hashes should be added to the * created jmod. */ private String hashModulesPattern; diff --git a/src/main/org/apache/tools/ant/taskdefs/modules/Link.java b/src/main/org/apache/tools/ant/taskdefs/modules/Link.java index b25d4c2954..cc4242f61c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/modules/Link.java +++ b/src/main/org/apache/tools/ant/taskdefs/modules/Link.java @@ -1861,7 +1861,7 @@ public Collection toCommandLineOptions() { /** * Invokes the jlink tool to create a new linked image, unless the - * output directory exists and all of its files are files are newer + * output directory exists and all of its files are newer * than all files in the module path. * * @throws BuildException if destDir is not set diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java b/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java index 7be3b28747..96ecc8e83e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/Cab.java @@ -151,7 +151,7 @@ protected ExecTask createExec() throws BuildException { } /** - * Check to see if the target is up to date with respect to input files. + * Check to see if the target is up-to-date with respect to input files. * @param files the list of files to check. * @return true if the cab file is newer than its dependents. */ @@ -226,7 +226,7 @@ public void execute() throws BuildException { Vector files = getFileList(); - // quick exit if the target is up to date + // quick exit if the target is up-to-date if (isUpToDate(files)) { return; } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java index 7404bdcae1..5482e14482 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java @@ -237,7 +237,7 @@ public void setFormat(FormatAttribute ea) { } /** - * A enumerated type for the format attribute. + * An enumerated type for the format attribute. * The values are "xml" and "text". */ public static class FormatAttribute extends EnumeratedAttribute { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java b/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java index c4e315941a..50152fc46c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/Javah.java @@ -110,7 +110,7 @@ public ClassArgument createClass() { } /** - * A class corresponding the the nested "class" element. + * A class corresponding the nested "class" element. * It contains a "name" attribute. */ public class ClassArgument { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java b/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java index 083aeed481..bb1af32ef9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/NetRexxC.java @@ -201,7 +201,7 @@ public void setCompile(boolean compile) { } /** - * Set whether or not compiler messages should be displayed on the 'console'. + * Set whether compiler messages should be displayed on the 'console'. * Note that this task will rely on the default value for filtering compile messages. * Valid true values are "yes", "on" or "true". Anything else sets the flag to false. * The default value is false. @@ -212,7 +212,7 @@ public void setConsole(boolean console) { } /** - * Whether variable cross references are generated. + * Whether variable cross-references are generated. * Valid true values are "yes", "on" or "true". Anything else sets the flag to false. * The default value is false. * @param crossref a boolean value. @@ -366,7 +366,7 @@ public void setStrictassign(boolean strictassign) { } /** - * Specifies whether the NetRexx compiler should be case sensitive or not. + * Specifies whether the NetRexx compiler should be case-sensitive. * Valid true values are "yes", "on" or "true". Anything else sets the flag to false. * The default value is false. * @param strictcase a boolean value. @@ -377,7 +377,7 @@ public void setStrictcase(boolean strictcase) { /** * Sets whether classes need to be imported explicitly using an import - * statement. By default the NetRexx compiler will import certain packages + * statement. By default, the NetRexx compiler will import certain packages * automatically. * Valid true values are "yes", "on" or "true". Anything else sets the flag to false. * The default value is false. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java index 5b7e3e6959..ca0f2895c5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.java @@ -95,7 +95,7 @@ * replace --> The Expression replacement string * flags --> The options to give to the replacement * g = Substitute all occurrences. default is to replace only the first one - * i = Case insensitive match + * i = Case-insensitive match * * byline --> Should this file be processed a single line at a time (default is false) * "true" indicates to perform replacement on a line by line basis @@ -148,7 +148,7 @@ public ReplaceRegExp() { * file for which the regular expression should be replaced; * required unless a nested fileset is supplied. * - * @param file The file for which the reg exp should be replaced. + * @param file The file for which the regular expression should be replaced. */ public void setFile(File file) { this.file = file; @@ -192,7 +192,7 @@ public void setReplace(String replace) { * information, consult the Perl5 syntax. *

    *
  • g : Global replacement. Replace all occurrences found
    • - *
  • i : Case Insensitive. Do not consider case in the match
    • + *
  • i : Case-Insensitive. Do not consider case in the match
    • *
  • m : Multiline. Treat the string as multiple lines of input, * using "^" and "$" as the start or end of any line, respectively, * rather than start or end of string.
    • diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java b/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java index 1be941ce79..3cc0740b92 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/TraXLiaison.java @@ -259,8 +259,8 @@ private Source getSource(final InputStream is, final Resource resource) // xalan prior to 2.2 because of systemid bugs. src = new StreamSource(is); } - // The line below is a hack: the system id must an URI, but it is not - // cleat to get the URI of an resource, so just set the name of the + // The line below is a hack: the system id must a URI, but it is not + // cleat to get the URI of a resource, so just set the name of the // resource as a system id src.setSystemId(resourceToURI(resource)); return src; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java index 0358bdcf54..d014d5222c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.java @@ -48,7 +48,7 @@ import org.xml.sax.helpers.ParserAdapter; /** - * Checks XML files are valid (or only well formed). The + * Checks XML files are valid (or only well-formed). The * task uses the SAX2 parser implementation provided by JAXP by default * (probably the one that is used by Ant itself), but one can specify any * SAX1/2 parser if needed. @@ -132,7 +132,7 @@ public void setWarn(boolean bool) { * is true. *

    * If set to false, the validation will fail only if the parsed document - * is not well formed XML. + * is not well-formed XML. *

    * this option is ignored if the specified class * with {@link #setClassName(String)} is not a SAX2 XMLReader. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java index 4c6fb14e51..0d58859043 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.java @@ -246,7 +246,7 @@ public String getTask() { } /** - * Specifies the task number used to checkin + * Specifies the task number used to check in * the file (may use 'default'). * * @param v Value to assign to task. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java index a3b5ea46a1..ce06474794 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.java @@ -316,7 +316,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -334,7 +334,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java index aee78abfc0..a55ef99417 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.java @@ -445,7 +445,7 @@ private void getOutCommand(Commandline cmd) { if (getOut() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_OUT); @@ -463,7 +463,7 @@ private void getBranchCommand(Commandline cmd) { if (getBranch() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_BRANCH); @@ -481,7 +481,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -499,7 +499,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java index 7968cc3092..6f217d15e5 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.java @@ -318,7 +318,7 @@ private void getNusersCommand(Commandline cmd) { } /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_NUSERS); @@ -337,7 +337,7 @@ private void getCommentCommand(Commandline cmd) { } /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -356,7 +356,7 @@ private void getPnameCommand(Commandline cmd) { } /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_PNAME); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java index 0418b9cb87..5d011c9f98 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.java @@ -342,7 +342,7 @@ private void getVersionCommand(Commandline cmd) { if (getVersion() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_VERSION); @@ -360,7 +360,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -378,7 +378,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java index ea7c8ab621..d48dac9089 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.java @@ -327,7 +327,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -345,7 +345,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java index cbb3dde950..65c79d693e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.java @@ -77,7 +77,7 @@ public class CCMkdir extends ClearCase { */ public static final String FLAG_NOCOMMENT = "-nc"; /** - * -nco flag -- do not checkout element after creation + * -nco flag -- do not check out element after creation */ public static final String FLAG_NOCHECKOUT = "-nco"; @@ -179,7 +179,7 @@ public String getCommentFile() { } /** - * If true, do not checkout element after creation. + * If true, do not check out element after creation. * * @param co the status to set the flag to */ @@ -206,7 +206,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -224,7 +224,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java index d5feadd645..443d5c55aa 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.java @@ -110,7 +110,7 @@ public class CCMkelem extends ClearCase { */ public static final String FLAG_PRESERVETIME = "-ptime"; /** - * -nco flag -- do not checkout element after creation + * -nco flag -- do not check out element after creation */ public static final String FLAG_NOCHECKOUT = "-nco"; /** @@ -292,7 +292,7 @@ public boolean getPreserveTime() { } /** - * If true, do not checkout element after creation. + * If true, do not check out element after creation. * * @param co the status to set the flag to */ @@ -374,7 +374,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -392,7 +392,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); @@ -410,7 +410,7 @@ private void getEltypeCommand(Commandline cmd) { if (getEltype() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_ELTYPE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java index 15f1d09869..9aff9769b4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.java @@ -332,7 +332,7 @@ private void getVersionCommand(Commandline cmd) { if (getVersion() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_VERSION); @@ -350,7 +350,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -368,7 +368,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java index 2724ec8857..47322c4283 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.java @@ -386,7 +386,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -404,7 +404,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java index d3beadf6ea..0e40657f80 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.java @@ -339,7 +339,7 @@ private void getCommentCommand(Commandline cmd) { if (getComment() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -357,7 +357,7 @@ private void getCommentFileCommand(Commandline cmd) { if (getCommentFile() != null) { /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENTFILE); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java index 4493d1e8bb..02aea54d19 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.java @@ -218,7 +218,7 @@ private void getCommentCommand(Commandline cmd) { } /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_COMMENT); @@ -237,7 +237,7 @@ private void getPnameCommand(Commandline cmd) { } /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_PNAME); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java index 457d68f394..0b02a337f3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.java @@ -315,7 +315,7 @@ private void getLogCommand(Commandline cmd) { } /* Had to make two separate commands here because if a space is inserted between the flag and the value, it is treated as a - Windows filename with a space and it is enclosed in double + Windows filename with a space, and it is enclosed in double quotes ("). This breaks clearcase. */ cmd.createArgument().setValue(FLAG_LOG); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.java index 4a90744c16..2bcfee828e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.java @@ -63,7 +63,7 @@ public void read(InputStream stream) throws IOException, ClassFormatError { "No Magic Code Found - probably not a Java class file."); } - // right we have a good looking class file. + // right we have a good-looking class file. /* int minorVersion = */ classStream.readUnsignedShort(); /* int majorVersion = */ classStream.readUnsignedShort(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java index beb2d6f967..a88ee566b1 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/Depend.java @@ -475,7 +475,7 @@ private int deleteAffectedFiles(String className) { if (closure) { count += deleteAffectedFiles(affectedClass); } else { - // without closure we may delete an inner class but not the + // without closure, we may delete an inner class but not the // top level class which would not trigger a recompile. if (!affectedClass.contains("$")) { @@ -539,7 +539,7 @@ private void warnOutOfDateButNotDeleted( * test for being an RMI stub * @param affectedClass class being tested * @param className possible origin of the RMI stub - * @return whether the class affectedClass is a RMI stub + * @return whether the class affectedClass is an RMI stub */ private boolean isRmiStub(String affectedClass, String className) { return isStub(affectedClass, className, DefaultRmicAdapter.RMI_STUB_SUFFIX) @@ -595,7 +595,7 @@ private void determineOutOfDateClasses() { } ClassFileInfo info = classFileInfoMap.get(className); - // if we have no info about the class - it may have been deleted already and we + // if we have no info about the class - it may have been deleted already, and we // are using cached info. if (info != null) { for (File classpathFile : e.getValue()) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java index 2cf71aaf56..45a1631cf9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.java @@ -45,7 +45,7 @@ public class DirectoryIterator implements ClassFileIterator { /** * The current directory iterator. As directories encounter lower level * directories, the current iterator is pushed onto the iterator stack - * and a new iterator over the sub directory becomes the current + * and a new iterator over the subdirectory becomes the current * directory. This implements a depth first traversal of the directory * namespace. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.java b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.java index d781769b95..3cca901077 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.java @@ -47,7 +47,7 @@ public class ConstantPool { /** Initialise the constant pool. */ public ConstantPool() { - // The zero index is never present in the constant pool itself so + // The zero index is never present in the constant pool itself, so // we add a null entry for it entries.add(null); } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java index 483d34cfce..d5ce2dec26 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.java @@ -223,7 +223,7 @@ protected void addDeploymentTool(EJBDeploymentTool deploymentTool) { } /** - * Create a orion nested element used to configure a + * Create an orion nested element used to configure a * deployment tool for Orion server. * * @return the deployment tool instance to be configured. @@ -379,7 +379,7 @@ public void setManifest(File manifest) { /** * Sets the source directory, which is the directory that - * contains the classes that will be added to the EJB jar. Typically + * contains the classes that will be added to the EJB jar. Typically, * this will include the home and remote interfaces and the bean class. * * @param inDir the source directory. @@ -460,7 +460,7 @@ public File getDestdir() { * this directory. The jar files that exist in this directory are also * used when determining if the contents of the jar file have changed. * Note that this parameter is only used if no deployment tools are - * specified. Typically each deployment tool will specify its own + * specified. Typically, each deployment tool will specify its own * destination directory. * * @param inDir the destination directory in which to generate jars @@ -518,7 +518,7 @@ public void setFlatdestdir(boolean inValue) { /** * Set the suffix for the generated jar file. When generic jars are - * generated, they have a suffix which is appended to the the bean name + * generated, they have a suffix which is appended to the bean name * to create the name of the jar file. Note that this suffix includes * the extension fo te jar file and should therefore end with an * appropriate extension such as .jar or .ear @@ -570,7 +570,7 @@ private void validateConfig() throws BuildException { * Invoked by Ant after the task is prepared, when it is ready to execute * this task. * - * This will configure all of the nested deployment tools to allow them to + * This will configure all the nested deployment tools to allow them to * process the jar. If no deployment tools have been configured a generic * tool is created to handle the jar. * diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java index 228fbc9000..e893842b8e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.java @@ -373,7 +373,7 @@ protected DescriptorHandler getDescriptorHandler(File srcDir) { * * vendor-specific subclasses should override this method to define * the vendor-specific locations of the EJB DTDs - * @param handler no used in this class. + * @param handler not used in this class. */ protected void registerKnownDTDs(DescriptorHandler handler) { // none to register for generic @@ -388,7 +388,7 @@ public void processDescriptor(String descriptorFileName, SAXParser saxParser) { try { handler = getDescriptorHandler(config.srcDir); - // Retreive the files to be added to JAR from EJB descriptor + // Retrieve the files to be added to JAR from EJB descriptor Hashtable ejbFiles = parseEjbFiles(descriptorFileName, saxParser); // Add any support classes specified in the build file @@ -442,7 +442,7 @@ public void processDescriptor(String descriptorFileName, SAXParser saxParser) { String publicId = getPublicId(); writeJar(baseName, jarFile, ejbFiles, publicId); } else { - // Log that the file is up to date... + // Log that the file is up-to-date... log(jarFile.toString() + " is up to date.", Project.MSG_VERBOSE); } @@ -494,7 +494,7 @@ protected void checkConfiguration(String descriptorFileName, * added to the completed JAR file * @throws SAXException Any SAX exception, possibly wrapping another * exception - * @throws IOException An IOException from the parser, possibly from a + * @throws IOException An IOException from the parser, possibly from * the byte stream or character stream */ protected Hashtable parseEjbFiles(String descriptorFileName, SAXParser saxParser) @@ -647,10 +647,10 @@ File getVendorOutputJarFile(String baseName) { * * @param ejbFiles Hashtable of EJB classes (and other) files that will be * added to the completed JAR file - * @param jarFile JAR file which will contain all of the EJB classes (and + * @param jarFile JAR file which will contain all the EJB classes (and * other) files - * @return boolean indicating whether or not the jarFile - * is up to date + * @return boolean indicating whether the jarFile + * is up-to-date */ protected boolean needToRebuild(Hashtable ejbFiles, File jarFile) { if (jarFile.exists()) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java index 5a013f4762..76b851aab9 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.java @@ -50,13 +50,13 @@ * classpath specified in the parent "ejbjar" task. * Note that nested "classpath" elements may also be * used. - *

  • keepgenerated -- Indicates whether or not the Java source + *
  • keepgenerated -- Indicates whether the Java source * files which are generated by ejbc will be * saved or automatically deleted. If "yes", * the source files will be retained. This is * an optional attribute (if omitted, it * defaults to "no"). - *
  • debug -- Indicates whether or not the ejbc utility should + *
  • debug -- Indicates whether the ejbc utility should * log additional debugging statements to the standard * output. If "yes", the additional debugging statements * will be generated (if omitted, it defaults to "no"). @@ -103,14 +103,14 @@ public class IPlanetDeploymentTool extends GenericDeploymentTool { * The displayName variable stores the value of the "display-name" element * from the standard EJB descriptor. As a future enhancement to this task, * we may determine the name of the EJB JAR file using this display-name, - * but this has not be implemented yet. + * but this has not been implemented yet. */ @SuppressWarnings("unused") private String displayName; /* * Regardless of the name of the iAS-specific EJB descriptor file, it will - * written in the completed JAR file as "ias-ejb-jar.xml". This is the + * be written in the completed JAR file as "ias-ejb-jar.xml". This is the * naming convention implemented by iAS. */ private static final String IAS_DD = "ias-ejb-jar.xml"; @@ -139,7 +139,7 @@ public void setKeepgenerated(boolean keepgenerated) { } /** - * Sets whether or not debugging output will be generated when ejbc is + * Sets whether debugging output will be generated when ejbc is * executed. * * @param debug A boolean indicating if debugging output should be generated diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java index 7e5d8cc44e..d792af189f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.java @@ -146,7 +146,7 @@ public IPlanetEjbc(File stdDescriptor, this.parser = parser; /* - * Parse the classpath into it's individual elements and store the + * Parse the classpath into its individual elements and store the * results in the "classpathElements" instance variable. */ if (classpath != null) { @@ -402,7 +402,7 @@ private void callEjbc(String[] arguments) { } command += "ejbc "; - /* Concatenate all of the command line arguments into a single String */ + /* Concatenate all the command line arguments into a single String */ String args = String.join(" ", arguments); log(command + args); @@ -491,7 +491,7 @@ private EjbInfo[] getEjbs() throws IOException, SAXException { * command-line utility. * @param ejb The EJB for which stubs and skeletons will be compiled. * @return An array of Strings which are the command-line parameters for - * for the ejbc utility. + * the ejbc utility. */ private String[] buildArgumentList(EjbInfo ejb) { @@ -579,7 +579,7 @@ public EjbcException(String msg) { /** * This inner class is an XML document handler that can be used to parse EJB - * descriptors (both the standard EJB descriptor as well as the iAS-specific + * descriptors (both the standard EJB descriptor and the iAS-specific * descriptor that stores additional values for iAS). Once the descriptors * have been processed, the list of EJBs found can be obtained by calling * the getEjbs() method. @@ -897,10 +897,10 @@ public String getName() { } /* - * Below are getter's and setter's for each of the instance variables. + * Below are getters and setters for each of the instance variables. * Note that (in addition to supporting setters with the same type as - * the instance variable) a setter is provided with takes a String - * argument -- this are provided so the XML document handler can set + * the instance variable) a setter which takes a String argument + * is provided so the XML document handler can set * the EJB values using the Strings it parses. */ @@ -1077,7 +1077,7 @@ private void checkConfiguration(File buildDir) throws EjbcException { * * @param destDir The directory where the EJB source classes, stubs and * skeletons are located. - * @return A boolean indicating whether or not the ejbc utility needs to + * @return A boolean indicating whether the ejbc utility needs to * be run to bring the stubs and skeletons up to date. */ public boolean mustBeRecompiled(File destDir) { @@ -1146,7 +1146,7 @@ private long sourceClassesModified(File buildDir) { * Note that if ONLY the implementation class has changed, it's not * necessary to rebuild the EJB stubs and skeletons. For this * reason, we ensure the file exists (using lastModified above), but - * we DON'T compare it's timestamp with the timestamps of the home + * we DON'T compare its timestamp with the timestamps of the home * and remote interfaces (because it's irrelevant in determining if * ejbc must be run) */ @@ -1372,7 +1372,7 @@ public String getClassName() { /** * Gets the fully qualified name of the Java class with underscores * separating the components of the class name rather than periods. - * This format is used in naming some of the stub and skeleton classes + * This format is used in naming some stub and skeleton classes * for the iPlanet Application Server. * * @return String representing the fully qualified class name using diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.java index 1d575616ad..a32c0cecdb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.java @@ -54,13 +54,13 @@ * omitted, the classpath specified when Ant was * started will be used). Nested "classpath" * elements may also be used. - *
  • keepgenerated -- Indicates whether or not the Java source + *
  • keepgenerated -- Indicates whether the Java source * files which are generated by ejbc will be * saved or automatically deleted. If "yes", * the source files will be retained. This is * an optional attribute (if omitted, it * defaults to "no"). - *
  • debug -- Indicates whether or not the ejbc utility should + *
  • debug -- Indicates whether the ejbc utility should * log additional debugging statements to the standard * output. If "yes", the additional debugging statements * will be generated (if omitted, it defaults to "no"). @@ -78,7 +78,7 @@ * the EJB. If these class files cannot be located in the dest * directory, the task will fail. The task will also attempt to locate the EJB * stubs and skeletons in this directory. If found, the timestamps on the - * stubs and skeletons will be checked to ensure they are up to date. Only if + * stubs and skeletons will be checked to ensure they are up-to-date. Only if * these files cannot be found or if they are out of date will ejbc be called * to generate new stubs and skeletons. * diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java index 768e9cb6fe..71c8ac27f2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.java @@ -146,7 +146,7 @@ public class JonasDeploymentTool extends GenericDeploymentTool { private String rmicopts; /** - * Whether or not the RMI skeleton and stub must be modified to + * Whether the RMI skeleton and stub must be modified to * implement the implicit propagation of the security context (the * transactional context is always provided). The default is * false. @@ -797,11 +797,11 @@ private void deleteAllFiles(File aFile) { } /** - * Add a file to the a given hashtable. If the file is a directory, add - * recursivly all the files inside to the hashtable. + * Add a file to a given hashtable. If the file is a directory, add + * recursively all the files inside to the hashtable. * * @param file the file to add. - * @param rootDir the current sub-directory to scan. + * @param rootDir the current subdirectory to scan. * @param hashtable the hashtable where to add the files. */ private void addAllFiles(File file, String rootDir, Hashtable hashtable) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java index 018156be8f..e8832e0585 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.java @@ -446,7 +446,7 @@ protected void addVendorFiles(Hashtable ejbFiles, String ddPrefix) log("The old method for locating CMP files has been DEPRECATED.", Project.MSG_VERBOSE); log("Please adjust your weblogic descriptor and set newCMP=\"true\" to use the new CMP descriptor inclusion mechanism. ", Project.MSG_VERBOSE); - // The the WebLogic CMP deployment descriptor + // The WebLogic CMP deployment descriptor File weblogicCMPDD = new File(getConfig().descriptorDir, ddPrefix + WL_CMP_DD); if (weblogicCMPDD.exists()) { @@ -644,13 +644,13 @@ public void validateConfigured() throws BuildException { * * The way WebLogic ejbc works is it creates wrappers for the publicly * defined methods as they are exposed in the remote interface. If the - * actual bean changes without changing the the method signatures then + * actual bean changes without changing the method signatures then * only the bean classfile needs to be updated and the rest of the - * WebLogic jar file can remain the same. If the Interfaces, ie. the + * WebLogic jar file can remain the same. If the Interfaces, i.e. the * method signatures change or if the xml deployment descriptors changed, - * the whole jar needs to be rebuilt with ejbc. This is not strictly true + * the entire jar needs to be rebuilt with ejbc. This is not strictly true * for the xml files. If the JNDI name changes then the jar doesn't have to - * be rebuild, but if the resources references change then it does. At + * be rebuilt, but if the resources references change then it does. At * this point the WebLogic jar gets rebuilt if the xml files change at * all. * @@ -659,7 +659,7 @@ public void validateConfigured() throws BuildException { * see if it needs to be rebuilt. * @return true if the jar needs to be rebuilt. */ - // CheckStyle:MethodLength OFF - this will no be fixed + // CheckStyle:MethodLength OFF - this will not be fixed protected boolean isRebuildRequired(File genericJarFile, File weblogicJarFile) { boolean rebuild = false; @@ -689,7 +689,7 @@ protected boolean isRebuildRequired(File genericJarFile, File weblogicJarFile) { Map wlEntries = wlJar.stream().collect(Collectors.toMap(ZipEntry::getName, je -> je, (a, b) -> b)); - // Cycle through generic and make sure its in WebLogic + // Cycle through generic and make sure it's in WebLogic genericLoader = getClassLoaderFromJar(genericJarFile); for (String filepath : genericEntries.keySet()) { @@ -709,7 +709,7 @@ protected boolean isRebuildRequired(File genericJarFile, File weblogicJarFile) { || genericEntry.getSize() != wlEntry.getSize()) { if (genericEntry.getName().endsWith(".class")) { - //File are different see if its an object or an interface + //File are different see if it's an object or an interface String classname = genericEntry.getName() .replace(File.separatorChar, '.') .replace('/', '.'); @@ -729,7 +729,7 @@ protected boolean isRebuildRequired(File genericJarFile, File weblogicJarFile) { replaceEntries.put(filepath, genericEntry); } else if (!genericEntry.getName().equals("META-INF/MANIFEST.MF")) { // it is not the manifest, otherwise we'd ignore it - // File other then class changed rebuild + // File other than class changed - rebuild log("Non class file " + genericEntry.getName() + " has changed", Project.MSG_VERBOSE); rebuild = true; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.java index 0571f84337..abeccca8f7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.java @@ -45,7 +45,7 @@ public void setToplinkdescriptor(String inString) { /** * Setter used to store the location of the toplink DTD file. - * This is expected to be an URL (file or otherwise). If running + * This is expected to be a URL (file or otherwise). If running * this on NT using a file URL, the safest thing would be to not use a * drive spec in the URL and make sure the file resides on the drive that * ANT is running from. This will keep the setting in the build XML diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java index 8200601646..9a7e0cc735 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.java @@ -130,7 +130,7 @@ public class WebsphereDeploymentTool extends GenericDeploymentTool { /** Additional options for RMIC */ private String rmicOptions; - /** true- Use the WebSphere 3.5 compatible mapping rules */ + /** Use the WebSphere 3.5 compatible mapping rules if true */ private boolean use35MappingRules; /** the scratchdir for the ejbdeploy operation */ @@ -632,13 +632,13 @@ public void validateConfigured() throws BuildException { * * The way WebSphere ejbdeploy works is it creates wrappers for the * publicly defined methods as they are exposed in the remote interface. - * If the actual bean changes without changing the the method signatures + * If the actual bean changes without changing the method signatures * then only the bean classfile needs to be updated and the rest of the - * WebSphere jar file can remain the same. If the Interfaces, ie. the + * WebSphere jar file can remain the same. If the Interfaces, i.e. the * method signatures change or if the xml deployment descriptors changed, - * the whole jar needs to be rebuilt with ejbdeploy. This is not strictly + * the entire jar needs to be rebuilt with ejbdeploy. This is not strictly * true for the xml files. If the JNDI name changes then the jar doesn't - * have to be rebuild, but if the resources references change then it + * have to be rebuilt, but if the resources references change then it * does. At this point the WebSphere jar gets rebuilt if the xml files * change at all. * @@ -647,7 +647,7 @@ public void validateConfigured() throws BuildException { * see if it needs to be rebuilt. * @return true if a rebuild is required. */ - // CheckStyle:MethodLength OFF - this will no be fixed + // CheckStyle:MethodLength OFF - this will not be fixed protected boolean isRebuildRequired(File genericJarFile, File websphereJarFile) { boolean rebuild = false; @@ -697,7 +697,7 @@ protected boolean isRebuildRequired(File genericJarFile, File websphereJarFile) || genericEntry.getSize() != wasEntry.getSize()) { if (genericEntry.getName().endsWith(".class")) { - //File are different see if its an object or an interface + //File are different see if it's an object or an interface String classname = genericEntry.getName().replace(File.separatorChar, '.'); @@ -717,7 +717,7 @@ protected boolean isRebuildRequired(File genericJarFile, File websphereJarFile) } else { // is it the manifest. If so ignore it if (!genericEntry.getName().equals("META-INF/MANIFEST.MF")) { - //File other then class changed rebuild + //File other than class changed - rebuild log("Non class file " + genericEntry.getName() + " has changed", Project.MSG_VERBOSE); rebuild = true; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java index 73a78570e8..8d47e71ebe 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Extension.java @@ -130,7 +130,7 @@ public final class Extension { /** * Enum indicating that extension is incompatible with * other extension in ways other than other enums - * indicate). For example the other extension may have + * indicate. For example, the other extension may have * a different ID. */ public static final Compatibility INCOMPATIBLE @@ -236,7 +236,7 @@ public static void addExtension(final Extension extension, /** * Add Extension to the specified manifest Attributes. - * Use the specified prefix so that dependencies can added + * Use the specified prefix so that dependencies can be added * with a prefix such as "java3d-" etc. * * @param attributes the attributes of manifest to add to @@ -460,7 +460,7 @@ public Compatibility getCompatibilityWith(final Extension required) { * Return true if the specified Extension * (which represents an optional package required by an application) * is satisfied by this Extension (which represents an - * optional package that is already installed. Otherwise, return + * optional package that is already installed). Otherwise, return * false. * * @param required Description of the required optional package diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.java index 0a7b2d38ef..a68368f15d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.java @@ -34,7 +34,7 @@ public interface ExtensionResolver { * @param extension the extension * @param project the Ant project instance * @return the File satisfying extension, null - * if can not resolve extension + * if extension can not be resolved * @throws BuildException if error occurs attempting to * resolve extension */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.java index 2dd4fa7ecb..8774e3cdbf 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.java @@ -66,7 +66,7 @@ String getValue() { } /** - * Make sure that neither the name or the value + * Make sure that neither the name nor the value * is null. * * @throws BuildException if the attribute is invalid. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java index e7f55b501d..597b43b251 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.java @@ -61,7 +61,7 @@ public class JarLibResolveTask extends Task { private boolean checkExtension = true; /** - * Flag indicating whether or not you should + * Flag indicating whether you should * throw a BuildException if you cannot resolve * library. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java index 24494f610e..6a7e71dd8c 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.java @@ -27,14 +27,14 @@ */ public class LibFileSet extends FileSet { /** - * Flag indicating whether should include the + * Flag indicating whether to include the * "Implementation-URL" attribute in manifest. * Defaults to false. */ private boolean includeURL; /** - * Flag indicating whether should include the + * Flag indicating whether to include the * "Implementation-*" attributes in manifest. * Defaults to false. */ @@ -57,7 +57,7 @@ public class LibFileSet extends FileSet { private String urlBase; /** - * Flag indicating whether should include the + * Flag indicating whether to include the * "Implementation-URL" attribute in manifest. * Defaults to false. * @@ -68,7 +68,7 @@ public void setIncludeUrl(boolean includeURL) { } /** - * Flag indicating whether should include the + * Flag indicating whether to include the * "Implementation-*" attributes in manifest. * Defaults to false. * diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java index 1cb6833515..7c0bf28043 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/extension/Specification.java @@ -496,7 +496,7 @@ private static String getTrimmedString(final String value) { } /** - * Extract an Package Specification from Attributes. + * Extract a Package Specification from Attributes. * * @param attributes Attributes to searched * @return the new Specification object, or null diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java b/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java index f84aebe9cb..e17c2325a4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/i18n/Translate.java @@ -131,7 +131,7 @@ public class Translate extends MatchingTask { private String endToken; /** - * Whether or not to create a new destination file. + * Whether to create a new destination file. * Defaults to false. */ private boolean forceOverwrite; @@ -255,11 +255,11 @@ public void setBundleEncoding(String bundleEncoding) { } /** - * Whether or not to overwrite existing file irrespective of + * Whether to overwrite existing file irrespective of * whether it is newer than the source file as well as the * resource bundle file. * Defaults to false. - * @param forceOverwrite whether or not to overwrite existing files + * @param forceOverwrite whether to overwrite existing files */ public void setForceOverwrite(boolean forceOverwrite) { this.forceOverwrite = forceOverwrite; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java b/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java index cd04da5edc..d01fe7887d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/image/Image.java @@ -51,7 +51,7 @@ * DataType objects. The operations are arranged to conform to the * Chaining Model of JAI. Check out the JAI Programming Guide. * - * @deprecated JAI is not developed any more. Internal APIs that JAI depends on were + * @deprecated JAI is not developed anymore. Internal APIs that JAI depends on were * scheduled for removal in Java 7 and finally removed in Java 9. * @see org.apache.tools.ant.types.optional.image.ImageOperation * @see org.apache.tools.ant.types.DataType diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.java b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.java index dee9478364..99e69ffe1b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.java @@ -132,7 +132,7 @@ public void setAction(String action) { } /** - * Returns the source field (the path/filename of the component to be + * Returns the source field (the path/filename) of the component to be * deployed. * @return A File object representing the "source" attribute. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java index b552c8e35f..9be6f71244 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.java @@ -335,7 +335,7 @@ private String createOutputFileName(File destFile, String optionalOutputFile, /** * When running JJTree from an Ant taskdesk the -OUTPUT_DIRECTORY must * always be set. But when -OUTPUT_DIRECTORY is set, -OUTPUT_FILE is - * handled as if relative of this -OUTPUT_DIRECTORY. Thus when the + * handled as if relative of this -OUTPUT_DIRECTORY. Thus, when the * -OUTPUT_FILE is absolute or contains a drive letter we have a problem. * * @param destFile String diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java index 532afb5d19..88e6fcf494 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.java @@ -531,7 +531,7 @@ private static int getArchiveLocationIndex(File home) * @param home the javacc home path directory. * @throws BuildException thrown if the home directory is invalid * or if the archive could not be found despite attempts to do so. - * @return a the major version number + * @return the major version number */ protected static int getMajorVersionNumber(File home) throws BuildException { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java index ef9d0210a8..e69cb74374 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.java @@ -145,7 +145,7 @@ public File getOutputFile() { } /** - * Whether or not to halt on failure. Default: false. + * Whether to halt on failure. Default: false. * @param haltonerror the value to set */ public void setHaltonerror(boolean haltonerror) { @@ -440,7 +440,7 @@ public void execute() throws BuildException { // this comment extract from JUnit Task may also apply here // "in VM is not very nice since it could probably hang the - // whole build. IMHO this method should be avoided and it would be best + // whole build. IMHO this method should be avoided, and it would be best // to remove it in future versions. TBD. (SBa)" /** @@ -576,7 +576,7 @@ public int executeAsForked(CommandlineJava commandline, if (getOutputFile() != null) { // having a space between the file and its path causes commandline // to add quotes around the argument thus making JDepend not taking - // it into account. Thus we split it in two + // it into account. Thus, we split it in two commandline.createArgument().setValue("-file"); commandline.createArgument().setValue(outputFile.getPath()); // we have to find a cleaner way to put this output diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java index df02abe226..8d56ca913b 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.java @@ -119,7 +119,7 @@ public void setAddfiles(Path addfiles) { } /** - * Defines whether or not the output should be compacted. + * Defines whether the output should be compacted. * @param compress a boolean value */ public void setCompress(boolean compress) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java index 480c4cab04..45513aa191 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jlink/jlink.java @@ -383,7 +383,7 @@ For uncompressed (stored) files, those calls do work. } /* - * Necessary in the case where you add a entry that + * Necessary in the case where you add an entry that * is not compressed. */ private long calcChecksum(File f) throws IOException { @@ -392,7 +392,7 @@ private long calcChecksum(File f) throws IOException { } /* - * Necessary in the case where you add a entry that + * Necessary in the case where you add an entry that * is not compressed. */ private long calcChecksum(InputStream in) throws IOException { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java index 6b0fb5c0fa..2a7f26eb9e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/JspC.java @@ -186,7 +186,7 @@ public int getVerbose() { } /** - * Whether or not the build should halt if compilation fails. + * Whether the build should halt if compilation fails. * Defaults to true. * @param fail a boolean value. */ @@ -514,7 +514,7 @@ public void execute() /** * calculate where the files will end up: - * this is destDir or it id destDir + the package name + * this is either destDir or destDir + the package name */ private File getActualDestDir() { if (packageName == null) { @@ -579,7 +579,7 @@ protected void scanDir(File srcDir, File dest, JspMangler mangler, } /** - * Test whether or not compilation is needed. A return value of + * Test whether compilation is needed. A return value of * true means yes, false means * our tests do not indicate this, but as the TLDs are * not used for dependency checking this is not guaranteed. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java index 12cc6e889d..d6bf7ed192 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.java @@ -153,7 +153,7 @@ public void execute() throws BuildException { args[j++] = "-docroot"; args[j++] = sourceDirectory.getAbsolutePath().trim(); args[j++] = "-keepgenerated"; - //Call compiler as class... dont want to fork again + //Call compiler as class... don't want to fork again //Use classic compiler -- can be parameterised? args[j++] = "-compilerclass"; args[j++] = "sun.tools.javac.Main"; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java index 7ad3ed5ab0..ff71fe1819 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.java @@ -305,7 +305,7 @@ protected Resource getStylesheet() { "org/apache/tools/ant/taskdefs/optional/junit/xsl/" + xslname); return new URLResource(stylesheetURL); } - // If we are here, then the style dir is here and we + // If we are here, then the style dir is here, and we // should read the stylesheet from the filesystem return new FileResource(new File(styleDir, xslname)); } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java index 4e4b091467..6632a5a655 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.java @@ -232,7 +232,7 @@ public void addError(Test test, Throwable error) { } /** - * Format the test for printing.. + * Format the test for printing. * @param test a test * @return the formatted testname */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java index f45b844ee8..0e41ab02dc 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.java @@ -206,7 +206,7 @@ public static Node importNode(Node parent, Node child) { throw new IllegalStateException("Invalid node type: " + child.getNodeType()); } - // okay we have a copy of the child, now the child becomes the parent + // okay we have a copy of the child, now the child becomes the parent, // and we are iterating recursively over its children. try { final NodeList children = child.getChildNodes(); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java index 9761f18459..a09841c194 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.java @@ -148,7 +148,7 @@ private String getLocationName() { public void setProject(Project project) { // store project reference for logging super.setProject(project); - // check if already registered + // check if already registered; // register if needed if (project.getBuildListeners().stream().noneMatch(FailureRecorder.class::isInstance)) { verbose("Register FailureRecorder (@" + this.hashCode() + ") as BuildListener"); @@ -196,7 +196,7 @@ public void addFailure(Test test, AssertionFailedError error) { */ @Override public void setOutput(OutputStream out) { - // unused, close output file so it can be deleted before the VM exits + // unused, close output file, so it can be deleted before the VM exits if (out != System.out) { FileUtils.close(out); } @@ -433,7 +433,7 @@ public void targetStarted(BuildEvent event) { } /** - * The task outside of this JUnitResultFormatter is the <junit> task. So all tests passed + * The task outside this JUnitResultFormatter is the <junit> task. So all tests passed, * and we could create the new java class. * @param event not used * @see org.apache.tools.ant.BuildListener#taskFinished(org.apache.tools.ant.BuildEvent) diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java index b64f5af380..4c6db109fb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.java @@ -250,7 +250,7 @@ public void setUnless(String unlessCond) { /** * Ensures that the selector passes the conditions placed * on it with if and unless properties. - * @param t the task the this formatter is used in. + * @param t the task this formatter is used in. * @return true if the formatter should be used. */ public boolean shouldUse(Task t) { @@ -360,7 +360,7 @@ public String[] getValues() { /** * A standard FileOutputStream creates a file as soon as it's opened. This * class delays the creation of the file until the first time a caller attempts - * to write to it so we don't end up with empty files if the listeners don't use + * to write to it, so we don't end up with empty files if the listeners don't use * them. */ private static class DelayedFileOutputStream extends OutputStream { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java index 2f6b42e43e..25c997bc8e 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.java @@ -244,7 +244,7 @@ public void setHaltonerror(final boolean value) { } /** - * Property to set to "true" if there is a error in a test. + * Property to set to "true" if there is an error in a test. * *

    This property is applied on all BatchTest (batchtest) and * JUnitTest (test), however, it can possibly be overridden by @@ -280,7 +280,7 @@ public void setHaltonfailure(final boolean value) { * JUnitTest (test), however, it can possibly be overridden by * their own properties.

    * @param propertyName the name of the property to set in the - * event of an failure. + * event of a failure. * * @since Ant 1.4 */ @@ -565,7 +565,7 @@ public void setNewenvironment(final boolean newenv) { * before configuration in the build * script. * This allows attributes in the <junit> task - * be be defaults for the tests, but allows + * to be defaults for the tests, but allows * individual tests to override the defaults. * * @param test BaseTest @@ -631,7 +631,7 @@ public void setIncludeantruntime(final boolean b) { /** * If true, send any output generated by tests to Ant's logging system * as well as to the formatters. - * By default only the formatters receive the output. + * By default, only the formatters receive the output. * *

    Output will always be passed to the formatters and not by * shown by default. This option should for example be set for @@ -846,7 +846,7 @@ public void execute() throws BuildException { setupJUnitDelegate(); final List> testLists = new ArrayList<>(); - /* parallel test execution is only supported for multi-process execution */ + /* parallel test execution is only supported for multiprocess execution */ final int threads = !fork || forkMode.getValue().equals(ForkMode.ONCE) ? 1 : this.threads; final boolean forkPerTest = ForkMode.PER_TEST.equals(forkMode.getValue()); @@ -928,7 +928,7 @@ private List getNextTest(final Iterator> iter) { * popping subroutine and the logging messages were added. * * If one thread aborts due to a BuildException (haltOnError, haltOnFailure, or any other - * fatal reason, no new tests/batches will be started but the running threads will be + * fatal reason), no new tests/batches will be started but the running threads will be * permitted to complete. Additional tests may start in already-running batch-test threads. */ private void oneJunitThread(final Iterator> iter, final int threadId) { @@ -984,7 +984,7 @@ private void runTestsInThreads(final List> testList, final int n threads[i].start(); } - /* wait for all of the threads to complete. Not sure if the exception can actually occur in this use case. */ + /* wait for all the threads to complete. Not sure if the exception can actually occur in this use case. */ do { exceptionOccurred = false; @@ -998,7 +998,7 @@ private void runTestsInThreads(final List> testList, final int n } while (exceptionOccurred); /* an exception occurred in one of the threads - usually a haltOnError/Failure. - throw the exception again so it behaves like the single-thread case */ + throw the exception again, so it behaves like the single-thread case */ if (caughtBuildException != null) { throw new BuildException(caughtBuildException); } @@ -1396,7 +1396,7 @@ private void checkForkedPath(final CommandlineJava cmd) { } /** - * Compares URLs for equality but takes case-sensitivity into + * Compares URLs for equality but takes case sensitivity into * account when comparing file URLs and ignores the jar specific * part of the URL if present. */ @@ -1434,7 +1434,7 @@ private File createTempPropertiesFile(final String prefix) { /** - * Pass output sent to System.out to the TestRunner so it can + * Pass output sent to System.out to the TestRunner, so it can * collect it for the formatters. * * @param output output coming from System.out @@ -1460,7 +1460,7 @@ protected void handleOutput(final String output) { * Handle an input request by this task. * @see Task#handleInput(byte[], int, int) * This implementation delegates to a runner if it - * present. + * is present. * @param buffer the buffer into which data is to be read. * @param offset the offset into the buffer at which data is stored. * @param length the amount of data to read. @@ -1481,7 +1481,7 @@ protected int handleInput(final byte[] buffer, final int offset, final int lengt /** - * Pass output sent to System.out to the TestRunner so it can + * Pass output sent to System.out to the TestRunner, so it can * collect ot for the formatters. * * @param output output coming from System.out @@ -1500,7 +1500,7 @@ protected void handleFlush(final String output) { } /** - * Pass output sent to System.err to the TestRunner so it can + * Pass output sent to System.err to the TestRunner, so it can * collect it for the formatters. * * @param output output coming from System.err @@ -1520,7 +1520,7 @@ public void handleErrorOutput(final String output) { /** - * Pass output sent to System.err to the TestRunner so it can + * Pass output sent to System.err to the TestRunner, so it can * collect it for the formatters. * * @param output coming from System.err @@ -1539,7 +1539,7 @@ public void handleErrorFlush(final String output) { } // in VM is not very nice since it could probably hang the - // whole build. IMHO this method should be avoided and it would be best + // whole build. IMHO this method should be avoided, and it would be best // to remove it in future versions. TBD. (SBa) /** @@ -1670,7 +1670,7 @@ protected Enumeration getIndividualTests() { * Verifies all test elements having the methods * attribute specified and having the if-condition resolved * to true, that the value of the methods attribute is valid. - * @exception BuildException if some of the tests matching the described + * @exception BuildException if some tests matching the described * conditions has invalid value of the * methods attribute * @since 1.8.2 @@ -2143,7 +2143,7 @@ public String[] getValues() { /** * Executes all tests that don't need to be forked (or all tests - * if the runIndividual argument is true. Returns a collection of + * if the runIndividual argument is true). Returns a collection of * lists of tests that share the same VM configuration and haven't * been executed yet. * @param testList the list of tests to be executed or queued. @@ -2157,7 +2157,7 @@ protected Collection> executeOrQueue( new HashMap<>(); for (final JUnitTest test : Collections.list(testList)) { if (test.shouldRun(getProject())) { - /* with multi-threaded runs need to defer execution of even */ + /* with multithreaded runs need to defer execution of even */ /* individual tests so the threads can pick tests off the queue. */ if ((runIndividual || !test.getFork()) && threads == 1) { execute(test, 0); @@ -2336,9 +2336,9 @@ private static void printlnDual(final BufferedWriter w, final PrintStream s, fin } /** - * Checks if a path exists and is non empty. + * Checks if a path exists and is non-empty. * @param path to be checked - * @return true if the path is non null and non empty. + * @return true if the path is non null and non-empty. * @since 1.9.8 */ private static boolean hasPath(final Path path) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java index 8c35e9d523..702e9953ed 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.java @@ -157,7 +157,7 @@ public class JUnitTestRunner implements TestListener, JUnitTaskMirror.JUnitTestR /** is this runner running in forked mode? */ private boolean forked = false; - /** ClassLoader passed in in non-forked mode. */ + /** ClassLoader passed in non-forked mode. */ private final ClassLoader loader; /** Do we print TestListener events? */ @@ -639,7 +639,7 @@ private static boolean containsTests(final Class testClass, final boolean isJ } if (runWithAnnotation != null && testClass.getAnnotation(runWithAnnotation) != null) { /* Class is marked with @RunWith. If this class is badly written (no test methods, - * multiple constructors, private constructor etc) then the class is automatically + * multiple constructors, private constructor, etc.) then the class is automatically * run and fails in the IDEs I've tried... so I'm happy handing the class to JUnit * to try and run, and let JUnit report a failure if a bad test case is provided. * Trying to do anything else is likely to result in us filtering out cases that diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.java index cca3e67c94..ffd7a7c46a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.java @@ -55,7 +55,7 @@ public class SummaryJUnitResultFormatter * Insures that a line of log output is written and flushed as a single * operation, to prevent lines from being spliced into other lines. * (Hopefully this solves the issue of run on lines - - * [junit] Tests Run: 2 Failures: 2 [junit] Tests run: 5... + * [junit] Tests Run: 2 Failures: 2 [junit] Tests run: 5...) * synchronized doesn't seem to be to harsh a penalty since it only * occurs twice per test - at the beginning and end. Note that message * construction occurs outside the locked block. @@ -177,7 +177,7 @@ public void endTestSuite(JUnitTest suite) throws BuildException { sb.append(nf.format(suite.getRunTime() / ONE_SECOND)); sb.append(" sec"); - /* class name needed with multi-threaded execution because + /* class name needed with multithreaded execution because results line may not appear immediately below start line. only write thread id, class name in multi-thread mode so the line still looks as much like the old line as possible. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java index 4eac79acba..f788cef678 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.java @@ -59,7 +59,7 @@ public class XMLResultAggregator extends Task implements XMLConstants { // CheckStyle:VisibilityModifier OFF - bc - /** the list of all filesets, that should contains the xml to aggregate */ + /** the list of all filesets, that should contain the xml to aggregate */ protected Vector filesets = new Vector<>(); /** the name of the result file */ @@ -118,8 +118,8 @@ public void setTofile(String value) { /** * Set the destination directory where the results should be written. If not - * set if will use {@link #DEFAULT_DIR}. When given a relative directory - * it will resolve it from the project directory. + * set, {@link #DEFAULT_DIR} will be used. When given a relative directory + * it will be resolved from the project directory. * @param value the directory where to write the results, absolute or * relative. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/AbstractJUnitResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/AbstractJUnitResultFormatter.java index be70e94ddd..d39ee4511f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/AbstractJUnitResultFormatter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/AbstractJUnitResultFormatter.java @@ -192,7 +192,7 @@ protected void handleException(final Throwable t) { This store first uses a relatively decent sized in-memory buffer for storing the sysout/syserr content. This in-memory buffer will be used as long as it can fit in the new content that keeps coming in. When the size limit is reached, this store switches to a file based store - by creating a temporarily file and writing out the already in-memory held buffer content + by creating a temporary file and writing out the already in-memory held buffer content and any new content that keeps arriving to this store. Once the file has been created, the in-memory buffer will never be used any more and in fact is destroyed as soon as the file is created. @@ -255,7 +255,7 @@ private void store(final byte[] data) throws IOException { private void storeToFile(final byte[] data, final int offset, final int length) throws IOException { if (this.fileOutputStream == null) { - // no backing file was created so we can't do anything + // no backing file was created, so we can't do anything return; } this.fileOutputStream.write(data, offset, length); diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/LauncherSupport.java b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/LauncherSupport.java index 00b76df8a2..53ea5d3e10 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/LauncherSupport.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/LauncherSupport.java @@ -74,18 +74,18 @@ * This class relies on a {@link LaunchDefinition} for setting up the launch of the * JUnit platform. *

    - * The {@code LauncherSupport} isn't concerned with whether or not + * The {@code LauncherSupport} isn't concerned with whether * it's being executed in the same JVM as the build in which the {@code junitlauncher} - * was triggered or if it's running as part of a forked JVM. Instead it just relies + * was triggered or if it's running as part of a forked JVM. Instead, it just relies * on the {@code LaunchDefinition} to do whatever decisions need to be done before and * after launching the tests. *

    * This class is not thread-safe and isn't expected to be used for launching from * multiple different threads simultaneously. *

    This class is an internal implementation detail of the Ant project and although - * it's a public class, it isn't meant to be used outside of this project. This class + * it's a public class, it isn't meant to be used outside this project. This class * can be changed, across releases, without any backward compatible guarantees and hence - * shouldn't be used or relied upon outside of this project. + * shouldn't be used or relied upon outside this project. */ public class LauncherSupport { @@ -133,7 +133,7 @@ public void launch() throws BuildException { // for this request. final Listener firstListener = new Listener(System.out); // we always enroll the summary generating listener, to the request, so that we - // get to use some of the details of the summary for our further decision making + // get to use some details of the summary for our further decision-making testExecutionListeners.add(firstListener); testExecutionListeners.addAll(getListeners(testRequest, this.launchDefinition.getClassLoader())); final PrintStream originalSysOut = System.out; @@ -293,7 +293,7 @@ private Path getListenerOutputFile(final TestRequest testRequest, final Listener if (test.getOutputDir() != null) { return Paths.get(test.getOutputDir(), filename); } - // neither listener nor the test define a output dir, so use basedir of the project + // neither listener nor the test define an output dir, so use basedir of the project final TestExecutionContext testExecutionContext = this.testExecutionContext; final String baseDir = testExecutionContext.getProperties().getProperty(MagicNames.PROJECT_BASEDIR); return Paths.get(baseDir, filename); @@ -367,7 +367,7 @@ private Optional trySwitchSysOutErr(final TestRequest test } default: { // unknown, but no need to error out, just be lenient - // and return back + // and return return Optional.empty(); } } @@ -551,7 +551,7 @@ public void run() { streamContentDeliver.stop = true; // just "wakeup" the delivery thread, to take into account // those race conditions, where that other thread didn't yet - // notice that it was asked to stop and has now gone into a + // notice that it was asked to stop and has now gone into an // X amount of wait, waiting for any new data streamContentDeliver.availableData.offer(EMPTY); } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/TestResultFormatter.java b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/TestResultFormatter.java index 4de168a774..509eaa9a56 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/TestResultFormatter.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/TestResultFormatter.java @@ -52,7 +52,7 @@ public interface TestResultFormatter extends TestExecutionListener, Closeable { /** * This method will be invoked by the {@code junitlauncher} to let the result formatter implementation - * know whether or not to use JUnit 4 style, legacy reporting names for test identifiers that get + * know whether to use JUnit 4 style legacy reporting names for test identifiers that get * displayed in the test reports. Result formatter implementations are allowed to default to a specific * reporting style for test identifiers, if this method isn't invoked. * @param useLegacyReportingName {@code true} if legacy reporting name is to be used, {@code false} diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/confined/JUnitLauncherTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/confined/JUnitLauncherTask.java index dbe8a1f3ad..5b3dbd6f54 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/confined/JUnitLauncherTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/junitlauncher/confined/JUnitLauncherTask.java @@ -433,8 +433,8 @@ private ClassLoader createInVMExecutionClassLoader() { // - if it does, then we use the Ant runtime classpath plus the task's configured classpath // with the traditional parent first loading. // - else (i.e. Ant runtime classpath doesn't have JUnit platform classes), then we - // expect/assume the task's configured classpath to have the JUnit platform classes and we - // then create a "overriding" classloader which prefers certain resources (specifically the classes + // expect/assume the task's configured classpath to have the JUnit platform classes, and we + // then create an "overriding" classloader which prefers certain resources (specifically the classes // from org.apache.tools.ant.taskdefs.optional.junitlauncher package), from the task's // classpath, even if the Ant's runtime classpath has those resources. if (JUnitLauncherClassPathUtil.hasJUnitPlatformResources(JUnitLauncherTask.class.getClassLoader())) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java index 8662993fd7..573dde4881 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTP.java @@ -188,7 +188,7 @@ public class FTP extends Task implements FTPTaskConfig { }; /** - * internal class providing a File-like interface to some of the information + * internal class providing a File-like interface to some information * available from the FTP server * */ @@ -200,7 +200,7 @@ protected static class FTPFileProxy extends File { private final String name; /** - * creates a proxy to a FTP file + * creates a proxy to an FTP file * @param file FTPFile */ public FTPFileProxy(FTPFile file) { @@ -211,7 +211,7 @@ public FTPFileProxy(FTPFile file) { } /** - * creates a proxy to a FTP directory + * creates a proxy to an FTP directory * @param completePath the remote directory. */ public FTPFileProxy(String completePath) { @@ -450,9 +450,9 @@ && remoteSystemCaseSensitive && isFollowSymlinks()) { //we do not need to scan all the subdirs in the relative path path = myfile.getFastRelativePath(); } else { - // may be on a case insensitive file system. We want + // may be on a case-insensitive file system. We want // the results to show what's really on the disk, so - // we need to double check. + // we need to double-check. try { path = myfile.getRelativePath(); traversesSymlinks = myfile.isTraverseSymlinks(); @@ -674,7 +674,7 @@ private void clearCaches() { /** * list the files present in one directory. * @param directory full path on the remote side - * @param changedir if true change to directory directory before listing + * @param changedir if true change to directory directory before listing * @return array of FTPFile */ public FTPFile[] listFiles(String directory, boolean changedir) { @@ -872,7 +872,7 @@ public AntFTPFile(AntFTPFile parent, String path) { } /** - * find a file in a directory in case insensitive way + * find a file in a directory in case-insensitive way * @param parentPath where we are * @param soughtPathElement what is being sought * @return the first file found or null if not found @@ -928,8 +928,8 @@ public String getAbsolutePath() { /** * find out the relative path assuming that the path used to construct - * this AntFTPFile was spelled properly with regards to case. - * This is OK on a case sensitive system such as UNIX + * this AntFTPFile was spelled properly with regard to case. + * This is OK on a case-sensitive system such as UNIX * @return relative path */ public String getFastRelativePath() { @@ -970,7 +970,7 @@ public String getRelativePath() throws IOException, BuildException { /** * get the relative path of this file * @param currentPath base path - * @param currentRelativePath relative path of the base path with regards to remote dir + * @param currentRelativePath relative path of the base path with regard to remote dir * @return relative path */ private String getRelativePath(String currentPath, String currentRelativePath) { @@ -1153,9 +1153,9 @@ public String getRelativePath() throws BuildException, IOException { } /** - * check FTPFiles to check whether they function as directories too - * the FTPFile API seem to make directory and symbolic links incompatible - * we want to find out if we can cd to a symbolic link + * Check FTPFiles whether they function as directories, too. + * The FTPFile API seems to make directory and symbolic links incompatible; + * we want to find out if we can cd to a symbolic link. * @param dir the parent directory of the file to test * @param file the file to test * @return true if it is possible to cd to this directory @@ -1215,9 +1215,9 @@ private boolean isFunctioningAsDirectory(FTPClient ftp, String dir, FTPFile file } /** - * check FTPFiles to check whether they function as directories too - * the FTPFile API seem to make directory and symbolic links incompatible - * we want to find out if we can cd to a symbolic link + * Check FTPFiles whether they function as directories, too. + * The FTPFile API seems to make directory and symbolic links incompatible; + * we want to find out if we can cd to a symbolic link. * @param dir the parent directory of the file to test * @param file the file to test * @return true if it is possible to cd to this directory @@ -2100,11 +2100,11 @@ private File findFileName(FTPClient ftp) { /** * Checks to see if the remote file is current as compared with the local - * file. Returns true if the target file is up to date. + * file. Returns true if the target file is up-to-date. * @param ftp ftpclient * @param localFile local file * @param remoteFile remote file - * @return true if the target file is up to date + * @return true if the target file is up-to-date * @throws IOException in unknown circumstances * @throws BuildException if the date of the remote files cannot be found and the action is * GET_FILES @@ -2199,7 +2199,7 @@ protected void doSiteCommand(FTPClient ftp, String theCMD) * simplifies the coding. * @param ftp ftp client * @param dir base directory of the file to be sent (local) - * @param filename relative path of the file to be send + * @param filename relative path of the file to be sent * locally relative to dir * remotely relative to the remotedir attribute * @throws IOException in unknown circumstances @@ -2485,7 +2485,7 @@ private void handleMkDirFailure(FTPClient ftp) } /** - * checks if the wake up interval is expired + * checks if the wake-up interval is expired */ private boolean wakeUpTransferIntervalExpired() { boolean result = false; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPConfigurator.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPConfigurator.java index ba659dcbb8..749c57f784 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPConfigurator.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPConfigurator.java @@ -22,10 +22,10 @@ import org.apache.tools.ant.Project; /** - * The sole purpose of this class is (note that it is package-private - * is to serve as a separate, static compilation unit for importing + * The sole purpose of this class is (note that it is package-private) + * to serve as a separate, static compilation unit for importing * FTPClientConfig, to enable users who wish to use the FTP task - * without using its new features to avoid the need to + * without using its new features to avoid the need to * upgrade to jakarta-commons-net 1.4.0, where FTPClientConfig was * introduced. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java index 3d45cb105c..01b6493ec3 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.java @@ -81,7 +81,7 @@ public FTPTaskMirrorImpl(FTPTask task) { } /** - * internal class providing a File-like interface to some of the information + * internal class providing a File-like interface to some information * available from the FTP server * */ @@ -93,7 +93,7 @@ protected static class FTPFileProxy extends File { private final String name; /** - * creates a proxy to a FTP file + * creates a proxy to an FTP file * @param file FTPFile */ public FTPFileProxy(FTPFile file) { @@ -104,7 +104,7 @@ public FTPFileProxy(FTPFile file) { } /** - * creates a proxy to a FTP directory + * creates a proxy to an FTP directory * @param completePath the remote directory. */ public FTPFileProxy(String completePath) { @@ -334,9 +334,9 @@ && remoteSystemCaseSensitive && isFollowSymlinks()) { //we do not need to scan all the subdirs in the relative path path = myfile.getFastRelativePath(); } else { - // may be on a case insensitive file system. We want + // may be on a case-insensitive file system. We want // the results to show what's really on the disk, so - // we need to double check. + // we need to double-check. try { path = myfile.getRelativePath(); traversesSymlinks = myfile.isTraverseSymlinks(); @@ -551,7 +551,7 @@ private void clearCaches() { /** * list the files present in one directory. * @param directory full path on the remote side - * @param changedir if true change to directory directory before listing + * @param changedir if true change to directory directory before listing * @return array of FTPFile */ public FTPFile[] listFiles(String directory, boolean changedir) { @@ -747,7 +747,7 @@ public AntFTPFile(AntFTPFile parent, String path) { this.ftpFile = getFile(listFiles(this.curpwd), lastpathelement); } /** - * find a file in a directory in case insensitive way + * find a file in a directory in case-insensitive way * @param parentPath where we are * @param soughtPathElement what is being sought * @return the first file found or null if not found @@ -802,8 +802,8 @@ public String getAbsolutePath() { /** * find out the relative path assuming that the path used to construct - * this AntFTPFile was spelled properly with regards to case. - * This is OK on a case sensitive system such as UNIX + * this AntFTPFile was spelled properly with regard to case. + * This is OK on a case-sensitive system such as UNIX * @return relative path */ public String getFastRelativePath() { @@ -845,7 +845,7 @@ public String getRelativePath() throws IOException, BuildException { /** * get the relative path of this file * @param currentPath base path - * @param currentRelativePath relative path of the base path with regards to remote dir + * @param currentRelativePath relative path of the base path with regard to remote dir * @return relative path */ private String getRelativePath(String currentPath, String currentRelativePath) { @@ -1030,9 +1030,9 @@ public String getRelativePath() throws BuildException, IOException { } /** - * check FTPFiles to check whether they function as directories too - * the FTPFile API seem to make directory and symbolic links incompatible - * we want to find out if we can cd to a symbolic link + * Check FTPFiles whether they function as directories, too. + * The FTPFile API seems to make directory and symbolic links incompatible; + * we want to find out if we can cd to a symbolic link. * @param dir the parent directory of the file to test * @param file the file to test * @return true if it is possible to cd to this directory @@ -1081,9 +1081,9 @@ private boolean isFunctioningAsDirectory(FTPClient ftp, String dir, FTPFile file } /** - * check FTPFiles to check whether they function as directories too - * the FTPFile API seem to make directory and symbolic links incompatible - * we want to find out if we can cd to a symbolic link + * Check FTPFiles whether they function as directories, too. + * The FTPFile API seems to make directory and symbolic links incompatible; + * we want to find out if we can cd to a symbolic link. * @param dir the parent directory of the file to test * @param file the file to test * @return true if it is possible to cd to this directory @@ -1399,11 +1399,11 @@ private File findFileName(FTPClient ftp) { /** * Checks to see if the remote file is current as compared with the local - * file. Returns true if the target file is up to date. + * file. Returns true if the target file is up-to-date. * @param ftp ftpclient * @param localFile local file * @param remoteFile remote file - * @return true if the target file is up to date + * @return true if the target file is up-to-date * @throws IOException in unknown circumstances * @throws BuildException if the date of the remote files cannot be found and the action is * GET_FILES @@ -1498,7 +1498,7 @@ protected void doSiteCommand(FTPClient ftp, String theCMD) * simplifies the coding. * @param ftp ftp client * @param dir base directory of the file to be sent (local) - * @param filename relative path of the file to be send + * @param filename relative path of the file to be sent * locally relative to dir * remotely relative to the remotedir attribute * @throws IOException in unknown circumstances diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java index 12fae86fbb..2ec3e6efc4 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/RExecTask.java @@ -41,12 +41,12 @@ public class RExecTask extends Task { private static final int PAUSE_TIME = 250; /** - * The userid to login with, if automated login is used + * The userid to log in with, if automated login is used */ private String userid = null; /** - * The password to login with, if automated login is used + * The password to log in with, if automated login is used */ private String password = null; @@ -134,7 +134,7 @@ public void execute(AntRExecClient rexec) } /** - * Whether or not the message should be echoed to the log. + * Whether the message should be echoed to the log. * Defaults to true. * @param b a boolean value */ @@ -145,7 +145,7 @@ public void setEcho(boolean b) { /** * Reads the output from the connected server - * until the required string is found or we time out. + * until the required string is found, or we time out. */ public class RExecRead extends RExecSubTask { private Integer timeout = null; @@ -181,7 +181,7 @@ public void setDefaultTimeout(Integer defaultTimeout) { /** * This class handles the abstraction of the rexec protocol. - * Currently it is a wrapper around Jakarta * Commons Net. */ @@ -328,7 +328,7 @@ public RExecSubTask createRead() { * Add text to send to the server * A subTask <write> tag was found. Create the object, * Save it in our list, and return it. - * @return a write sub task + * @return a write sub-task */ public RExecSubTask createWrite() { RExecSubTask task = new RExecWrite(); @@ -413,7 +413,7 @@ private void login(AntRExecClient rexec) { } /** - * Set the the command to execute on the server; + * Set the command to execute on the server; * @param c a String value */ public void setCommand(String c) { @@ -429,7 +429,7 @@ public void setInitialCR(boolean b) { } /** - * Set the the login password to use + * Set the login password to use * required if userid is set. * @param p a String value */ @@ -463,7 +463,7 @@ public void setTimeout(Integer i) { } /** - * Set the the login id to use on the server; + * Set the login id to use on the server; * required if password is set. * @param u a String value */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java index 4dd70e5291..e03d75627f 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/SetProxy.java @@ -28,7 +28,7 @@ /** * Sets Java's web proxy properties, so that tasks and code run in - * the same JVM can have through-the-firewall access to remote web sites, + * the same JVM can have through-the-firewall access to remote websites, * and remote ftp sites. * You can nominate an http and ftp proxy, or a socks server, reset the server * settings, or do nothing at all. @@ -84,7 +84,7 @@ public class SetProxy extends Task { /** - * list of non proxy hosts + * list of non-proxy hosts */ private String nonProxyHosts = null; diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java index cbc9f37097..5a9ef58186 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.java @@ -39,12 +39,12 @@ public class TelnetTask extends Task { private static final int TELNET_PORT = 23; /** - * The userid to login with, if automated login is used + * The userid to log in with, if automated login is used */ private String userid = null; /** - * The password to login with, if automated login is used + * The password to log in with, if automated login is used */ private String password = null; @@ -149,7 +149,7 @@ private void login(AntTelnetClient telnet) { } /** - * Set the the login id to use on the server; + * Set the login id to use on the server; * required if password is set. * @param u a String value */ @@ -158,7 +158,7 @@ public void setUserid(String u) { } /** - * Set the the login password to use + * Set the login password to use * required if userid is set. * @param p a String value */ @@ -216,7 +216,7 @@ public TelnetSubTask createRead() { * Add text to send to the server * A subTask <write> tag was found. Create the object, * Save it in our list, and return it. - * @return a write telnet sub task + * @return a write telnet sub-task */ public TelnetSubTask createWrite() { TelnetSubTask task = new TelnetWrite(); @@ -276,7 +276,7 @@ public void execute(AntTelnetClient telnet) } /** - * Whether or not the message should be echoed to the log. + * Whether the message should be echoed to the log. * Defaults to true. * @param b a boolean value */ @@ -287,7 +287,7 @@ public void setEcho(boolean b) { /** * Reads the output from the connected server - * until the required string is found or we time out. + * until the required string is found, or we time out. */ public class TelnetRead extends TelnetSubTask { private Integer timeout = null; @@ -323,7 +323,7 @@ public void setDefaultTimeout(Integer defaultTimeout) { /** * This class handles the abstraction of the telnet protocol. - * Currently it is a wrapper around Jakarta * Commons Net. */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java index c31ae3570e..a14f44e7b8 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.java @@ -409,7 +409,7 @@ public String getLineStart() { /** * What a valid return value from PVCS looks like * when it describes a file. Defaults to "P:. - * If you are not using an UNC name for your repository and the + * If you are not using a UNC name for your repository and the * drive letter P is incorrect for your setup, you may * need to change this value, UNC names will always be * accepted. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java b/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java index 1c21cf2066..fcea43fc1d 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.java @@ -248,7 +248,7 @@ public void execute() { "scriptdef requires a src attribute if the encoding is set"); } - // Check if need to set the loader + // Check if the loader must be set if (getAntlibClassLoader() != null || hasCpDelegate()) { helper.setClassLoader(createLoader()); } diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java index 50cc745615..40fd001ae8 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOS.java @@ -177,7 +177,7 @@ public void setVerbose(boolean verbose) { this.verbose = verbose; } - // Special setters for the sub-classes + // Special setters for the subclasses /** * Set the file name. diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java index 73481ff101..5695444d52 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.java @@ -37,7 +37,7 @@ public void setVersion(String version) { } /** - * The label to apply the the files in SourceSafe. + * The label to apply the files in SourceSafe. * * @param label The new label value * diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html b/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html index f0915ae8dc..e3764b63a7 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sos/package.html @@ -24,9 +24,9 @@ Ant tasks for working with a SourceOffSite source control system.

    -
    <SOSGet>
    Retrieves file(s) from a SOS database
    -
    <SOSCheckin>
    Commits and unlocks file(s) in a SOS database
    -
    <SOSCheckout>
    Retrieves and lock file(s) in a SOS database
    +
    <SOSGet>
    Retrieves file(s) from an SOS database
    +
    <SOSCheckin>
    Commits and unlocks file(s) in an SOS database
    +
    <SOSCheckout>
    Retrieves and lock file(s) in an SOS database
    <SOSLabel>
    Label a SOS database
    diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.java b/src/main/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.java index 623fb61367..652e94742a 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.java @@ -237,7 +237,7 @@ public void taskStarted(BuildEvent event) { /** * Fired when a task has finished. This event will still - * be throw if an error occurred during the build. + * be thrown if an error occurred during the build. * @param event ignored. * @see BuildEvent#getException() */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.java index 9193627ef6..5708fc0673 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.java @@ -39,7 +39,7 @@ * to work fine. * * plans for the future: - * - use the midi api to define sounds (or drum beat etc) in xml and have + * - use the midi api to define sounds (or drum beat, etc.) in xml and have * Ant play them back * */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java b/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java index 3518cf3595..73f24ebf94 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.java @@ -52,7 +52,7 @@ public class SplashTask extends Task { private String progressRegExp = null; private String displayText = null; - // class instance so we'll never show two splash screens at the same time + // class instance, so we'll never show two splash screens at the same time private static SplashScreen splash = null; /** @@ -135,7 +135,7 @@ public void setShowduration(int duration) { * and dig out current progress optional; if not provided, * progress is increased every action and log output line * @param progressRegExp Progress regular expression, exactly one - * group pattern must exists, and it represents the progress + * group pattern must exist, and it represents the progress * number (0-100) (i.e "Progress: (.*)%") * @since Ant 1.8.0 */ diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java index 16d3b1fdea..3601062ef2 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.java @@ -203,7 +203,7 @@ public void showMessage(String message) { * @param instruction not used. * @param prompt the method checks if this is one in length. * @param echo the method checks if the first element is false. - * @return the password in an size one array if there is a password + * @return the password in a size one array if there is a password * and if the prompt and echo checks pass. */ @Override diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.java b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.java index 93e3554d96..95bae8f0d0 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.java @@ -188,7 +188,7 @@ private void startRemoteCpProtocol(final InputStream in, File startFile = localFile; while (true) { // C0644 filesize filename - header for a regular file - // T time 0 time 0\n - present if perserve time. + // T time 0 time 0\n - present if preserve time. // D directory - this is the header for a directory. final ByteArrayOutputStream stream = new ByteArrayOutputStream(); while (true) { @@ -222,7 +222,7 @@ private void startRemoteCpProtocol(final InputStream in, private File parseAndCreateDirectory(final String serverResponse, final File localFile) { int start = serverResponse.indexOf(' '); - // appears that the next token is not used and it's zero. + // appears that the next token is not used, and it's zero. start = serverResponse.indexOf(' ', start + 1); final String directoryName = serverResponse.substring(start + 1); if (localFile.isDirectory()) { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.java b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.java index c6266bf330..1c85330b48 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.java @@ -290,7 +290,7 @@ private void sendFileToRemote(final ChannelSftp channel, channel.put(localFile.getAbsolutePath(), remotePath, monitor); // set the fileMode on the transferred file. The "remotePath" can potentially be a directory // into which the file got transferred, so we can't/shouldn't go ahead and try to change that directory's - // permissions. Instead we determine the path of the transferred file on remote. + // permissions. Instead, we determine the path of the transferred file on remote. final String transferredFileRemotePath; if (channel.stat(remotePath).isDir()) { // Note: It's correct to use "/" as the file separator without worrying about what the remote diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java b/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java index 863be82a8a..53f298f1cb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/testing/Funtest.java @@ -474,7 +474,7 @@ public void execute() throws BuildException { } } - //we get here whether or not the tests/teardown have thrown a BuildException. + //we get here whether the tests/teardown have thrown a BuildException. //do a forced shutdown of the running application, before processing the faults try { diff --git a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java index 64486047cc..8f75207955 100644 --- a/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java +++ b/src/main/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.java @@ -101,7 +101,7 @@ public abstract class MSVSS extends Task implements MSVSSConstants { private WritableFiles writableFiles = null; /** - * Each sub-class must implement this method and return the constructed + * Each subclass must implement this method and return the constructed * command line to be executed. It is up to the sub-task to determine the * required attributes and their order. * @return The Constructed command line. @@ -110,7 +110,7 @@ public abstract class MSVSS extends Task implements MSVSSConstants { /** * Directory where ss.exe resides. - * By default the task expects it to be in the PATH. + * By default, the task expects it to be in the PATH. * @param dir The directory containing ss.exe. */ public final void setSsdir(String dir) { @@ -188,7 +188,7 @@ public void execute() throws BuildException { } } - // Special setters for the sub-classes + // Special setters for the subclasses /** * Set the internal comment attribute. @@ -555,7 +555,7 @@ protected String getUser() { /** * Gets the version string. This can be to-from "-VLbuild2~Lbuild1", from * "~Lbuild1" or to "-VLbuild2". - * @return An empty string if neither tolabel or fromlabel are set. + * @return An empty string if neither tolabel nor fromlabel are set. */ protected String getVersionLabel() { if (fromLabel == null && toLabel == null) { @@ -594,7 +594,7 @@ protected String getVersionLabel() { /** * Gets the Version date string. - * @return An empty string if neither Todate or from date are set. + * @return An empty string if neither Todate nor from date are set. * @throws BuildException if there is an error. */ protected String getVersionDate() throws BuildException { @@ -675,7 +675,7 @@ public String getWritableFiles() { } else if (writableFiles.getValue().equals(WRITABLE_REPLACE)) { return FLAG_REPLACE_WRITABLE; } else if (writableFiles.getValue().equals(WRITABLE_SKIP)) { - // ss.exe exits with '100', when files have been skipped + // ss.exe exits with '100', when files have been skipped, // so we have to ignore the failure failOnError = false; return FLAG_SKIP_WRITABLE; @@ -742,7 +742,7 @@ private String calcDate(String startDate, int daysToAdd) throws ParseException { * Changes the password to '***' so it isn't displayed on screen if the build fails * * @param cmd The command line to clean - * @return The command line as a string with out the password + * @return The command line as a string without the password */ private String formatCommandLine(Commandline cmd) { final StringBuilder sBuff = new StringBuilder(cmd.toString()); diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.java b/src/main/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.java index 40d18a230c..9d6c82fedb 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.java @@ -280,7 +280,7 @@ protected Commandline setupRmicCommand(String[] options) { * @since Ant1.7.1 */ protected String addStubVersionOptions() { - //handle the many different stub options. + //handle different stub options. String stubVersion = attributes.getStubVersion(); //default is compatibility String stubOption = null; @@ -421,7 +421,7 @@ public String[] mapFileName(String name) { /* * fallback in case we have trouble loading the class or * don't know how to handle it (there is no easy way to - * know what IDL mode would generate. + * know what IDL mode would generate). * * This is supposed to make Ant always recompile the * class, as a file of that name should not exist. diff --git a/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java b/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java index 9d795ab0dd..d692e9b081 100644 --- a/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java +++ b/src/main/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.java @@ -47,7 +47,7 @@ public interface RmicAdapter { /** * Call the rmic compiler. * - * @return true if has the compilation been successful + * @return true if the compilation has been successful * @throws BuildException on error */ boolean execute() throws BuildException; diff --git a/src/main/org/apache/tools/ant/types/AbstractFileSet.java b/src/main/org/apache/tools/ant/types/AbstractFileSet.java index a3c5d1b883..773090aadf 100644 --- a/src/main/org/apache/tools/ant/types/AbstractFileSet.java +++ b/src/main/org/apache/tools/ant/types/AbstractFileSet.java @@ -394,10 +394,10 @@ public synchronized void setCaseSensitive(boolean caseSensitive) { } /** - * Find out if the fileset is case sensitive. + * Find out if the fileset is case-sensitive. * * @return boolean indicating whether the fileset is - * case sensitive. + * case-sensitive. * * @since Ant 1.7 */ @@ -410,9 +410,9 @@ public synchronized boolean isCaseSensitive() { } /** - * Sets whether or not symbolic links should be followed. + * Sets whether symbolic links should be followed. * - * @param followSymlinks whether or not symbolic links should be followed. + * @param followSymlinks whether symbolic links should be followed. */ public synchronized void setFollowSymlinks(boolean followSymlinks) { if (isReference()) { diff --git a/src/main/org/apache/tools/ant/types/ArchiveFileSet.java b/src/main/org/apache/tools/ant/types/ArchiveFileSet.java index 1082e9ede9..7ebbf56ebc 100644 --- a/src/main/org/apache/tools/ant/types/ArchiveFileSet.java +++ b/src/main/org/apache/tools/ant/types/ArchiveFileSet.java @@ -88,7 +88,7 @@ protected ArchiveFileSet(FileSet fileset) { } /** - * Constructor using a archive fileset argument. + * Constructor using an archive fileset argument. * @param fileset the archivefileset to use */ protected ArchiveFileSet(ArchiveFileSet fileset) { diff --git a/src/main/org/apache/tools/ant/types/Assertions.java b/src/main/org/apache/tools/ant/types/Assertions.java index 9422809ff6..956eb5431b 100644 --- a/src/main/org/apache/tools/ant/types/Assertions.java +++ b/src/main/org/apache/tools/ant/types/Assertions.java @@ -98,7 +98,7 @@ public void addDisable(DisabledAssertion assertion) { /** * enable or disable system assertions. - * Default is not set (neither -enablesystemassertions or -disablesytemassertions + * Default is not set (neither -enablesystemassertions nor -disablesytemassertions * are used on the command line). * @param enableSystemAssertions if true enable system assertions */ diff --git a/src/main/org/apache/tools/ant/types/CharSet.java b/src/main/org/apache/tools/ant/types/CharSet.java index a965f5c228..328f55a10a 100644 --- a/src/main/org/apache/tools/ant/types/CharSet.java +++ b/src/main/org/apache/tools/ant/types/CharSet.java @@ -62,7 +62,7 @@ public static CharSet getDefault() { } /** - * Convenience methood: get US-ASCII CharSet. + * Convenience method: get US-ASCII CharSet. * @return the default value. */ public static CharSet getAscii() { diff --git a/src/main/org/apache/tools/ant/types/Commandline.java b/src/main/org/apache/tools/ant/types/Commandline.java index 9537112bf0..8ea710dea0 100644 --- a/src/main/org/apache/tools/ant/types/Commandline.java +++ b/src/main/org/apache/tools/ant/types/Commandline.java @@ -32,7 +32,7 @@ import org.apache.tools.ant.taskdefs.condition.Os; /** - * Commandline objects help handling command lines specifying processes to + * Commandline objects help to handle command lines specifying processes to * execute. *

    * The class can be used to define a command line as nested elements or as a diff --git a/src/main/org/apache/tools/ant/types/CommandlineJava.java b/src/main/org/apache/tools/ant/types/CommandlineJava.java index 4ad4cc5c5c..a0fa9a04c5 100644 --- a/src/main/org/apache/tools/ant/types/CommandlineJava.java +++ b/src/main/org/apache/tools/ant/types/CommandlineJava.java @@ -56,7 +56,7 @@ public class CommandlineJava implements Cloneable { private String vmVersion; private String maxMemory = null; /** - * any assertions to make? Currently only supported in forked JVMs + * any assertions to make? Currently, only supported in forked JVMs */ private Assertions assertions = null; diff --git a/src/main/org/apache/tools/ant/types/DataType.java b/src/main/org/apache/tools/ant/types/DataType.java index bac304cd06..207feb905c 100644 --- a/src/main/org/apache/tools/ant/types/DataType.java +++ b/src/main/org/apache/tools/ant/types/DataType.java @@ -28,7 +28,7 @@ /** * Base class for those classes that can appear inside the build file - * as stand alone data types. + * as standalone data types. * *

    This class handles the common description attribute and provides * a default implementation for reference handling and checking for @@ -336,7 +336,7 @@ public Reference getRefid() { } /** - * check that it is ok to set attributes, i.e that no reference is defined + * check that it is ok to set attributes, i.e. that no reference is defined * @since Ant 1.6 * @throws BuildException if not allowed */ @@ -347,7 +347,7 @@ protected void checkAttributesAllowed() { } /** - * check that it is ok to add children, i.e that no reference is defined + * check that it is ok to add children, i.e. that no reference is defined * @since Ant 1.6 * @throws BuildException if not allowed */ diff --git a/src/main/org/apache/tools/ant/types/Path.java b/src/main/org/apache/tools/ant/types/Path.java index 46d37bd2cb..eb3f266725 100644 --- a/src/main/org/apache/tools/ant/types/Path.java +++ b/src/main/org/apache/tools/ant/types/Path.java @@ -169,9 +169,9 @@ public Path(Project project) { } /** - * Adds a element definition to the path. + * Adds an element definition to the path. * @param location the location of the element to add (must not be - * null nor empty. + * null nor empty). * @throws BuildException on error */ public void setLocation(File location) throws BuildException { diff --git a/src/main/org/apache/tools/ant/types/XMLCatalog.java b/src/main/org/apache/tools/ant/types/XMLCatalog.java index 92943fc4e4..151511a702 100644 --- a/src/main/org/apache/tools/ant/types/XMLCatalog.java +++ b/src/main/org/apache/tools/ant/types/XMLCatalog.java @@ -614,7 +614,7 @@ private String removeFragment(String uri) { } /** - * Utility method to lookup a ResourceLocation in the filesystem. + * Utility method to look up a ResourceLocation in the filesystem. * * @return An InputSource for reading the file, or null * if the file does not exist or is not readable. @@ -688,7 +688,7 @@ private InputSource filesystemLookup(ResourceLocation matchingEntry) { } /** - * Utility method to lookup a ResourceLocation in the classpath. + * Utility method to look up a ResourceLocation in the classpath. * * @return An InputSource for reading the resource, or null * if the resource does not exist in the classpath or is not readable. @@ -724,7 +724,7 @@ private InputSource classpathLookup(ResourceLocation matchingEntry) { } /** - * Utility method to lookup a ResourceLocation in URL-space. + * Utility method to look up a ResourceLocation in URL-space. * * @return An InputSource for reading the resource, or null * if the resource does not identify a valid URL or is not readable. @@ -891,7 +891,7 @@ public Source resolve(String href, String base) /** * The ExternalResolver strategy is used if the Apache resolver * library (Norm Walsh's library from xml-commons) is available in - * the classpath. The ExternalResolver is a essentially a superset + * the classpath. The ExternalResolver is essentially a superset * of the InternalResolver. * */ diff --git a/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java b/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java index 5ce22f4bd2..dca36c0003 100644 --- a/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java +++ b/src/main/org/apache/tools/ant/types/mappers/CutDirsMapper.java @@ -23,7 +23,7 @@ import org.apache.tools.ant.util.FileNameMapper; /** - * A mapper that strips of the a configurable number of leading + * A mapper that strips off a configurable number of leading * directories from a file name. * *

    This mapper was inspired by a user-list thread that mentioned diff --git a/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java b/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java index 0e34f13d60..96e5ca5dbc 100644 --- a/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java +++ b/src/main/org/apache/tools/ant/types/optional/image/DrawOperation.java @@ -32,7 +32,7 @@ public interface DrawOperation { /** * Abstract method which is intended to create an image buffer - * and return it so it can be drawn into another object. Use + * and return it, so it can be drawn into another object. Use * an Alpha channel for a "transparent" background. * @return a planar image */ diff --git a/src/main/org/apache/tools/ant/types/optional/imageio/DrawOperation.java b/src/main/org/apache/tools/ant/types/optional/imageio/DrawOperation.java index fe28b7de47..e1d834f4d4 100644 --- a/src/main/org/apache/tools/ant/types/optional/imageio/DrawOperation.java +++ b/src/main/org/apache/tools/ant/types/optional/imageio/DrawOperation.java @@ -31,7 +31,7 @@ public interface DrawOperation { /** * Abstract method which is intended to create an image buffer - * and return it so it can be drawn into another object. Use + * and return it, so it can be drawn into another object. Use * an Alpha channel for a "transparent" background. * @return a planar image */ diff --git a/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java b/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java index eed8aa5660..c4b4e439f5 100644 --- a/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java +++ b/src/main/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.java @@ -107,7 +107,7 @@ public void parseCatalog(final String file) { } final ApacheCatalog apacheCatalog = (ApacheCatalog) catalog; - // Pass in reference to ourselves so we can be called back. + // Pass in reference to ourselves, so we can be called back. apacheCatalog.setResolver(this); try { diff --git a/src/main/org/apache/tools/ant/types/resources/FileProvider.java b/src/main/org/apache/tools/ant/types/resources/FileProvider.java index 52f52a655e..4483406f23 100644 --- a/src/main/org/apache/tools/ant/types/resources/FileProvider.java +++ b/src/main/org/apache/tools/ant/types/resources/FileProvider.java @@ -24,7 +24,7 @@ * This is an interface that resources that can provide a file should implement. * This is a refactoring of {@link FileResource}, to allow other resources * to act as sources of files (and to make components that only support - * file-based resources from only support FileResource resources. + * file-based resources from only support FileResource resources). * @since Ant 1.8 */ public interface FileProvider { diff --git a/src/main/org/apache/tools/ant/types/resources/FileResource.java b/src/main/org/apache/tools/ant/types/resources/FileResource.java index 17ed7cc463..c4b93bf76b 100644 --- a/src/main/org/apache/tools/ant/types/resources/FileResource.java +++ b/src/main/org/apache/tools/ant/types/resources/FileResource.java @@ -159,8 +159,8 @@ public void setRefid(Reference r) { /** * Get the name of this FileResource. If the basedir is set, - * the name will be relative to that. Otherwise the basename - * only will be returned. + * the name will be relative to that. Otherwise, only the basename + * will be returned. * @return the name of this resource. */ @Override diff --git a/src/main/org/apache/tools/ant/types/resources/Files.java b/src/main/org/apache/tools/ant/types/resources/Files.java index b7493f98aa..01da98ac03 100644 --- a/src/main/org/apache/tools/ant/types/resources/Files.java +++ b/src/main/org/apache/tools/ant/types/resources/Files.java @@ -262,7 +262,7 @@ public synchronized boolean getDefaultexcludes() { } /** - * Set case-sensitivity of the Files collection. + * Set case sensitivity of the Files collection. * * @param caseSensitive boolean. */ @@ -284,9 +284,9 @@ public synchronized boolean isCaseSensitive() { } /** - * Set whether or not symbolic links should be followed. + * Set whether symbolic links should be followed. * - * @param followSymlinks whether or not symbolic links should be followed. + * @param followSymlinks whether symbolic links should be followed. */ public synchronized void setFollowSymlinks(boolean followSymlinks) { checkAttributesAllowed(); diff --git a/src/main/org/apache/tools/ant/types/resources/ResourceList.java b/src/main/org/apache/tools/ant/types/resources/ResourceList.java index 9000af3314..83faf5067b 100644 --- a/src/main/org/apache/tools/ant/types/resources/ResourceList.java +++ b/src/main/org/apache/tools/ant/types/resources/ResourceList.java @@ -271,7 +271,7 @@ private Resource parse(final String line) { } String expandedLine = expanded.toString(); if (expandedLine.contains(":")) { - // could be an URL or an absolute file on an OS with drives + // could be a URL or an absolute file on an OS with drives try { return new URLResource(expandedLine); } catch (BuildException mfe) { diff --git a/src/main/org/apache/tools/ant/types/resources/URLProvider.java b/src/main/org/apache/tools/ant/types/resources/URLProvider.java index b8f029fc91..aaa3648478 100644 --- a/src/main/org/apache/tools/ant/types/resources/URLProvider.java +++ b/src/main/org/apache/tools/ant/types/resources/URLProvider.java @@ -21,7 +21,7 @@ import java.net.URL; /** - * This is an interface that resources that can provide an URL should implement. + * This is an interface that resources that can provide a URL should implement. * This is a refactoring of {@link URLResource}, to allow other resources * to act as sources of URLs. * @since Ant 1.8 diff --git a/src/main/org/apache/tools/ant/types/resources/selectors/Name.java b/src/main/org/apache/tools/ant/types/resources/selectors/Name.java index c887748807..f29f288c8f 100644 --- a/src/main/org/apache/tools/ant/types/resources/selectors/Name.java +++ b/src/main/org/apache/tools/ant/types/resources/selectors/Name.java @@ -81,7 +81,7 @@ public String getRegex() { /** * Set whether the name comparisons are case-sensitive. - * @param b boolean case-sensitivity flag. + * @param b boolean case sensitivity flag. */ public void setCaseSensitive(boolean b) { cs = b; @@ -89,7 +89,7 @@ public void setCaseSensitive(boolean b) { /** * Learn whether this Name ResourceSelector is case-sensitive. - * @return boolean case-sensitivity flag. + * @return boolean case sensitivity flag. */ public boolean isCaseSensitive() { return cs; diff --git a/src/main/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.java b/src/main/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.java index 8ebad85cab..d1b1f61c19 100644 --- a/src/main/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.java +++ b/src/main/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.java @@ -32,8 +32,8 @@ import org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector; /** - * This is the a base class a container of selectors - it does - * not need do be a selector itself. + * This is the base class for a container of selectors - it does + * not need to be a selector itself. * * @since 1.7 */ diff --git a/src/main/org/apache/tools/ant/types/selectors/DepthSelector.java b/src/main/org/apache/tools/ant/types/selectors/DepthSelector.java index 2076be9968..7b74ea691a 100644 --- a/src/main/org/apache/tools/ant/types/selectors/DepthSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/DepthSelector.java @@ -25,7 +25,7 @@ import org.apache.tools.ant.types.Parameter; /** - * Selector that filters files based on the how deep in the directory + * Selector that filters files based on how deep in the directory * tree they are. * * @since 1.5 diff --git a/src/main/org/apache/tools/ant/types/selectors/ExtendSelector.java b/src/main/org/apache/tools/ant/types/selectors/ExtendSelector.java index 3da62fdc4d..559c781b81 100644 --- a/src/main/org/apache/tools/ant/types/selectors/ExtendSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/ExtendSelector.java @@ -176,7 +176,7 @@ public void verifySettings() { * since we know we must have them all by now. And since we must know * both classpath and classname, creating the class is deferred to here * as well. - * @param basedir The the base directory. + * @param basedir The base directory. * @param filename The name of the file to check. * @param file A File object for this filename. * @return whether the file should be selected or not. diff --git a/src/main/org/apache/tools/ant/types/selectors/MajoritySelector.java b/src/main/org/apache/tools/ant/types/selectors/MajoritySelector.java index 33a88c993c..5bdad092aa 100644 --- a/src/main/org/apache/tools/ant/types/selectors/MajoritySelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/MajoritySelector.java @@ -50,7 +50,7 @@ public String toString() { } /** - * A attribute to specify what will happen if number + * An attribute to specify what will happen if number * of yes votes is the same as the number of no votes * defaults to true * diff --git a/src/main/org/apache/tools/ant/types/selectors/MappingSelector.java b/src/main/org/apache/tools/ant/types/selectors/MappingSelector.java index a05b963fa0..d4e3a73055 100644 --- a/src/main/org/apache/tools/ant/types/selectors/MappingSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/MappingSelector.java @@ -82,7 +82,7 @@ public void addConfigured(FileNameMapper fileNameMapper) { /** * Checks to make sure all settings are kosher. In this case, it - * means that the dest attribute has been set and we have a mapper. + * means that the dest attribute has been set, and we have a mapper. */ @Override public void verifySettings() { diff --git a/src/main/org/apache/tools/ant/types/selectors/OwnedBySelector.java b/src/main/org/apache/tools/ant/types/selectors/OwnedBySelector.java index 4f71277b08..732dd375e3 100644 --- a/src/main/org/apache/tools/ant/types/selectors/OwnedBySelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/OwnedBySelector.java @@ -53,7 +53,7 @@ public void setOwner(String owner) { /** * Sets the "follow symbolic links" option. - * @param followSymlinks whether or not symbolic links should be followed. + * @param followSymlinks whether symbolic links should be followed. */ public void setFollowSymlinks(boolean followSymlinks) { this.followSymlinks = followSymlinks; diff --git a/src/main/org/apache/tools/ant/types/selectors/PosixGroupSelector.java b/src/main/org/apache/tools/ant/types/selectors/PosixGroupSelector.java index 83107c8a52..063ec00c56 100644 --- a/src/main/org/apache/tools/ant/types/selectors/PosixGroupSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/PosixGroupSelector.java @@ -53,7 +53,7 @@ public void setGroup(String group) { /** * Sets the "follow symbolic links" option. - * @param followSymlinks whether or not symbolic links should be followed. + * @param followSymlinks whether symbolic links should be followed. */ public void setFollowSymlinks(boolean followSymlinks) { this.followSymlinks = followSymlinks; diff --git a/src/main/org/apache/tools/ant/types/selectors/PosixPermissionsSelector.java b/src/main/org/apache/tools/ant/types/selectors/PosixPermissionsSelector.java index 69f9c03e1b..7541ab771d 100644 --- a/src/main/org/apache/tools/ant/types/selectors/PosixPermissionsSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/PosixPermissionsSelector.java @@ -63,7 +63,7 @@ public void setPermissions(String permissions) { /** * Sets the "follow symbolic links" flag. - * @param followSymlinks whether or not symbolic links should be followed. + * @param followSymlinks whether symbolic links should be followed. */ public void setFollowSymlinks(boolean followSymlinks) { this.followSymlinks = followSymlinks; diff --git a/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java b/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java index 96695e4c4e..74232e724c 100644 --- a/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/PresentSelector.java @@ -123,7 +123,7 @@ public void setPresent(final FilePresence fp) { /** * Checks to make sure all settings are kosher. In this case, it - * means that the targetdir attribute has been set and we have a mapper. + * means that the targetdir attribute has been set, and we have a mapper. */ @Override public void verifySettings() { diff --git a/src/main/org/apache/tools/ant/types/selectors/SelectSelector.java b/src/main/org/apache/tools/ant/types/selectors/SelectSelector.java index 1d7e637df0..00547a9923 100644 --- a/src/main/org/apache/tools/ant/types/selectors/SelectSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/SelectSelector.java @@ -27,8 +27,8 @@ /** * This selector just holds one other selector and forwards all * requests to it. It exists so that there is a single selector - * type that can exist outside of any targets, as an element of - * project. It overrides all of the reference stuff so that it + * type that can exist outside any targets, as an element of + * project. It overrides all the reference stuff so that it * works as expected. Note that this is the only selector you * can reference. * diff --git a/src/main/org/apache/tools/ant/types/selectors/SelectorUtils.java b/src/main/org/apache/tools/ant/types/selectors/SelectorUtils.java index a6af9bcd85..c9c873cd59 100644 --- a/src/main/org/apache/tools/ant/types/selectors/SelectorUtils.java +++ b/src/main/org/apache/tools/ant/types/selectors/SelectorUtils.java @@ -61,7 +61,7 @@ public static SelectorUtils getInstance() { } /** - * Tests whether or not a given path matches the start of a given + * Tests whether a given path matches the start of a given * pattern up to the first "**". *

    * This is not a general purpose test and should only be used if you @@ -73,7 +73,7 @@ public static SelectorUtils getInstance() { * @param str The path to match, as a String. Must not be * null. * - * @return whether or not a given path matches the start of a given + * @return whether a given path matches the start of a given * pattern up to the first "**". */ public static boolean matchPatternStart(String pattern, String str) { @@ -81,7 +81,7 @@ public static boolean matchPatternStart(String pattern, String str) { } /** - * Tests whether or not a given path matches the start of a given + * Tests whether a given path matches the start of a given * pattern up to the first "**". *

    * This is not a general purpose test and should only be used if you @@ -92,10 +92,10 @@ public static boolean matchPatternStart(String pattern, String str) { * null. * @param str The path to match, as a String. Must not be * null. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * - * @return whether or not a given path matches the start of a given + * @return whether a given path matches the start of a given * pattern up to the first "**". */ public static boolean matchPatternStart(String pattern, String str, @@ -116,7 +116,7 @@ public static boolean matchPatternStart(String pattern, String str, /** - * Tests whether or not a given path matches the start of a given + * Tests whether a given path matches the start of a given * pattern up to the first "**". *

    * This is not a general purpose test and should only be used if you @@ -127,10 +127,10 @@ public static boolean matchPatternStart(String pattern, String str, * null. * @param strDirs The tokenized path to match. Must not be * null. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * - * @return whether or not a given path matches the start of a given + * @return whether a given path matches the start of a given * pattern up to the first "**". */ static boolean matchPatternStart(String[] patDirs, String[] strDirs, @@ -155,12 +155,12 @@ static boolean matchPatternStart(String[] patDirs, String[] strDirs, // Fail if string is not exhausted or pattern is exhausted // Otherwise the pattern now holds ** while string is not exhausted - // this will generate false positives but we can live with that. + // this will generate false positives, but we can live with that. return strIdxStart > strIdxEnd || patIdxStart <= patIdxEnd; } /** - * Tests whether or not a given path matches a given pattern. + * Tests whether a given path matches a given pattern. * * If you need to call this method multiple times with the same * pattern you should rather use TokenizedPath @@ -181,7 +181,7 @@ public static boolean matchPath(String pattern, String str) { } /** - * Tests whether or not a given path matches a given pattern. + * Tests whether a given path matches a given pattern. * * If you need to call this method multiple times with the same * pattern you should rather use TokenizedPattern @@ -192,8 +192,8 @@ public static boolean matchPath(String pattern, String str) { * null. * @param str The path to match, as a String. Must not be * null. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * * @return true if the pattern matches against the string, * or false otherwise. @@ -310,7 +310,7 @@ static boolean matchPath(String[] tokenizedPattern, String[] strDirs, } /** - * Tests whether or not a string matches against a pattern. + * Tests whether a string matches against a pattern. * The pattern may contain two special characters:
    * '*' means zero or more characters
    * '?' means one and only one character @@ -328,7 +328,7 @@ public static boolean match(String pattern, String str) { } /** - * Tests whether or not a string matches against a pattern. + * Tests whether a string matches against a pattern. * The pattern may contain two special characters:
    * '*' means zero or more characters
    * '?' means one and only one character @@ -337,8 +337,8 @@ public static boolean match(String pattern, String str) { * Must not be null. * @param str The string which must be matched against the pattern. * Must not be null. - * @param caseSensitive Whether or not matching should be performed - * case sensitively. + * @param caseSensitive Whether matching should be performed + * case-sensitively. * * * @return true if the string matches against the pattern, @@ -394,7 +394,7 @@ && different(caseSensitive, ch, strArr[strIdxStart])) { } if (strIdxStart > strIdxEnd) { // All characters in the string are used. Check if only '*'s are - // left in the pattern. If so, we succeeded. Otherwise failure. + // left in the pattern. If so, we succeeded. Otherwise, failure. return allStars(patArr, patIdxStart, patIdxEnd); } @@ -412,7 +412,7 @@ && different(caseSensitive, ch, strArr[strIdxStart])) { } if (strIdxStart > strIdxEnd) { // All characters in the string are used. Check if only '*'s are - // left in the pattern. If so, we succeeded. Otherwise failure. + // left in the pattern. If so, we succeeded. Otherwise, failure. return allStars(patArr, patIdxStart, patIdxEnd); } @@ -457,7 +457,7 @@ && different(caseSensitive, ch, strArr[strIdxStart])) { } // All characters in the string are used. Check if only '*'s are left - // in the pattern. If so, we succeeded. Otherwise failure. + // in the pattern. If so, we succeeded. Otherwise, failure. return allStars(patArr, patIdxStart, patIdxEnd); } diff --git a/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java b/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java index 192572ba8f..aaf7c9c416 100644 --- a/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java +++ b/src/main/org/apache/tools/ant/types/selectors/TokenizedPattern.java @@ -56,12 +56,12 @@ public TokenizedPattern(String pattern) { } /** - * Tests whether or not a given path matches a given pattern. + * Tests whether a given path matches a given pattern. * * @param path The path to match, as a {@link String}. Must not be * {@code null}. - * @param isCaseSensitive Whether or not matching should be performed - * case sensitively. + * @param isCaseSensitive Whether matching should be performed + * case-sensitively. * * @return {@code true} if the pattern matches against the string, * or {@code false} otherwise. @@ -72,7 +72,7 @@ public boolean matchPath(TokenizedPath path, boolean isCaseSensitive) { } /** - * Tests whether or not this pattern matches the start of + * Tests whether this pattern matches the start of * a path. * * @param path {@link TokenizedPath} diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java index 3ce89132f1..5a1d5f7708 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.java @@ -36,7 +36,7 @@ public class HashvalueAlgorithm implements Algorithm { /** * This algorithm doesn't need any configuration. - * Therefore it's always valid. + * Therefore, it's always valid. * @return always true */ public boolean isValid() { diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/LastModifiedAlgorithm.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/LastModifiedAlgorithm.java index a1f4c606c4..e5989c6f77 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/LastModifiedAlgorithm.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/LastModifiedAlgorithm.java @@ -30,7 +30,7 @@ public class LastModifiedAlgorithm implements Algorithm { /** * This algorithm doesn't need any configuration. - * Therefore it's always valid. + * Therefore, it's always valid. * @return always true */ public boolean isValid() { diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java index 80bf4a6f97..1f8628bdb8 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.java @@ -654,7 +654,7 @@ public ClassLoader getClassLoader() { * Set the used ClassLoader. * If you invoke this selector by API (e.g. inside some testcases) the selector * will use a different classloader for loading the interface implementations than - * the caller. Therefore you will get a ClassCastException if you get the + * the caller. Therefore, you will get a ClassCastException if you get the * implementations from the selector and cast them. * @param loader the ClassLoader to use */ diff --git a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java index a09e765127..cb0f56aab9 100644 --- a/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java +++ b/src/main/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.java @@ -138,14 +138,14 @@ public void load() { e.printStackTrace(); //NOSONAR } } - // after loading the cache is up to date with the file + // after loading the cache is up-to-date with the file cacheLoaded = true; cacheDirty = false; } /** * Saves modification of the cache. - * Cache is only saved if there is one ore more entries. + * Cache is only saved if there is one or more entries. * Because entries can not be deleted by this API, this Cache * implementation checks the existence of entries before creating the file * for performance optimisation. diff --git a/src/main/org/apache/tools/ant/util/ClasspathUtils.java b/src/main/org/apache/tools/ant/util/ClasspathUtils.java index e14ed3ef8b..1dec4a393b 100644 --- a/src/main/org/apache/tools/ant/util/ClasspathUtils.java +++ b/src/main/org/apache/tools/ant/util/ClasspathUtils.java @@ -242,7 +242,7 @@ public static Object newInstance(String className, ClassLoader userDefinedLoader * @param userDefinedLoader the classloader to use. * @param expectedType the Class that the result should be assignment * compatible with. (No ClassCastException will be thrown in case - * the result of this method is casted to the expectedType) + * the result of this method is cast to the expectedType) * @return The fresh object instance * @throws BuildException when loading or instantiation failed. * @since Ant 1.7 diff --git a/src/main/org/apache/tools/ant/util/DateUtils.java b/src/main/org/apache/tools/ant/util/DateUtils.java index bf92bf5701..97b1b655b1 100644 --- a/src/main/org/apache/tools/ant/util/DateUtils.java +++ b/src/main/org/apache/tools/ant/util/DateUtils.java @@ -220,7 +220,7 @@ public static int getPhaseOfMoon(Calendar cal) { } /** - * Returns the current Date in a format suitable for a SMTP date + * Returns the current Date in a format suitable for an SMTP date * header. * @return the current date. * @since Ant 1.5.2 @@ -252,7 +252,7 @@ public static String getDateForHeader() { } /** - * Parses the string in a format suitable for a SMTP date header. + * Parses the string in a format suitable for an SMTP date header. * * @param datestr string to be parsed * @@ -299,7 +299,7 @@ public static Date parseIso8601Date(String datestr) throws ParseException { } /** - * Parse a string as a date using the either the ISO8601_DATETIME + * Parse a string as a date using either the ISO8601_DATETIME * or ISO8601_DATE formats. * * @param datestr string to be parsed diff --git a/src/main/org/apache/tools/ant/util/FileUtils.java b/src/main/org/apache/tools/ant/util/FileUtils.java index 0deecaa7cf..ae195bfc42 100644 --- a/src/main/org/apache/tools/ant/util/FileUtils.java +++ b/src/main/org/apache/tools/ant/util/FileUtils.java @@ -207,7 +207,7 @@ public void copyFile(String sourceFile, String destFile, FilterSetCollection fil * @param sourceFile Name of file to copy from. Must not be null. * @param destFile Name of file to copy to. Must not be null. * @param filters the collection of filters to apply to this copy. - * @param overwrite Whether or not the destination file should be overwritten if it already + * @param overwrite Whether the destination file should be overwritten if it already * exists. * * @throws IOException if the copying fails. @@ -229,9 +229,9 @@ public void copyFile(String sourceFile, String destFile, FilterSetCollection fil * @param sourceFile Name of file to copy from. Must not be null. * @param destFile Name of file to copy to. Must not be null. * @param filters the collection of filters to apply to this copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file * should be set to that of the source file. * @@ -254,9 +254,9 @@ public void copyFile(String sourceFile, String destFile, * @param sourceFile Name of file to copy from. Must not be null. * @param destFile Name of file to copy to. Must not be null. * @param filters the collection of filters to apply to this copy. - * @param overwrite Whether or not the destination file should be overwritten if it already + * @param overwrite Whether the destination file should be overwritten if it already * exists. - * @param preserveLastModified Whether or not the last modified time of the resulting file + * @param preserveLastModified Whether the last modified time of the resulting file * should be set to that of the source file. * @param encoding the encoding used to read and write the files. * @@ -286,9 +286,9 @@ public void copyFile(String sourceFile, String destFile, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @param encoding the encoding used to read and write the files. @@ -316,9 +316,9 @@ public void copyFile(String sourceFile, String destFile, * @param destFile Name of file to copy to. Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination file should be overwritten if it already + * @param overwrite Whether the destination file should be overwritten if it already * exists. - * @param preserveLastModified Whether or not the last modified time of the resulting file + * @param preserveLastModified Whether the last modified time of the resulting file * should be set to that of the source file. * @param inputEncoding the encoding used to read the files. * @param outputEncoding the encoding used to write the files. @@ -376,7 +376,7 @@ public void copyFile(File sourceFile, File destFile, FilterSetCollection filters * @param destFile the file to copy to. * Must not be null. * @param filters the collection of filters to apply to this copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. * * @throws IOException if the copying fails. @@ -398,9 +398,9 @@ public void copyFile(File sourceFile, File destFile, FilterSetCollection filters * @param destFile the file to copy to. * Must not be null. * @param filters the collection of filters to apply to this copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @@ -420,9 +420,9 @@ public void copyFile(File sourceFile, File destFile, FilterSetCollection filters * @param sourceFile the file to copy from. Must not be null. * @param destFile the file to copy to. Must not be null. * @param filters the collection of filters to apply to this copy. - * @param overwrite Whether or not the destination file should be overwritten if it already + * @param overwrite Whether the destination file should be overwritten if it already * exists. - * @param preserveLastModified Whether or not the last modified time of the resulting file + * @param preserveLastModified Whether the last modified time of the resulting file * should be set to that of the source file. * @param encoding the encoding used to read and write the files. * @@ -451,9 +451,9 @@ public void copyFile(File sourceFile, File destFile, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @param encoding the encoding used to read and write the files. @@ -485,9 +485,9 @@ public void copyFile(File sourceFile, File destFile, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @param inputEncoding the encoding used to read the files. @@ -522,9 +522,9 @@ public void copyFile(File sourceFile, File destFile, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @param append whether to append to the destination file. @@ -562,9 +562,9 @@ public void copyFile(File sourceFile, File destFile, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination file should be + * @param overwrite Whether the destination file should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the resulting file should be set to that * of the source file. * @param append whether to append to the destination file. @@ -594,7 +594,7 @@ public void copyFile(File sourceFile, File destFile, /** * Calls File.setLastModified(long time). Originally written to - * to dynamically bind to that call on Java1.2+. + * dynamically bind to that call on Java1.2+. * * @param file the file whose modified time is to be set * @param time the time to which the last modified time is to be set. @@ -1315,7 +1315,7 @@ public boolean isLeadingPath(File leading, File path) { * @return true if path starts with leading; false otherwise. * @since Ant 1.10.5 * @throws IOException if resolveSymlinks is true and invoking - * getCanonicaPath on either argument throws an exception + * getCanonicalPath on either argument throws an exception */ public boolean isLeadingPath(File leading, File path, boolean resolveSymlinks) throws IOException { @@ -1502,13 +1502,13 @@ public long getFileTimestampGranularity() { /** * test whether a file or directory exists, with an error in the * 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). *

    * It will return true only if 3 conditions are met: *

    *
      - *
    • operating system is case insensitive
      • + *
    • operating system is case-insensitive
      • *
    • file exists
      • *
    • actual name from directory reading is different from the * supplied argument
      • @@ -1551,7 +1551,7 @@ public boolean hasErrorInCase(File localFile) { public boolean isUpToDate(File source, File dest, long granularity) { //do a check for the destination file existing if (!dest.exists()) { - //if it does not, then the file is not up to date. + //if it does not, then the file is not up-to-date. return false; } long sourceTime = source.lastModified(); @@ -1571,7 +1571,7 @@ public boolean isUpToDate(File source, File dest) { } /** - * Compare two timestamps for being up to date using + * Compare two timestamps for being up-to-date using * the specified granularity. * * @param sourceTime timestamp of source file. @@ -1584,7 +1584,7 @@ public boolean isUpToDate(long sourceTime, long destTime, long granularity) { } /** - * Compare two timestamps for being up to date using the + * Compare two timestamps for being up-to-date using the * current granularity. * * @param sourceTime timestamp of source file. @@ -1854,7 +1854,7 @@ public int read() { /** * Opens a new OutputStream for the given Path. * @param path the path of the file - * @param append whether to append to or a replace an existing file + * @param append whether to append to or to replace an existing file * @return a stream ready to write to the file * @throws IOException if stream creation fails * @since Ant 1.10.2 @@ -1880,7 +1880,7 @@ public static OutputStream newOutputStream(Path path, boolean append) throws IOE *

      * @param path The path whose filesystem case sensitivity needs to be checked * @return Returns true if the filesystem corresponding to the passed {@code path} - * is case sensitive. Else returns false. If the case sensitivity + * is case-sensitive. Else returns false. If the case sensitivity * cannot be determined for whatever reason, this method returns an * {@link Optional#empty()} * @throws IllegalArgumentException If the passed path is null @@ -1900,7 +1900,7 @@ public static Optional isCaseSensitiveFileSystem(final Path path) { mixedCaseTmpFile = Files.createTempFile(path, mixedCaseFileNamePrefix, null); } else { // we can only do our tricks to figure out whether the filesystem is - // case sensitive, only if the path is a directory or a file. + // case-sensitive, only if the path is a directory or a file. // In other cases (like the path being non-existent), we don't // have a way to determine that detail return Optional.empty(); @@ -1911,7 +1911,7 @@ public static Optional isCaseSensitiveFileSystem(final Path path) { } catch (NoSuchFileException nsfe) { // a NSFE implies that the "lowerCasePath" file wasn't considered to be present // even if the different cased file exists. That effectively means this is a - // case sensitive filesystem + // case-sensitive filesystem caseSensitive = true; } } catch (IOException ioe) { diff --git a/src/main/org/apache/tools/ant/util/FlatFileNameMapper.java b/src/main/org/apache/tools/ant/util/FlatFileNameMapper.java index ac24790a00..d0da4d41a9 100644 --- a/src/main/org/apache/tools/ant/util/FlatFileNameMapper.java +++ b/src/main/org/apache/tools/ant/util/FlatFileNameMapper.java @@ -47,7 +47,7 @@ public void setTo(String to) { } /** - * Returns an one-element array containing the source file name + * Returns a one-element array containing the source file name * without any leading directory information. * @param sourceFileName the name to map. * @return the file name in a one-element array. diff --git a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java index 9a63703816..c08adc41ea 100644 --- a/src/main/org/apache/tools/ant/util/GlobPatternMapper.java +++ b/src/main/org/apache/tools/ant/util/GlobPatternMapper.java @@ -148,7 +148,7 @@ public void setTo(String to) { /** * Returns null if the source file name doesn't match the - * "from" pattern, an one-element array containing the + * "from" pattern, a one-element array containing the * translated file otherwise. * @param sourceFileName the filename to map * @return a list of converted filenames diff --git a/src/main/org/apache/tools/ant/util/IdentityMapper.java b/src/main/org/apache/tools/ant/util/IdentityMapper.java index 3bee9d816b..af1f57789b 100644 --- a/src/main/org/apache/tools/ant/util/IdentityMapper.java +++ b/src/main/org/apache/tools/ant/util/IdentityMapper.java @@ -44,7 +44,7 @@ public void setTo(String to) { } /** - * Returns an one-element array containing the source file name. + * Returns a one-element array containing the source file name. * @param sourceFileName the name to map. * @return the source filename in a one-element array. */ diff --git a/src/main/org/apache/tools/ant/util/JAXPUtils.java b/src/main/org/apache/tools/ant/util/JAXPUtils.java index b10a954261..47e5a17dba 100644 --- a/src/main/org/apache/tools/ant/util/JAXPUtils.java +++ b/src/main/org/apache/tools/ant/util/JAXPUtils.java @@ -178,7 +178,7 @@ public static XMLReader getNamespaceXMLReader() throws BuildException { } /** - * This is a best attempt to provide a URL.toExternalForm() from + * This is the best attempt to provide a URL.toExternalForm() from * a file URL. Some parsers like Crimson choke on uri that are made of * backslashed paths (ie windows) as it is does not conform * URI specifications. diff --git a/src/main/org/apache/tools/ant/util/JavaEnvUtils.java b/src/main/org/apache/tools/ant/util/JavaEnvUtils.java index 899c714a91..5c9a00b6df 100644 --- a/src/main/org/apache/tools/ant/util/JavaEnvUtils.java +++ b/src/main/org/apache/tools/ant/util/JavaEnvUtils.java @@ -249,7 +249,7 @@ public static String getJavaVersion() { * Returns the version of Java this class is running under. *

      This number can be used for comparisons.

      * @return the version of Java as a number 10x the major/minor, - * e.g Java1.5 has a value of 15 and Java9 the value 90 - major + * e.g. Java1.5 has a value of 15 and Java9 the value 90 - major * will be 1 for all versions of Java prior to Java 9, minor will * be 0 for all versions of Java starting with Java 9. * @deprecated use #getParsedJavaVersion instead @@ -262,7 +262,7 @@ public static int getJavaVersionNumber() { /** * Returns the version of Java this class is running under. *

      This number can be used for comparisons.

      - * @return the version of Java as major.minor, e.g Java1.5 has a + * @return the version of Java as major.minor, e.g. Java1.5 has a * value of 1.5 and Java9 the value 9 - major will be 1 for all * versions of Java prior to Java 9, minor will be 0 for all * versions of Java starting with Java 9. diff --git a/src/main/org/apache/tools/ant/util/LazyHashtable.java b/src/main/org/apache/tools/ant/util/LazyHashtable.java index bc48ca652e..a14d2f866e 100644 --- a/src/main/org/apache/tools/ant/util/LazyHashtable.java +++ b/src/main/org/apache/tools/ant/util/LazyHashtable.java @@ -40,7 +40,7 @@ public LazyHashtable() { } /** Used to be part of init. It must be done once - but - * we delay it until we do need _all_ tasks. Otherwise we + * we delay it until we do need _all_ tasks. Otherwise, we * just get the tasks that we need, and avoid costly init. */ protected void initAll() { @@ -52,7 +52,7 @@ protected void initAll() { /** - * Get a enumeration over the elements. + * Get an enumeration over the elements. * @return an enumeration. */ public Enumeration elements() { diff --git a/src/main/org/apache/tools/ant/util/LineOrientedOutputStreamRedirector.java b/src/main/org/apache/tools/ant/util/LineOrientedOutputStreamRedirector.java index 8d86718be8..e437ef1554 100644 --- a/src/main/org/apache/tools/ant/util/LineOrientedOutputStreamRedirector.java +++ b/src/main/org/apache/tools/ant/util/LineOrientedOutputStreamRedirector.java @@ -23,7 +23,7 @@ /** * Output stream which buffer and redirect a stream line by line. *

      - * If the source stream doesn't end with a end of line, one will be added. This + * If the source stream doesn't end with an end of line, one will be added. This * is particularly useful in combination with the OutputStreamFunneler so each * funneled stream get its line. * diff --git a/src/main/org/apache/tools/ant/util/MergingMapper.java b/src/main/org/apache/tools/ant/util/MergingMapper.java index b13bd10304..8e13e5afc4 100644 --- a/src/main/org/apache/tools/ant/util/MergingMapper.java +++ b/src/main/org/apache/tools/ant/util/MergingMapper.java @@ -60,7 +60,7 @@ public void setTo(String to) { } /** - * Returns an one-element array containing the file name set via setTo. + * Returns a one-element array containing the file name set via setTo. * @param sourceFileName ignored. * @return a one-element array containing the merged filename. */ diff --git a/src/main/org/apache/tools/ant/util/PermissionUtils.java b/src/main/org/apache/tools/ant/util/PermissionUtils.java index 1e50217b2b..a360543646 100644 --- a/src/main/org/apache/tools/ant/util/PermissionUtils.java +++ b/src/main/org/apache/tools/ant/util/PermissionUtils.java @@ -133,7 +133,7 @@ public static void setPermissions(Resource r, Set permissio * Sets permissions of a {@link Resource} - returns an empty set * for unsupported resource types or file systems that don't * support PosixFilePermissions and no fallback has been - * provided.. + * provided. * *

      Supported types are:

      *
        diff --git a/src/main/org/apache/tools/ant/util/ProxySetup.java b/src/main/org/apache/tools/ant/util/ProxySetup.java index 81b529b852..d04160eeab 100644 --- a/src/main/org/apache/tools/ant/util/ProxySetup.java +++ b/src/main/org/apache/tools/ant/util/ProxySetup.java @@ -105,7 +105,7 @@ public void enableProxies() { owner.log(message, Project.MSG_DEBUG); System.setProperty(USE_SYSTEM_PROXIES, proxies); } catch (SecurityException e) { - //log security exceptions and continue; it aint that + //log security exceptions and continue; it ain't that //important and may be quite common running Ant embedded. owner.log("Security Exception when " + message); } diff --git a/src/main/org/apache/tools/ant/util/ReaderInputStream.java b/src/main/org/apache/tools/ant/util/ReaderInputStream.java index ff2eb63b0b..766b0903ec 100644 --- a/src/main/org/apache/tools/ant/util/ReaderInputStream.java +++ b/src/main/org/apache/tools/ant/util/ReaderInputStream.java @@ -71,7 +71,7 @@ public ReaderInputStream(final Reader reader, final CharsetEncoder encoder) { * * @param reader the target {@link Reader} * @param encoder the charset encoder - * @param bufferSize the size of the input buffer in number of characters + * @param bufferSize the size of the input buffer (number of characters) * @since 1.10.9 */ public ReaderInputStream(final Reader reader, final CharsetEncoder encoder, final int bufferSize) { diff --git a/src/main/org/apache/tools/ant/util/RegexpPatternMapper.java b/src/main/org/apache/tools/ant/util/RegexpPatternMapper.java index 144722ab6b..894f4951bb 100644 --- a/src/main/org/apache/tools/ant/util/RegexpPatternMapper.java +++ b/src/main/org/apache/tools/ant/util/RegexpPatternMapper.java @@ -107,7 +107,7 @@ public void setTo(String to) { /** * Returns null if the source file name doesn't match the - * "from" pattern, an one-element array containing the + * "from" pattern, a one-element array containing the * translated file otherwise. * @param sourceFileName the source file name * @return a one-element array containing the translated file or diff --git a/src/main/org/apache/tools/ant/util/ResourceUtils.java b/src/main/org/apache/tools/ant/util/ResourceUtils.java index e284defa9a..2f5a390f4f 100644 --- a/src/main/org/apache/tools/ant/util/ResourceUtils.java +++ b/src/main/org/apache/tools/ant/util/ResourceUtils.java @@ -275,9 +275,9 @@ public static void copyResource(final Resource source, final Resource dest, fina * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination Resource should be + * @param overwrite Whether the destination Resource should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the destination Resource should be set to that * of the source. * @param inputEncoding the encoding used to read the files. @@ -311,9 +311,9 @@ public static void copyResource(final Resource source, final Resource dest, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination Resource should be + * @param overwrite Whether the destination Resource should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the destination Resource should be set to that * of the source. * @param append Whether to append to an Appendable Resource. @@ -350,9 +350,9 @@ public static void copyResource(final Resource source, final Resource dest, * Must not be null. * @param filters the collection of filters to apply to this copy. * @param filterChains filterChains to apply during the copy. - * @param overwrite Whether or not the destination Resource should be + * @param overwrite Whether the destination Resource should be * overwritten if it already exists. - * @param preserveLastModified Whether or not the last modified time of + * @param preserveLastModified Whether the last modified time of * the destination Resource should be set to that * of the source. * @param append Whether to append to an Appendable Resource. diff --git a/src/main/org/apache/tools/ant/util/RetryHandler.java b/src/main/org/apache/tools/ant/util/RetryHandler.java index 7d9b44b43f..0599dcc983 100644 --- a/src/main/org/apache/tools/ant/util/RetryHandler.java +++ b/src/main/org/apache/tools/ant/util/RetryHandler.java @@ -36,7 +36,7 @@ public class RetryHandler { * Create a new RetryingHandler. * * @param retriesAllowed how many times to retry - * @param task the Ant task that is is executed from, used for logging only + * @param task the Ant task that it is executed from, used for logging only */ public RetryHandler(int retriesAllowed, Task task) { this.retriesAllowed = retriesAllowed; diff --git a/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java b/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java index 6e4db9cb2e..ffa7c42442 100644 --- a/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java +++ b/src/main/org/apache/tools/ant/util/ScriptFixBSFPath.java @@ -75,7 +75,7 @@ private File getClassSource(String className) { } /** - * Check if need to mess about with the classloader. + * Check if we need to mess with the classloader. * The class loader will need to be modified for two * reasons: *
          @@ -112,7 +112,7 @@ public void fixClassLoader(ClassLoader loader, String language) { // Check for location of language String languageClassName = BSF_LANGUAGE_MAP.get(language); - // Check if need to need to move bsf + // Check if we need to move bsf boolean needMoveBsf = bsfSource != null && languageClassName != null diff --git a/src/main/org/apache/tools/ant/util/StringUtils.java b/src/main/org/apache/tools/ant/util/StringUtils.java index ea3da96ac8..d87446433b 100644 --- a/src/main/org/apache/tools/ant/util/StringUtils.java +++ b/src/main/org/apache/tools/ant/util/StringUtils.java @@ -193,9 +193,9 @@ public static String resolveBackSlash(String input) { } /** - * Takes a human readable size representation eg 10K + * Takes a human-readable size representation e.g. 10K * a long value. Doesn't support 1.1K or other rational values. - * @param humanSize the amount as a human readable string. + * @param humanSize the amount as a human-readable string. * @return a long value representation * @throws Exception if there is a problem. * @since Ant 1.7 diff --git a/src/main/org/apache/tools/ant/util/VectorSet.java b/src/main/org/apache/tools/ant/util/VectorSet.java index e68a9f69fc..0dcdb07f64 100644 --- a/src/main/org/apache/tools/ant/util/VectorSet.java +++ b/src/main/org/apache/tools/ant/util/VectorSet.java @@ -80,7 +80,7 @@ public void add(int index, E o) { private synchronized void doAdd(int index, E o) { // Vector.add seems to delegate to insertElementAt, but this - // is not documented so we may better implement it ourselves + // is not documented, so we may better implement it ourselves if (set.add(o)) { int count = size(); ensureCapacity(count + 1); diff --git a/src/main/org/apache/tools/ant/util/XMLFragment.java b/src/main/org/apache/tools/ant/util/XMLFragment.java index b6920282f1..1ea65c8793 100644 --- a/src/main/org/apache/tools/ant/util/XMLFragment.java +++ b/src/main/org/apache/tools/ant/util/XMLFragment.java @@ -93,7 +93,7 @@ public Object createDynamicElement(String uri, String name, String qName) { */ private void addText(Node n, String s) { s = getProject().replaceProperties(s); - //only text nodes that are non null after property expansion are added + //only text nodes that are non-null after property expansion are added if (s != null && !s.trim().isEmpty()) { Text t = doc.createTextNode(s.trim()); n.appendChild(t); diff --git a/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java index 448e8b9008..9da20159e6 100644 --- a/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/AbstractAnalyzer.java @@ -55,7 +55,7 @@ public abstract class AbstractAnalyzer implements DependencyAnalyzer { /** true if indirect dependencies should be gathered */ private boolean closure = true; - /** Setup the analyzer */ + /** Set up the analyzer */ protected AbstractAnalyzer() { reset(); } @@ -137,7 +137,7 @@ public File getSourceContainer(String classname) throws IOException { // we look through the source path elements. If the element is a dir // we look for the file. If it is a zip, we look for the zip entry. - // This isn't normal for source paths but we get it for free + // This isn't normal for source paths, but we get it for free return getResourceContainer(sourceLocation, sourcePath.list()); } @@ -207,7 +207,7 @@ public void config(String name, Object info) { /** * Reset the dependency list. This will reset the determined - * dependencies and the also list of root classes. + * dependencies and also the list of root classes. */ @Override public void reset() { diff --git a/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java b/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java index d82a17b4de..a9f41c3459 100644 --- a/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java +++ b/src/main/org/apache/tools/ant/util/depend/DependencyAnalyzer.java @@ -83,7 +83,7 @@ public interface DependencyAnalyzer { /** * Reset the dependency list. This will reset the determined - * dependencies and the also list of root classes. + * dependencies and also the list of root classes. */ void reset(); diff --git a/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java b/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java index db1069bef8..af5a360f0d 100644 --- a/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java +++ b/src/main/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.java @@ -47,7 +47,7 @@ public class DependencyVisitor extends EmptyVisitor { /** * Get the dependencies collected by this visitor * - * @return a Enumeration of classnames, being the classes upon which the + * @return an Enumeration of classnames, being the classes upon which the * visited classes depend. */ public Enumeration getDependencies() { diff --git a/src/main/org/apache/tools/ant/util/facade/FacadeTaskHelper.java b/src/main/org/apache/tools/ant/util/facade/FacadeTaskHelper.java index 1a22726813..3391565327 100644 --- a/src/main/org/apache/tools/ant/util/facade/FacadeTaskHelper.java +++ b/src/main/org/apache/tools/ant/util/facade/FacadeTaskHelper.java @@ -136,7 +136,7 @@ public String[] getArgs() { /** * Tests whether the implementation has been chosen by the user - * (either via a magic property or explicitly. + * (either via a magic property or explicitly). * @return true if magic or user choice has be set. * @since Ant 1.5.2 */ diff --git a/src/main/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.java b/src/main/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.java index 8a7d0392ad..8629be709c 100644 --- a/src/main/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.java +++ b/src/main/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.java @@ -43,7 +43,7 @@ public void setImplementation(String impl) { * implementation matches the chosen implementation. * @see org.apache.tools.ant.types.Commandline.Argument#getParts() * @param chosenImpl the implementation to check against. - * @return the parts if the implementation matches or an zero length + * @return the parts if the implementation matches or a zero length * array if not. */ public final String[] getParts(String chosenImpl) { diff --git a/src/main/org/apache/tools/ant/util/optional/WeakishReference12.java b/src/main/org/apache/tools/ant/util/optional/WeakishReference12.java index d50ce7793d..faf80394bd 100644 --- a/src/main/org/apache/tools/ant/util/optional/WeakishReference12.java +++ b/src/main/org/apache/tools/ant/util/optional/WeakishReference12.java @@ -21,7 +21,7 @@ import org.apache.tools.ant.util.WeakishReference; /** - * This is a reference that really is is Weak, as it uses the + * This is a reference that really is Weak, as it uses the * appropriate java.lang.ref class. * @deprecated since 1.7. * Just use {@link java.lang.ref.WeakReference} directly. diff --git a/src/main/org/apache/tools/ant/util/regexp/RegexpMatcher.java b/src/main/org/apache/tools/ant/util/regexp/RegexpMatcher.java index 375457753c..d3a411ac3e 100644 --- a/src/main/org/apache/tools/ant/util/regexp/RegexpMatcher.java +++ b/src/main/org/apache/tools/ant/util/regexp/RegexpMatcher.java @@ -29,13 +29,13 @@ public interface RegexpMatcher { /*** - * Default Mask (case insensitive, neither multiline nor + * Default Mask (case-insensitive, neither multiline nor * singleline specified). */ int MATCH_DEFAULT = 0x00000000; /*** - * Perform a case insensitive match + * Perform a case-insensitive match */ int MATCH_CASE_INSENSITIVE = 0x00000100; diff --git a/src/main/org/apache/tools/bzip2/BlockSort.java b/src/main/org/apache/tools/bzip2/BlockSort.java index 01439e1c58..20f97355ac 100644 --- a/src/main/org/apache/tools/bzip2/BlockSort.java +++ b/src/main/org/apache/tools/bzip2/BlockSort.java @@ -80,7 +80,7 @@ class BlockSort { /* - * Some of the constructs used in the C code cannot be ported + * Some constructs used in the C code cannot be ported * literally to Java - for example macros, unsigned types. Some * code has been hand-tuned to improve performance. In order to * avoid memory pressure some structures are reused for several @@ -110,7 +110,7 @@ class BlockSort { /* * LBZ2: If you are ever unlucky/improbable enough to get a stack * overflow whilst sorting, increase the following constant and - * try again. In practice I have never seen the stack go above 27 + * try again. In practice, I have never seen the stack go above 27 * elems, so the following limit seems very generous. */ private static final int QSORT_STACK_SIZE = 1000; @@ -219,7 +219,7 @@ final void fallbackSort(final CBZip2OutputStream.Data data, * quicksort on all permutations of the bucket based on the index * of the bucket the second byte of the permutation belongs to, * thereby forming new buckets. When arrived here the - * permutations are sorted up to the second character and we have + * permutations are sorted up to the second character, and we have * buckets of permutations that are identical up to two * characters. * @@ -463,7 +463,7 @@ private int[] getEclass() { * The C code uses an array of ints (each int holding 32 flags) to * represents the bucket-start flags (bhtab). It also contains * optimizations to skip over 32 consecutively set or - * consecutively unset bits on word boundaries at once. For now + * consecutively unset bits on word boundaries at once. For now, * I've chosen to use the simpler but potentially slower code * using BitSet - also in the hope that using the BitSet#nextXXX * methods may be fast enough. @@ -1017,7 +1017,7 @@ final void mainSort(final CBZip2OutputStream.Data dataShadow, } // Step 2: - // LBZ2: Now scan this big bucket so as to synthesise the + // LBZ2: Now scan this big bucket to synthesise the // sorted order for small buckets [t, ss] for all t != ss. for (int j = 0; j <= 255; j++) { diff --git a/src/main/org/apache/tools/tar/TarBuffer.java b/src/main/org/apache/tools/tar/TarBuffer.java index fcea511047..d4bcbdf233 100644 --- a/src/main/org/apache/tools/tar/TarBuffer.java +++ b/src/main/org/apache/tools/tar/TarBuffer.java @@ -359,7 +359,7 @@ public void writeRecord(byte[] record) throws IOException { /** * Write an archive record to the archive, where the record may be - * inside of a larger array buffer. The buffer must be "offset plus + * inside a larger array buffer. The buffer must be "offset plus * record size" long. * * @param buf The buffer containing the record data to write. diff --git a/src/main/org/apache/tools/tar/TarEntry.java b/src/main/org/apache/tools/tar/TarEntry.java index a47b256892..a56dd3b9fa 100644 --- a/src/main/org/apache/tools/tar/TarEntry.java +++ b/src/main/org/apache/tools/tar/TarEntry.java @@ -753,7 +753,7 @@ public boolean isGlobalPaxHeader() { } /** - * Return whether or not this entry represents a directory. + * Return whether this entry represents a directory. * * @return True if this entry is a directory. */ diff --git a/src/main/org/apache/tools/tar/TarOutputStream.java b/src/main/org/apache/tools/tar/TarOutputStream.java index 76460e951d..7f62e5ab69 100644 --- a/src/main/org/apache/tools/tar/TarOutputStream.java +++ b/src/main/org/apache/tools/tar/TarOutputStream.java @@ -181,7 +181,7 @@ public void setLongFileMode(int longFileMode) { /** * Set the big number mode. * This can be BIGNUMBER_ERROR(0), BIGNUMBER_POSIX(1) or BIGNUMBER_STAR(2). - * This specifies the treatment of big files (sizes > TarConstants.MAXSIZE) and other numeric values to big to fit into a traditional tar header. + * This specifies the treatment of big files (sizes > TarConstants.MAXSIZE) and other numeric values too big to fit into a traditional tar header. * Default is BIGNUMBER_ERROR. * * @param bigNumberMode the mode to use @@ -422,7 +422,7 @@ public void write(byte[] wBuf, int wOffset, int numToWrite) throws IOException { // The programmer can be writing little 32 byte chunks for all // we know, and we must assemble complete records for writing. // REVIEW Maybe this should be in TarBuffer? Could that help to - // eliminate some of the buffer copying. + // eliminate some buffer copying. // } @@ -508,7 +508,7 @@ void writePaxHeaders(TarEntry entry, // or where UTF-8 encoding isn't a single octet // per character. // Must be in loop as size may go from 99 to 100 in - // first pass so we'd need a second. + // first pass, so we'd need a second. len = actualLength; line = len + " " + key + "=" + value + "\n"; actualLength = line.getBytes(StandardCharsets.UTF_8).length; diff --git a/src/main/org/apache/tools/tar/TarUtils.java b/src/main/org/apache/tools/tar/TarUtils.java index b6e12c4dac..abf8af7fb5 100644 --- a/src/main/org/apache/tools/tar/TarUtils.java +++ b/src/main/org/apache/tools/tar/TarUtils.java @@ -98,7 +98,7 @@ private TarUtils() { * @param offset The offset into the buffer from which to parse. * @param length The maximum number of bytes to parse - must be at least 2 bytes. * @return The long value of the octal string. - * @throws IllegalArgumentException if the trailing space/NUL is missing or if a invalid byte is detected. + * @throws IllegalArgumentException if the trailing space/NUL is missing or if an invalid byte is detected. */ public static long parseOctal(final byte[] buffer, final int offset, final int length) { long result = 0; @@ -412,7 +412,7 @@ public static void formatUnsignedOctalString(final long value, final byte[] buff * @param buf The buffer to receive the output * @param offset The starting offset into the buffer * @param length The size of the output buffer - * @return The updated offset, i.e offset+length + * @return The updated offset, i.e. offset+length * @throws IllegalArgumentException if the value (and trailer) will not fit in the buffer */ public static int formatOctalBytes(final long value, final byte[] buf, final int offset, final int length) { @@ -451,7 +451,7 @@ public static int formatLongOctalBytes(final long value, final byte[] buf, final } /** - * Write an long integer into a buffer as an octal string if this + * Write a long integer into a buffer as an octal string if this * will fit, or as a binary number otherwise. * * Uses {@link #formatUnsignedOctalString} to format diff --git a/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java b/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java index 629f0b6821..954be0d222 100644 --- a/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java +++ b/src/main/org/apache/tools/zip/Simple8BitZipEncoding.java @@ -176,7 +176,7 @@ public boolean pushEncodedChar(final ByteBuffer bb, final char c) { * covered by this encoding. */ private Simple8BitChar encodeHighChar(final char c) { - // for performance an simplicity, yet another reincarnation of + // for performance and simplicity, yet another reincarnation of // binary search... int i0 = 0; int i1 = this.reverseMapping.size(); diff --git a/src/main/org/apache/tools/zip/ZipEncoding.java b/src/main/org/apache/tools/zip/ZipEncoding.java index 5a9fd03c0d..c6e3092f8f 100644 --- a/src/main/org/apache/tools/zip/ZipEncoding.java +++ b/src/main/org/apache/tools/zip/ZipEncoding.java @@ -47,7 +47,7 @@ public interface ZipEncoding { * encoding. * * @param name A filename or ZIP comment. - * @return Whether the given name may be encoded with out any losses. + * @return Whether the given name may be encoded without any losses. */ boolean canEncode(String name); diff --git a/src/main/org/apache/tools/zip/ZipFile.java b/src/main/org/apache/tools/zip/ZipFile.java index 8806ae74c3..18c714838a 100644 --- a/src/main/org/apache/tools/zip/ZipFile.java +++ b/src/main/org/apache/tools/zip/ZipFile.java @@ -673,9 +673,8 @@ private void setSizesAndOffsetFromZip64Extra(final ZipEntry ze, */ private static final int ZIP64_EOCDL_LENGTH = /* zip64 end of central dir locator sig */ WORD - /* number of the disk with the start */ - /* start of the zip64 end of */ - /* central directory */ + WORD + /* number of the disk with the start of */ + /* the zip64 end of central directory */ + WORD /* relative offset of the zip64 */ /* end of central directory record */ + DWORD /* total number of disks */ + WORD; @@ -688,9 +687,8 @@ private void setSizesAndOffsetFromZip64Extra(final ZipEntry ze, */ private static final int ZIP64_EOCDL_LOCATOR_OFFSET = /* zip64 end of central dir locator sig */ WORD - /* number of the disk with the start */ - /* start of the zip64 end of */ - /* central directory */ + WORD; + /* number of the disk with the start of */ + /* the zip64 end of central directory */ + WORD; /** * Offset of the field that holds the location of the first @@ -918,7 +916,7 @@ private void resolveLocalFileHeaderData(final Map } /** - * Checks whether the archive starts with a LFH. If it doesn't, + * Checks whether the archive starts with an LFH. If it doesn't, * it may be an empty archive. */ private boolean startsWithLocalFileHeader() throws IOException { diff --git a/src/main/org/apache/tools/zip/ZipOutputStream.java b/src/main/org/apache/tools/zip/ZipOutputStream.java index 9e216d8ca0..00f221be01 100644 --- a/src/main/org/apache/tools/zip/ZipOutputStream.java +++ b/src/main/org/apache/tools/zip/ZipOutputStream.java @@ -712,7 +712,7 @@ private void rewriteSizesAndCrc(boolean actuallyNeedsZip64) raf.seek(entry.localDataStart - 5 * SHORT); writeOut(ZipShort.getBytes(INITIAL_VERSION)); - // * remove ZIP64 extra so it doesn't get written + // * remove ZIP64 extra, so it doesn't get written // to the central directory entry.entry.removeExtraField(Zip64ExtendedInformationExtraField .HEADER_ID); diff --git a/src/main/org/apache/tools/zip/ZipShort.java b/src/main/org/apache/tools/zip/ZipShort.java index e4f65b1594..7d3949a4d3 100644 --- a/src/main/org/apache/tools/zip/ZipShort.java +++ b/src/main/org/apache/tools/zip/ZipShort.java @@ -61,7 +61,7 @@ public ZipShort(byte[] bytes, int offset) { /** * Get value as two bytes in big endian byte order. - * @return the value as a a two byte array in big endian byte order + * @return the value as a two byte array in big endian byte order * @since 1.1 */ public byte[] getBytes() { diff --git a/src/script/envset.cmd b/src/script/envset.cmd index 846f85d2b5..ee08deefba 100644 --- a/src/script/envset.cmd +++ b/src/script/envset.cmd @@ -37,7 +37,7 @@ not interpreted the parameters are changed to name=expanded_name Other options have optional equal sign. If it is found, only the part after -the equal sign will be oprionally expanded. +the equal sign will be optionally expanded. If the parameter is the minus sign, the next parameter will not be expanded. If the parameter is a single dot, it will be replaced with the value of the diff --git a/src/tests/antunit/taskdefs/exec/exec-test.xml b/src/tests/antunit/taskdefs/exec/exec-test.xml index bbe95e510b..4053ae8745 100644 --- a/src/tests/antunit/taskdefs/exec/exec-test.xml +++ b/src/tests/antunit/taskdefs/exec/exec-test.xml @@ -599,7 +599,7 @@ - + seconds earlier than it was before. Where file + * Modified the timestamp on a file, so it's seconds earlier than it was before. Where file * is a directory, this function recurses into all child files (and directories) and reduces their modified * timestamps by the same range, rather than set all timestamps to the same time. * @param file the file to change, or the directory to change then recurse into diff --git a/src/tests/junit/org/apache/tools/ant/TestHelper.java b/src/tests/junit/org/apache/tools/ant/TestHelper.java index 9f8582fbcf..100df4b10b 100644 --- a/src/tests/junit/org/apache/tools/ant/TestHelper.java +++ b/src/tests/junit/org/apache/tools/ant/TestHelper.java @@ -29,7 +29,7 @@ public class TestHelper { /** * Find a TCP/IP port which may continue to be available. *
          - * The returned port is available since a socket has successfully bind to it, but this availability is not ensured + * The returned port is available since a socket has successfully bound to it, but this availability is not ensured * after this method since the associated socket is released and some other process can now use it. */ public static int getMaybeAvailablePort() { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/AntStructureTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/AntStructureTest.java index 486b49eee9..126bfc81f4 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/AntStructureTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/AntStructureTest.java @@ -66,7 +66,7 @@ public void testCustomPrinter() { // can't access the booleans in MyPrinter here (even if they // were static) since the MyPrinter instance that was used in // the test has likely been loaded via a different classloader - // than this class. Therefore we make the printer assert its + // than this class. Therefore, we make the printer assert its // state and only check for the tail invocation. assertThat(buildRule.getLog(), containsString(MyPrinter.TAIL_CALLED)); } diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/ConcatTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/ConcatTest.java index 5c2b177dd1..3d8712c0bc 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/ConcatTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/ConcatTest.java @@ -221,7 +221,7 @@ public void testfileheader() { } /** - * Expect an exception when attempting to cat an file to itself + * Expect an exception when attempting to cat a file to itself */ @Test(expected = BuildException.class) public void testsame() { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/CopyTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/CopyTest.java index 64173f4fa5..db1f78edfe 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/CopyTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/CopyTest.java @@ -277,7 +277,7 @@ public void testCopyToSymlinkedSelf() throws Exception { // we are only going to test against systems that support symlinks assumeTrue("Symlinks not supported on this operating system", Os.isFamily(Os.FAMILY_UNIX)); - // setup the source files to run copying against + // set up the source files to run copying against buildRule.executeTarget("setupSelfCopyTesting"); final File testDir = new File(buildRule.getProject().getProperty("self.copy.test.root.dir")); assertTrue(testDir + " was expected to be a directory", testDir.isDirectory()); diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/ExecTaskTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/ExecTaskTest.java index d77bd40e7c..d471786266 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/ExecTaskTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/ExecTaskTest.java @@ -48,7 +48,7 @@ public class ExecTaskTest { private static final int TIME_TO_WAIT = 1; /** maximum time allowed for the build in milliseconds */ private static final int MAX_BUILD_TIME = 6000; - private static final int SECURITY_MARGIN = 4000; // wait 4 second extras + private static final int SECURITY_MARGIN = 4000; // wait 4-second extras // the test failed with 100 ms of margin on cvs.apache.org on August 1st, 2003 // the test randomly failed with 3 s of margin on Windows Jenkins slaves on during July 2014 @@ -92,7 +92,7 @@ public void testspawn() throws InterruptedException { } // now wait until the spawned process is finished Thread.sleep((TIME_TO_WAIT) * 1000 + SECURITY_MARGIN); - // time of the build in milli seconds + // time of the build in milliseconds long elapsed = myBuild.getTimeElapsed(); assertTrue("we waited more than the process lasted", TIME_TO_WAIT * 1000 + SECURITY_MARGIN > elapsed); diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/JarTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/JarTest.java index 21cdd6847b..837e63f1b1 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/JarTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/JarTest.java @@ -148,13 +148,13 @@ public void testRecreateWithUpdateNewerFile() { } private void testRecreate(String firstTarget, String secondTarget) { - //Move the modified date on all input back a couple of seconds rather then delay the test to achieve a similar effect + //Move the modified date on all input back a couple of seconds rather than delaying the test to achieve a similar effect FileUtilities.rollbackTimestamps(buildRule.getProject().getBaseDir(), 5); buildRule.executeTarget(firstTarget); File jarFile = new File(getOutputDir(), tempJar); - //Move the modified date back a couple of seconds rather then delay the test to achieve a similar effect + //Move the modified date back a couple of seconds rather than delaying the test to achieve a similar effect FileUtilities.rollbackTimestamps(buildRule.getOutputDir(), 5); long jarModifiedDate = jarFile.lastModified(); diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/JavaTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/JavaTest.java index 12654617df..33d4d2e04a 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/JavaTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/JavaTest.java @@ -362,7 +362,7 @@ protected InputStream getInputStream() { }); inputThread.start(); - // wait a little bit for the task to wait for input + // wait a little for the task to wait for input Thread.sleep(100); // write some stuff in the input stream to be caught by the input task @@ -396,7 +396,7 @@ protected InputStream getInputStream() { Thread writingThread = new Thread(() -> { try { - // wait a little bit to have the target executed + // wait a little to have the target executed Thread.sleep(500); } catch (InterruptedException e) { throw new AssumptionViolatedException("Thread interrupted", e); diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java index 7ec700dc2e..40787ee8ea 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/ManifestClassPathTest.java @@ -225,7 +225,7 @@ public void testSameWindowsDrive() { @Test public void testDifferentWindowsDrive() { assumeTrue("Test with drive letters only run on windows", Os.isFamily("windows")); - // the lines below try to find a drive name different than the one containing the temp dir + // the lines below try to find a drive name different from the one containing the temp dir // if the temp dir is C will try to use D // if the temp dir is on D or other will try to use C File tmpdir = new File(System.getProperty("java.io.tmpdir")); diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/SyncTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/SyncTest.java index 85e09e70af..fc19721198 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/SyncTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/SyncTest.java @@ -150,7 +150,7 @@ public void testCaseSensitivityOfDest() { assertFileIsPresent(destDir + "/a.txt"); final boolean caseSensitive = FileUtils.isCaseSensitiveFileSystem( buildRule.getProject().resolveFile(destDir).toPath()) - .orElse(true); // directory scanner defaults to case sensitive = true + .orElse(true); // directory scanner defaults to case-sensitive = true if (caseSensitive) { assertFileIsNotPresent(destDir + "/A.txt"); } else { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/XmlPropertyTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/XmlPropertyTest.java index 7f9f801621..d9bc9f462b 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/XmlPropertyTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/XmlPropertyTest.java @@ -149,7 +149,7 @@ public void testNeedsCatalog() { private void doTest(String msg, boolean keepRoot, boolean collapse, boolean semantic, boolean include, boolean localRoot) throws IOException { for (File inputFile : getFiles(buildRule.getProject().resolveFile("xmlproperty/inputs"))) { - // What's the working directory? If local, then its the + // What's the working directory? If local, then it's the // folder of the input file. Otherwise, its the "current" dir.. File workingDir; if (localRoot) { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/condition/HttpTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/condition/HttpTest.java index 01cfc484c2..145e330b62 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/condition/HttpTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/condition/HttpTest.java @@ -29,7 +29,7 @@ /** * Testcases for the <http> condition. All these tests require * us to be online as they attempt to get the status of various pages - * on the Ant Apache web site. + * on the Ant Apache website. */ public class HttpTest { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/ANTLRTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/ANTLRTest.java index fea51f62ab..2621345836 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/ANTLRTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/ANTLRTest.java @@ -126,7 +126,7 @@ public void test9() { /** * This test creates an html-ized version of the calculator grammar. - * The sanity check is simply whether or not an html file was generated. + * The sanity check is simply whether an html file was generated. */ @Test public void test10() { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/EchoPropertiesTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/EchoPropertiesTest.java index b2c30541ed..8359e67ff7 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/EchoPropertiesTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/EchoPropertiesTest.java @@ -182,7 +182,7 @@ public void testWithRegex() { RegexpMatcherFactory.regexpMatcherPresent(buildRule.getProject())); buildRule.executeTarget("testWithRegex"); // the following line has been changed from checking ant.home to ant.version - // so the test will still work when run outside of an Ant script + // so the test will still work when run outside an Ant script assertThat(buildRule.getFullLog(), containsString(MagicNames.ANT_VERSION + "=")); } diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/JspcTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/JspcTest.java index 089403c569..6a03235eab 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/JspcTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/JspcTest.java @@ -167,7 +167,7 @@ public void testJasper41() { assertMapped(mangler, "0.jsp", "_0_jsp"); //underscores at the front get an underscore too assertMapped(mangler, "_.jsp", "___jsp"); - //non java char at start => underscore then the the _hex value + //non java char at start => underscore then the _hex value assertMapped(mangler, "-.jsp", "__0002d_jsp"); //and paths are stripped char s = File.separatorChar; diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/PropertyFileTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/PropertyFileTest.java index c116990a4f..c9b564eca2 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/PropertyFileTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/PropertyFileTest.java @@ -36,7 +36,7 @@ /** * JUnit testcase that exercises the optional PropertyFile task in ant. - * (this is really more of a functional test so far.., but it's enough to let + * (this is really more of a functional test so far, but it's enough to let * me start refactoring...) * *created October 2, 2001 @@ -71,8 +71,8 @@ public void testNonExistingFile() { } /** - * A unit test for JUnit- Exercises the propertyfile tasks ability to - * update properties that are already defined- + * A unit test for JUnit - Exercises the propertyfile tasks ability to + * update properties that are already defined. */ @Test public void testUpdatesExistingProperties() throws Exception { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/RpmTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/RpmTest.java index 7291a9e0cc..5c07fcb29e 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/RpmTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/RpmTest.java @@ -48,7 +48,7 @@ public void testShouldNotThrowExceptionWhenRpmFails() { rpm.execute(); } - // override some of the code so we can test the handling of the + // override some code, so we can test the handling of the // return code only. public static class MyRpm extends Rpm { protected Execute getExecute(Commandline toExecute, diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java index 9ea6089c80..72f6ad28c8 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/TraXLiaisonTest.java @@ -141,7 +141,7 @@ public void testMultipleTransform() throws Exception { liaison.setStylesheet(xsl); liaison.addParam("param", "value"); File in = getFile("/taskdefs/optional/xsltliaison-in.xml"); - // test for 10 consecutives transform + // test for 10 consecutive transforms for (int i = 0; i < 50; i++) { File out = new File("xsltliaison" + i + ".tmp"); try { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/depend/DependTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/depend/DependTest.java index 8b24b0eb34..1ab3502872 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/depend/DependTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/depend/DependTest.java @@ -180,7 +180,7 @@ public void testCache() { } /** - * Test the detection and warning of non public classes + * Test the detection and warning of non-public classes */ @Test public void testNonPublic() { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitReportTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitReportTest.java index 078e800f6e..84a44dc939 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitReportTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitReportTest.java @@ -44,7 +44,7 @@ /** * Small testcase for the junitreporttask. - * First test added to reproduce an fault, still a lot to improve + * First test added to reproduce a fault, still a lot to improve * */ public class JUnitReportTest { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskTest.java index 0e69d9fda0..0255b660fd 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskTest.java @@ -249,7 +249,7 @@ public void testFailureRecorder() { assertThat(buildRule.getOutput(), containsString("3rd run: should run D.test10")); - // 4rd run: two running tests with errors + // 4th run: two running tests with errors buildRule.executeTarget("failureRecorder.runtest"); assertTrue("The collector file '" + collectorFile.getAbsolutePath() + "' should exist after the 4th run.", diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunnerTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunnerTest.java index ad25425cd6..903937ef58 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunnerTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunnerTest.java @@ -181,7 +181,7 @@ private static final class TestRunner extends JUnitTestRunner { false, false, TestRunner.class.getClassLoader()); // use the classloader that loaded this class otherwise // it will not be able to run inner classes if this test - // is ran in non-forked mode. + // is run in non-forked mode. addFormatter(formatter); } ResultFormatter getFormatter() { diff --git a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junitlauncher/JUnitLauncherTaskTest.java b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junitlauncher/JUnitLauncherTaskTest.java index 1c36672227..a7dc3e3a42 100644 --- a/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junitlauncher/JUnitLauncherTaskTest.java +++ b/src/tests/junit/org/apache/tools/ant/taskdefs/optional/junitlauncher/JUnitLauncherTaskTest.java @@ -84,7 +84,7 @@ public void testFailureStopsBuild() throws Exception { } /** - * Tests that when a test, that's isn't configured with {@code haltOnFailure=true}, continues the + * Tests that when a test, that isn't configured with {@code haltOnFailure=true}, continues the * build even when there are test failures */ @Test @@ -197,7 +197,7 @@ private void verifyLegacyXMLFile(final String fileName, final String expectedCon public void testBasicFork() throws Exception { final String targetName = "test-basic-fork"; final Path trackerFile = setupTrackerProperty(targetName); - // setup a dummy and incorrect value of a sysproperty that's used in the test + // set up a dummy and incorrect value of a sysproperty that's used in the test // being forked System.setProperty(ForkedTest.SYS_PROP_ONE, "dummy"); buildRule.executeTarget(targetName); @@ -249,7 +249,7 @@ public void testExcludeAntRuntimeLibs() throws Exception { Assert.fail(targetName + " was expected to fail since Ant runtime libraries " + "weren't included in the classpath of the forked JVM"); } catch (BuildException be) { - // expect a Error due to missing main class (which is part of Ant runtime libraries + // expect an Error due to missing main class (which is part of Ant runtime libraries // that we excluded) final String missingMainClass = "Could not find or load main class " + StandaloneLauncher.class.getName(); if (!buildRule.getFullLog().contains(missingMainClass)) { @@ -406,7 +406,7 @@ public void testBeforeAllFailureStopsBuild() throws Exception { } /** - * Tests that when a test, that's isn't configured with {@code haltOnFailure=true}, continues the + * Tests that when a test, that isn't configured with {@code haltOnFailure=true}, continues the * build even when there are test failures */ @Test @@ -488,7 +488,7 @@ private Path setupTrackerProperty(final String targetName) { } private void setupRuntimeClassesProperty() { - // setup a property that points to the locations of Ant runtime classes. + // set up a property that points to the locations of Ant runtime classes. // this path will then be used in target to create a duplicate copied // classes and then will be used as a custom location for Ant runtime libraries final String projectResourceName = LoaderUtils.classNameToResource(Project.class.getName()); diff --git a/src/tests/junit/org/apache/tools/ant/types/CommandlineJavaTest.java b/src/tests/junit/org/apache/tools/ant/types/CommandlineJavaTest.java index 07afc7b58a..1cae1aaad2 100644 --- a/src/tests/junit/org/apache/tools/ant/types/CommandlineJavaTest.java +++ b/src/tests/junit/org/apache/tools/ant/types/CommandlineJavaTest.java @@ -83,7 +83,7 @@ public void testGetCommandline() throws CloneNotSupportedException { assertEquals("no classpath", 4, s.length); /* * After changing CommandlineJava to search for the java - * executable, I don't know, how to tests the value returned + * executable, I don't know, how to test the value returned * here without using the same logic as applied in the class * itself. * diff --git a/src/tests/junit/org/apache/tools/ant/types/PathTest.java b/src/tests/junit/org/apache/tools/ant/types/PathTest.java index 47ad4982b6..7c8d283d06 100644 --- a/src/tests/junit/org/apache/tools/ant/types/PathTest.java +++ b/src/tests/junit/org/apache/tools/ant/types/PathTest.java @@ -226,7 +226,7 @@ public void testConstructorNetWareStyle() { } } - // try a multi-part netware-volume length path, see how it is handled + // try a multipart netware-volume length path, see how it is handled @Test public void testConstructorNetWareStyleTwoItems() { p = new Path(project, "sys:\\test;dev:\\temp"); @@ -278,7 +278,7 @@ public void testConstructorNetWareStyleUnixFS() { } } - // try a multi-part netware-volume length path w/forward slash, see how it is handled + // try a multipart netware-volume length path w/forward slash, see how it is handled @Test public void testConstructorNetWareStyleUnixFSTwoItems() { p = new Path(project, "sys:/test;dev:/temp"); @@ -308,7 +308,7 @@ public void testConstructorNetWareStyleUnixFSTwoItems() { } } - // try a multi-part netware-volume length path with UNIX + // try a multipart netware-volume length path with UNIX // separator (this testcase if from an actual bug that was // found, in AvailableTest, which uses PathTokenizer) @Test diff --git a/src/tests/junit/org/apache/tools/ant/types/mappers/MapperResult.java b/src/tests/junit/org/apache/tools/ant/types/mappers/MapperResult.java index 1000ded2d1..1a5d96ee1b 100644 --- a/src/tests/junit/org/apache/tools/ant/types/mappers/MapperResult.java +++ b/src/tests/junit/org/apache/tools/ant/types/mappers/MapperResult.java @@ -27,7 +27,7 @@ * This is a test task to show the result of a mapper * on a specific input. * (Test is not in the name of the class, to make sure that - * it is not treated as a unit test. + * it is not treated as a unit test.) */ public class MapperResult extends Task { diff --git a/src/tests/junit/org/apache/tools/ant/types/selectors/DateSelectorTest.java b/src/tests/junit/org/apache/tools/ant/types/selectors/DateSelectorTest.java index 68e0edec41..478f6071a8 100644 --- a/src/tests/junit/org/apache/tools/ant/types/selectors/DateSelectorTest.java +++ b/src/tests/junit/org/apache/tools/ant/types/selectors/DateSelectorTest.java @@ -209,7 +209,7 @@ public void testSelectionBehaviourAfterWithGranularity() { s.setWhen(after); s.setGranularity(2); - // setup the modified timestamp to match what the test needs, although be aware that + // set up the modified timestamp to match what the test needs, although be aware that // the 3rd and 4th files don't exist so can't be changed, so don't try and loop over them for (int i = 1; i <= 2; i++) { assumeTrue("Cannot setup file times for test", diff --git a/src/tests/junit/org/apache/tools/ant/types/selectors/ModifiedSelectorTest.java b/src/tests/junit/org/apache/tools/ant/types/selectors/ModifiedSelectorTest.java index 1e84bb7ae0..74d2866df7 100644 --- a/src/tests/junit/org/apache/tools/ant/types/selectors/ModifiedSelectorTest.java +++ b/src/tests/junit/org/apache/tools/ant/types/selectors/ModifiedSelectorTest.java @@ -198,13 +198,13 @@ public void doDelayUpdateTest(int kind) { // readable form of parameter kind String[] kinds = {"task", "target", "build"}; - // setup the "Ant project" + // set up the "Ant project" MockProject project = new MockProject(); File base = new File("base"); File file1 = new File("file1"); File file2 = new File("file2"); - // setup the selector + // set up the selector ModifiedSelector sel = new ModifiedSelector(); sel.setProject(project); sel.setUpdate(true); @@ -455,7 +455,7 @@ public void testChecksumAlgorithmAdler() { /** * Test the interface semantic of Algorithms. * This method does some common test for algorithm implementations. - * An algorithm must return always the same value for the same file and + * An algorithm must return always the same value for the same file, and * it must not return null. * * @param algo configured test object @@ -674,7 +674,7 @@ public void testScenario1() { // // Mark all files which should be selected as (T)rue and all others - // as (F)alse. Directories are always selected so they always are + // as (F)alse. Directories are always selected, so they always are // (T)rue. StringBuilder expected = new StringBuilder(); for (int i = 0; i < selectorRule.getFiles().length; i++) { @@ -710,7 +710,7 @@ public void testScenario1() { /** * This scenario is based on scenario 1, but does not use any - * default value and its based on <custom> selector. Used values are: + * default value and it's based on <custom> selector. Used values are: *
          • Cache: Propertyfile, * cachefile={java.io.tmpdir}/mycache.txt
            • *
          • Algorithm: Digest diff --git a/src/tests/junit/org/apache/tools/ant/types/selectors/README b/src/tests/junit/org/apache/tools/ant/types/selectors/README index f44ac9ae1e..357c727108 100644 --- a/src/tests/junit/org/apache/tools/ant/types/selectors/README +++ b/src/tests/junit/org/apache/tools/ant/types/selectors/README @@ -60,7 +60,7 @@ The first test says that none of the 12 files or directories will match if the depth range for the selector is between 20 and 25 (that would be one deep directory tree!). The second says that all files and directories match if the minimum depth is set to 0 and the maximum isn't specified. The -third test says that if the minumum depth is 1, the first 5 entries in the +third test says that if the minimum depth is 1, the first 5 entries in the list of 12 will not be selected and the rest will. diff --git a/src/tests/junit/org/apache/tools/ant/util/FileUtilsTest.java b/src/tests/junit/org/apache/tools/ant/util/FileUtilsTest.java index 555916cac3..d3b18ace6c 100644 --- a/src/tests/junit/org/apache/tools/ant/util/FileUtilsTest.java +++ b/src/tests/junit/org/apache/tools/ant/util/FileUtilsTest.java @@ -687,10 +687,10 @@ public void testModificationTests() { fu.isUpToDate(firstTime, firstTime)); */ - //check that older is up to date with a newer dest + //check that older is up-to-date with a newer dest assertTrue("older source files are up to date", getFileUtils().isUpToDate(firstTime,secondTime)); - //check that older is up to date with a newer dest + //check that older is up-to-date with a newer dest assertFalse("newer source files are no up to date", getFileUtils().isUpToDate(secondTime, firstTime)); @@ -706,7 +706,7 @@ public void testHasErrorInCase() { String s = wellcased.getName().toUpperCase(); File wrongcased = new File(tempFolder, s); if (Os.isFamily("mac") && Os.isFamily("unix")) { - //no guarantees on filesystem case-sensitivity + //no guarantees on filesystem case sensitivity } else if (Os.isFamily("dos")) { assertTrue(getFileUtils().hasErrorInCase(wrongcased)); assertFalse(getFileUtils().hasErrorInCase(wellcased)); @@ -811,7 +811,7 @@ public void testCaseSensitiveFileSystem() throws Exception { final boolean existsAsLowerCase = Files.exists(Paths.get(tmpDir.toString(), tmpFile.getFileName().toString().toLowerCase(Locale.US))); final boolean existsAsUpperCase = Files.exists(Paths.get(tmpDir.toString(), tmpFile.getFileName().toString().toUpperCase(Locale.US))); // if the temp file that we created is found to not exist in a particular "case", then - // the filesystem is case sensitive + // the filesystem is case-sensitive final Boolean expectedCaseSensitivity = !existsAsLowerCase || !existsAsUpperCase; // call the method and pass it a directory