You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2014/01/31 20:45:31 UTC
svn commit: r1563227 - in /commons/proper/io/trunk/src: changes/
main/java/org/apache/commons/io/ main/java/org/apache/commons/io/filefilter/
main/java/org/apache/commons/io/input/
Author: ggregory
Date: Fri Jan 31 19:45:30 2014
New Revision: 1563227
URL: http://svn.apache.org/r1563227
Log:
[IO-424] Javadoc fixes, mostly to appease 1.8.0. Patch from Ville Skyttä". 3 files in the patch did not applied cleanly, so they are not in the commit.
Modified:
commons/proper/io/trunk/src/changes/changes.xml
commons/proper/io/trunk/src/main/java/org/apache/commons/io/Charsets.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileDeleteStrategy.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FilenameUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/ThreadMonitor.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullInputStream.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullReader.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/Tailer.java
Modified: commons/proper/io/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/changes/changes.xml?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/changes/changes.xml (original)
+++ commons/proper/io/trunk/src/changes/changes.xml Fri Jan 31 19:45:30 2014
@@ -47,6 +47,9 @@ The <action> type attribute can be add,u
<body>
<!-- The release date is the date RC is cut -->
<release version="2.5" date="2014-??-??" description="New features and bug fixes.">
+ <action issue="IO-424" dev="ggregory" type="fix" due-to="Ville Skyttä">
+ Javadoc fixes, mostly to appease 1.8.0
+ </action>
<action issue="IO-422" dev="ggregory" type="update">
Deprecate Charsets Charset constants in favor of Java 7's java.nio.charset.StandardCharsets
</action>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/Charsets.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/Charsets.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/Charsets.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/Charsets.java Fri Jan 31 19:45:30 2014
@@ -34,17 +34,17 @@ import java.util.TreeMap;
* </p>
*
* <ul>
- * <li><code>US-ASCII</code><br/>
+ * <li><code>US-ASCII</code><br>
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
- * <li><code>ISO-8859-1</code><br/>
+ * <li><code>ISO-8859-1</code><br>
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
- * <li><code>UTF-8</code><br/>
+ * <li><code>UTF-8</code><br>
* Eight-bit Unicode Transformation Format.</li>
- * <li><code>UTF-16BE</code><br/>
+ * <li><code>UTF-16BE</code><br>
* Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
- * <li><code>UTF-16LE</code><br/>
+ * <li><code>UTF-16LE</code><br>
* Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
- * <li><code>UTF-16</code><br/>
+ * <li><code>UTF-16</code><br>
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
* accepted on input, big-endian used on output.)</li>
* </ul>
@@ -109,7 +109,7 @@ public class Charsets {
}
/**
- * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1. </p>
+ * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java Fri Jan 31 19:45:30 2014
@@ -49,7 +49,7 @@ import java.nio.charset.Charset;
* to be selected (otherwise the platform default is used). We would like to
* encourage you to always specify the encoding because relying on the platform
* default can lead to unexpected results.
- * <p
+ * <p>
* We don't provide special variants for the <code>copy</code> methods that
* let you specify the buffer size because in modern VMs the impact on speed
* seems to be minimal. We're using a default buffer size of 4 KB.
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileDeleteStrategy.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileDeleteStrategy.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileDeleteStrategy.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileDeleteStrategy.java Fri Jan 31 19:45:30 2014
@@ -139,7 +139,7 @@ public class FileDeleteStrategy {
/**
* Deletes the file object.
* <p>
- * This implementation uses <code>FileUtils.forceDelete() <code>
+ * This implementation uses <code>FileUtils.forceDelete()</code>
* if the file exists.
*
* @param fileToDelete the file to delete, not null
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileUtils.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileUtils.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileUtils.java Fri Jan 31 19:45:30 2014
@@ -1292,13 +1292,13 @@ public class FileUtils {
* it is not guaranteed that those operations will succeed.
* If the modification operation fails, no indication is provided.
*
- * <h4>Example: Copy directories only</h4>
+ * <h3>Example: Copy directories only</h3>
* <pre>
* // only copy the directory structure
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY);
* </pre>
*
- * <h4>Example: Copy directories and txt files</h4>
+ * <h3>Example: Copy directories and txt files</h3>
* <pre>
* // Create a filter for ".txt" files
* IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
@@ -1342,13 +1342,13 @@ public class FileUtils {
* not guaranteed that those operations will succeed.
* If the modification operation fails, no indication is provided.
*
- * <h4>Example: Copy directories only</h4>
+ * <h3>Example: Copy directories only</h3>
* <pre>
* // only copy the directory structure
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY, false);
* </pre>
*
- * <h4>Example: Copy directories and txt files</h4>
+ * <h3>Example: Copy directories and txt files</h3>
* <pre>
* // Create a filter for ".txt" files
* IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/FilenameUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FilenameUtils.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/FilenameUtils.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/FilenameUtils.java Fri Jan 31 19:45:30 2014
@@ -58,19 +58,19 @@ import java.util.Stack;
* Prefixes are matched as follows:
* <pre>
* Windows:
- * a\b\c.txt --> "" --> relative
- * \a\b\c.txt --> "\" --> current drive absolute
- * C:a\b\c.txt --> "C:" --> drive relative
- * C:\a\b\c.txt --> "C:\" --> absolute
- * \\server\a\b\c.txt --> "\\server\" --> UNC
+ * a\b\c.txt --> "" --> relative
+ * \a\b\c.txt --> "\" --> current drive absolute
+ * C:a\b\c.txt --> "C:" --> drive relative
+ * C:\a\b\c.txt --> "C:\" --> absolute
+ * \\server\a\b\c.txt --> "\\server\" --> UNC
*
* Unix:
- * a/b/c.txt --> "" --> relative
- * /a/b/c.txt --> "/" --> absolute
- * ~/a/b/c.txt --> "~/" --> current user
- * ~ --> "~/" --> current user (slash added)
- * ~user/a/b/c.txt --> "~user/" --> named user
- * ~user --> "~user/" --> named user (slash added)
+ * a/b/c.txt --> "" --> relative
+ * /a/b/c.txt --> "/" --> absolute
+ * ~/a/b/c.txt --> "~/" --> current user
+ * ~ --> "~/" --> current user (slash added)
+ * ~user/a/b/c.txt --> "~user/" --> named user
+ * ~user --> "~user/" --> named user (slash added)
* </pre>
* Both prefix styles are matched always, irrespective of the machine that you are
* currently running on.
@@ -167,23 +167,23 @@ public class FilenameUtils {
* The output will be the same on both Unix and Windows except
* for the separator character.
* <pre>
- * /foo// --> /foo/
- * /foo/./ --> /foo/
- * /foo/../bar --> /bar
- * /foo/../bar/ --> /bar/
- * /foo/../bar/../baz --> /baz
- * //foo//./bar --> /foo/bar
- * /../ --> null
- * ../foo --> null
- * foo/bar/.. --> foo/
- * foo/../../bar --> null
- * foo/../bar --> bar
- * //server/foo/../bar --> //server/bar
- * //server/../bar --> null
- * C:\foo\..\bar --> C:\bar
- * C:\..\bar --> null
- * ~/foo/../bar/ --> ~/bar/
- * ~/../bar --> null
+ * /foo// --> /foo/
+ * /foo/./ --> /foo/
+ * /foo/../bar --> /bar
+ * /foo/../bar/ --> /bar/
+ * /foo/../bar/../baz --> /baz
+ * //foo//./bar --> /foo/bar
+ * /../ --> null
+ * ../foo --> null
+ * foo/bar/.. --> foo/
+ * foo/../../bar --> null
+ * foo/../bar --> bar
+ * //server/foo/../bar --> //server/bar
+ * //server/../bar --> null
+ * C:\foo\..\bar --> C:\bar
+ * C:\..\bar --> null
+ * ~/foo/../bar/ --> ~/bar/
+ * ~/../bar --> null
* </pre>
* (Note the file separator returned will be correct for Windows/Unix)
*
@@ -210,23 +210,23 @@ public class FilenameUtils {
* The output will be the same on both Unix and Windows except
* for the separator character.
* <pre>
- * /foo// --> /foo/
- * /foo/./ --> /foo/
- * /foo/../bar --> /bar
- * /foo/../bar/ --> /bar/
- * /foo/../bar/../baz --> /baz
- * //foo//./bar --> /foo/bar
- * /../ --> null
- * ../foo --> null
- * foo/bar/.. --> foo/
- * foo/../../bar --> null
- * foo/../bar --> bar
- * //server/foo/../bar --> //server/bar
- * //server/../bar --> null
- * C:\foo\..\bar --> C:\bar
- * C:\..\bar --> null
- * ~/foo/../bar/ --> ~/bar/
- * ~/../bar --> null
+ * /foo// --> /foo/
+ * /foo/./ --> /foo/
+ * /foo/../bar --> /bar
+ * /foo/../bar/ --> /bar/
+ * /foo/../bar/../baz --> /baz
+ * //foo//./bar --> /foo/bar
+ * /../ --> null
+ * ../foo --> null
+ * foo/bar/.. --> foo/
+ * foo/../../bar --> null
+ * foo/../bar --> bar
+ * //server/foo/../bar --> //server/bar
+ * //server/../bar --> null
+ * C:\foo\..\bar --> C:\bar
+ * C:\..\bar --> null
+ * ~/foo/../bar/ --> ~/bar/
+ * ~/../bar --> null
* </pre>
* The output will be the same on both Unix and Windows including
* the separator character.
@@ -261,23 +261,23 @@ public class FilenameUtils {
* The output will be the same on both Unix and Windows except
* for the separator character.
* <pre>
- * /foo// --> /foo
- * /foo/./ --> /foo
- * /foo/../bar --> /bar
- * /foo/../bar/ --> /bar
- * /foo/../bar/../baz --> /baz
- * //foo//./bar --> /foo/bar
- * /../ --> null
- * ../foo --> null
- * foo/bar/.. --> foo
- * foo/../../bar --> null
- * foo/../bar --> bar
- * //server/foo/../bar --> //server/bar
- * //server/../bar --> null
- * C:\foo\..\bar --> C:\bar
- * C:\..\bar --> null
- * ~/foo/../bar/ --> ~/bar
- * ~/../bar --> null
+ * /foo// --> /foo
+ * /foo/./ --> /foo
+ * /foo/../bar --> /bar
+ * /foo/../bar/ --> /bar
+ * /foo/../bar/../baz --> /baz
+ * //foo//./bar --> /foo/bar
+ * /../ --> null
+ * ../foo --> null
+ * foo/bar/.. --> foo
+ * foo/../../bar --> null
+ * foo/../bar --> bar
+ * //server/foo/../bar --> //server/bar
+ * //server/../bar --> null
+ * C:\foo\..\bar --> C:\bar
+ * C:\..\bar --> null
+ * ~/foo/../bar/ --> ~/bar
+ * ~/../bar --> null
* </pre>
* (Note the file separator returned will be correct for Windows/Unix)
*
@@ -306,23 +306,23 @@ public class FilenameUtils {
* The output will be the same on both Unix and Windows including
* the separator character.
* <pre>
- * /foo// --> /foo
- * /foo/./ --> /foo
- * /foo/../bar --> /bar
- * /foo/../bar/ --> /bar
- * /foo/../bar/../baz --> /baz
- * //foo//./bar --> /foo/bar
- * /../ --> null
- * ../foo --> null
- * foo/bar/.. --> foo
- * foo/../../bar --> null
- * foo/../bar --> bar
- * //server/foo/../bar --> //server/bar
- * //server/../bar --> null
- * C:\foo\..\bar --> C:\bar
- * C:\..\bar --> null
- * ~/foo/../bar/ --> ~/bar
- * ~/../bar --> null
+ * /foo// --> /foo
+ * /foo/./ --> /foo
+ * /foo/../bar --> /bar
+ * /foo/../bar/ --> /bar
+ * /foo/../bar/../baz --> /baz
+ * //foo//./bar --> /foo/bar
+ * /../ --> null
+ * ../foo --> null
+ * foo/bar/.. --> foo
+ * foo/../../bar --> null
+ * foo/../bar --> bar
+ * //server/foo/../bar --> //server/bar
+ * //server/../bar --> null
+ * C:\foo\..\bar --> C:\bar
+ * C:\..\bar --> null
+ * ~/foo/../bar/ --> ~/bar
+ * ~/../bar --> null
* </pre>
*
* @param filename the filename to normalize, null returns null
@@ -456,17 +456,17 @@ public class FilenameUtils {
* The output will be the same on both Unix and Windows except
* for the separator character.
* <pre>
- * /foo/ + bar --> /foo/bar
- * /foo + bar --> /foo/bar
- * /foo + /bar --> /bar
- * /foo + C:/bar --> C:/bar
- * /foo + C:bar --> C:bar (*)
- * /foo/a/ + ../bar --> foo/bar
- * /foo/ + ../../bar --> null
- * /foo/ + /bar --> /bar
- * /foo/.. + /bar --> /bar
- * /foo + bar/c.txt --> /foo/bar/c.txt
- * /foo/c.txt + bar --> /foo/c.txt/bar (!)
+ * /foo/ + bar --> /foo/bar
+ * /foo + bar --> /foo/bar
+ * /foo + /bar --> /bar
+ * /foo + C:/bar --> C:/bar
+ * /foo + C:bar --> C:bar (*)
+ * /foo/a/ + ../bar --> foo/bar
+ * /foo/ + ../../bar --> null
+ * /foo/ + /bar --> /bar
+ * /foo/.. + /bar --> /bar
+ * /foo + bar/c.txt --> /foo/bar/c.txt
+ * /foo/c.txt + bar --> /foo/c.txt/bar (!)
* </pre>
* (*) Note that the Windows relative drive prefix is unreliable when
* used with this method.
@@ -598,22 +598,22 @@ public class FilenameUtils {
* than the length of the input string.
* <pre>
* Windows:
- * a\b\c.txt --> "" --> relative
- * \a\b\c.txt --> "\" --> current drive absolute
- * C:a\b\c.txt --> "C:" --> drive relative
- * C:\a\b\c.txt --> "C:\" --> absolute
- * \\server\a\b\c.txt --> "\\server\" --> UNC
- * \\\a\b\c.txt --> error, length = -1
+ * a\b\c.txt --> "" --> relative
+ * \a\b\c.txt --> "\" --> current drive absolute
+ * C:a\b\c.txt --> "C:" --> drive relative
+ * C:\a\b\c.txt --> "C:\" --> absolute
+ * \\server\a\b\c.txt --> "\\server\" --> UNC
+ * \\\a\b\c.txt --> error, length = -1
*
* Unix:
- * a/b/c.txt --> "" --> relative
- * /a/b/c.txt --> "/" --> absolute
- * ~/a/b/c.txt --> "~/" --> current user
- * ~ --> "~/" --> current user (slash added)
- * ~user/a/b/c.txt --> "~user/" --> named user
- * ~user --> "~user/" --> named user (slash added)
- * //server/a/b/c.txt --> "//server/"
- * ///a/b/c.txt --> error, length = -1
+ * a/b/c.txt --> "" --> relative
+ * /a/b/c.txt --> "/" --> absolute
+ * ~/a/b/c.txt --> "~/" --> current user
+ * ~ --> "~/" --> current user (slash added)
+ * ~user/a/b/c.txt --> "~user/" --> named user
+ * ~user --> "~user/" --> named user (slash added)
+ * //server/a/b/c.txt --> "//server/"
+ * ///a/b/c.txt --> error, length = -1
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -732,19 +732,19 @@ public class FilenameUtils {
* The prefix includes the first slash in the full filename where applicable.
* <pre>
* Windows:
- * a\b\c.txt --> "" --> relative
- * \a\b\c.txt --> "\" --> current drive absolute
- * C:a\b\c.txt --> "C:" --> drive relative
- * C:\a\b\c.txt --> "C:\" --> absolute
- * \\server\a\b\c.txt --> "\\server\" --> UNC
+ * a\b\c.txt --> "" --> relative
+ * \a\b\c.txt --> "\" --> current drive absolute
+ * C:a\b\c.txt --> "C:" --> drive relative
+ * C:\a\b\c.txt --> "C:\" --> absolute
+ * \\server\a\b\c.txt --> "\\server\" --> UNC
*
* Unix:
- * a/b/c.txt --> "" --> relative
- * /a/b/c.txt --> "/" --> absolute
- * ~/a/b/c.txt --> "~/" --> current user
- * ~ --> "~/" --> current user (slash added)
- * ~user/a/b/c.txt --> "~user/" --> named user
- * ~user --> "~user/" --> named user (slash added)
+ * a/b/c.txt --> "" --> relative
+ * /a/b/c.txt --> "/" --> absolute
+ * ~/a/b/c.txt --> "~/" --> current user
+ * ~ --> "~/" --> current user (slash added)
+ * ~user/a/b/c.txt --> "~user/" --> named user
+ * ~user --> "~user/" --> named user (slash added)
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -774,11 +774,11 @@ public class FilenameUtils {
* The method is entirely text based, and returns the text before and
* including the last forward or backslash.
* <pre>
- * C:\a\b\c.txt --> a\b\
- * ~/a/b/c.txt --> a/b/
- * a.txt --> ""
- * a/b/c --> a/b/
- * a/b/c/ --> a/b/c/
+ * C:\a\b\c.txt --> a\b\
+ * ~/a/b/c.txt --> a/b/
+ * a.txt --> ""
+ * a/b/c --> a/b/
+ * a/b/c/ --> a/b/c/
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -801,11 +801,11 @@ public class FilenameUtils {
* The method is entirely text based, and returns the text before the
* last forward or backslash.
* <pre>
- * C:\a\b\c.txt --> a\b
- * ~/a/b/c.txt --> a/b
- * a.txt --> ""
- * a/b/c --> a/b
- * a/b/c/ --> a/b/c
+ * C:\a\b\c.txt --> a\b
+ * ~/a/b/c.txt --> a/b
+ * a.txt --> ""
+ * a/b/c --> a/b
+ * a/b/c/ --> a/b/c
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -850,17 +850,17 @@ public class FilenameUtils {
* The method is entirely text based, and returns the text before and
* including the last forward or backslash.
* <pre>
- * C:\a\b\c.txt --> C:\a\b\
- * ~/a/b/c.txt --> ~/a/b/
- * a.txt --> ""
- * a/b/c --> a/b/
- * a/b/c/ --> a/b/c/
- * C: --> C:
- * C:\ --> C:\
- * ~ --> ~/
- * ~/ --> ~/
- * ~user --> ~user/
- * ~user/ --> ~user/
+ * C:\a\b\c.txt --> C:\a\b\
+ * ~/a/b/c.txt --> ~/a/b/
+ * a.txt --> ""
+ * a/b/c --> a/b/
+ * a/b/c/ --> a/b/c/
+ * C: --> C:
+ * C:\ --> C:\
+ * ~ --> ~/
+ * ~/ --> ~/
+ * ~user --> ~user/
+ * ~user/ --> ~user/
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -880,17 +880,17 @@ public class FilenameUtils {
* The method is entirely text based, and returns the text before the
* last forward or backslash.
* <pre>
- * C:\a\b\c.txt --> C:\a\b
- * ~/a/b/c.txt --> ~/a/b
- * a.txt --> ""
- * a/b/c --> a/b
- * a/b/c/ --> a/b/c
- * C: --> C:
- * C:\ --> C:\
- * ~ --> ~
- * ~/ --> ~
- * ~user --> ~user
- * ~user/ --> ~user
+ * C:\a\b\c.txt --> C:\a\b
+ * ~/a/b/c.txt --> ~/a/b
+ * a.txt --> ""
+ * a/b/c --> a/b
+ * a/b/c/ --> a/b/c
+ * C: --> C:
+ * C:\ --> C:\
+ * ~ --> ~
+ * ~/ --> ~
+ * ~user --> ~user
+ * ~user/ --> ~user
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -941,10 +941,10 @@ public class FilenameUtils {
* This method will handle a file in either Unix or Windows format.
* The text after the last forward or backslash is returned.
* <pre>
- * a/b/c.txt --> c.txt
- * a.txt --> a.txt
- * a/b/c --> c
- * a/b/c/ --> ""
+ * a/b/c.txt --> c.txt
+ * a.txt --> a.txt
+ * a/b/c --> c
+ * a/b/c/ --> ""
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -966,10 +966,10 @@ public class FilenameUtils {
* This method will handle a file in either Unix or Windows format.
* The text after the last forward or backslash and before the last dot is returned.
* <pre>
- * a/b/c.txt --> c
- * a.txt --> a
- * a/b/c --> c
- * a/b/c/ --> ""
+ * a/b/c.txt --> c
+ * a.txt --> a
+ * a/b/c --> c
+ * a/b/c/ --> ""
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -987,10 +987,10 @@ public class FilenameUtils {
* This method returns the textual part of the filename after the last dot.
* There must be no directory separator after the dot.
* <pre>
- * foo.txt --> "txt"
- * a/b/c.jpg --> "jpg"
- * a/b.txt/c --> ""
- * a/b/c --> ""
+ * foo.txt --> "txt"
+ * a/b/c.jpg --> "jpg"
+ * a/b.txt/c --> ""
+ * a/b/c --> ""
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -1018,10 +1018,10 @@ public class FilenameUtils {
* This method returns the textual part of the filename before the last dot.
* There must be no directory separator after the dot.
* <pre>
- * foo.txt --> foo
- * a\b\c.jpg --> a\b\c
- * a\b\c --> a\b\c
- * a.b\c --> a.b\c
+ * foo.txt --> foo
+ * a\b\c.jpg --> a\b\c
+ * a\b\c --> a\b\c
+ * a.b\c --> a.b\c
* </pre>
* <p>
* The output will be the same irrespective of the machine that the code is running on.
@@ -1224,11 +1224,11 @@ public class FilenameUtils {
* This is the same as often found on Dos/Unix command lines.
* The check is case-sensitive always.
* <pre>
- * wildcardMatch("c.txt", "*.txt") --> true
- * wildcardMatch("c.txt", "*.jpg") --> false
- * wildcardMatch("a/b/c.txt", "a/b/*") --> true
- * wildcardMatch("c.txt", "*.???") --> true
- * wildcardMatch("c.txt", "*.????") --> false
+ * wildcardMatch("c.txt", "*.txt") --> true
+ * wildcardMatch("c.txt", "*.jpg") --> false
+ * wildcardMatch("a/b/c.txt", "a/b/*") --> true
+ * wildcardMatch("c.txt", "*.???") --> true
+ * wildcardMatch("c.txt", "*.????") --> false
* </pre>
* N.B. the sequence "*?" does not work properly at present in match strings.
*
@@ -1250,11 +1250,11 @@ public class FilenameUtils {
* This is the same as often found on Dos/Unix command lines.
* The check is case-sensitive on Unix and case-insensitive on Windows.
* <pre>
- * wildcardMatch("c.txt", "*.txt") --> true
- * wildcardMatch("c.txt", "*.jpg") --> false
- * wildcardMatch("a/b/c.txt", "a/b/*") --> true
- * wildcardMatch("c.txt", "*.???") --> true
- * wildcardMatch("c.txt", "*.????") --> false
+ * wildcardMatch("c.txt", "*.txt") --> true
+ * wildcardMatch("c.txt", "*.jpg") --> false
+ * wildcardMatch("a/b/c.txt", "a/b/*") --> true
+ * wildcardMatch("c.txt", "*.???") --> true
+ * wildcardMatch("c.txt", "*.????") --> false
* </pre>
* N.B. the sequence "*?" does not work properly at present in match strings.
*
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java Fri Jan 31 19:45:30 2014
@@ -2777,7 +2777,7 @@ public class IOUtils {
* @param input where to read input from
* @param buffer destination
* @param offset initial offset into buffer
- * @param length length to read, must be >= 0
+ * @param length length to read, must be >= 0
* @return actual length read; may be less than requested if EOF was reached
* @throws IOException if a read error occurs
* @since 2.2
@@ -2823,7 +2823,7 @@ public class IOUtils {
* @param input where to read input from
* @param buffer destination
* @param offset initial offset into buffer
- * @param length length to read, must be >= 0
+ * @param length length to read, must be >= 0
* @return actual length read; may be less than requested if EOF was reached
* @throws IOException if a read error occurs
* @since 2.2
@@ -2893,7 +2893,7 @@ public class IOUtils {
* @param input where to read input from
* @param buffer destination
* @param offset initial offset into buffer
- * @param length length to read, must be >= 0
+ * @param length length to read, must be >= 0
*
* @throws IOException if there is a problem reading the file
* @throws IllegalArgumentException if length is negative
@@ -2934,7 +2934,7 @@ public class IOUtils {
* @param input where to read input from
* @param buffer destination
* @param offset initial offset into buffer
- * @param length length to read, must be >= 0
+ * @param length length to read, must be >= 0
*
* @throws IOException if there is a problem reading the file
* @throws IllegalArgumentException if length is negative
@@ -2973,7 +2973,7 @@ public class IOUtils {
* not read as many bytes as requested (most likely because of reaching EOF).
*
* @param input where to read input from
- * @param length length to read, must be >= 0
+ * @param length length to read, must be >= 0
*
* @throws IOException if there is a problem reading the file
* @throws IllegalArgumentException if length is negative
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/ThreadMonitor.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/ThreadMonitor.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/ThreadMonitor.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/ThreadMonitor.java Fri Jan 31 19:45:30 2014
@@ -21,9 +21,9 @@ package org.apache.commons.io;
* <p>
* This works by sleeping until the specified timeout amount and then
* interrupting the thread being monitored. If the thread being monitored
- * completes its work before being interrupted, it should <code>interrupt()<code>
+ * completes its work before being interrupted, it should <code>interrupt()</code>
* the <i>monitor</i> thread.
- * <p>
+ * </p>
*
* <pre>
* long timeoutInMillis = 1000;
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java Fri Jan 31 19:45:30 2014
@@ -33,7 +33,7 @@ import org.apache.commons.io.IOUtils;
* <code>0xCAFEBABE</code>.
* </p>
*
- * <code><pre>
+ * <pre>
* File dir = new File(".");
* MagicNumberFileFilter javaClassFileFilter =
* MagicNumberFileFilter(new byte[] {(byte) 0xCA, (byte) 0xFE,
@@ -42,7 +42,7 @@ import org.apache.commons.io.IOUtils;
* for (String javaClassFile : javaClassFiles) {
* System.out.println(javaClassFile);
* }
- * </pre></code>
+ * </pre>
*
* <p>
* Sometimes, such as in the case of TAR files, the
@@ -50,7 +50,7 @@ import org.apache.commons.io.IOUtils;
* case of TAR archive files, this offset is 257 bytes.
* </p>
*
- * <code><pre>
+ * <pre>
* File dir = new File(".");
* MagicNumberFileFilter tarFileFilter =
* MagicNumberFileFilter("ustar", 257);
@@ -58,7 +58,8 @@ import org.apache.commons.io.IOUtils;
* for (String tarFile : tarFiles) {
* System.out.println(tarFile);
* }
- * </pre></code>
+ * </pre>
+ *
* @since 2.0
* @see FileFilterUtils#magicNumberFileFilter(byte[])
* @see FileFilterUtils#magicNumberFileFilter(String)
@@ -98,11 +99,11 @@ public class MagicNumberFileFilter exten
* behavior of this file filter.
* </p>
*
- * <code><pre>
+ * <pre>
* MagicNumberFileFilter javaClassFileFilter =
* MagicNumberFileFilter(new byte[] {(byte) 0xCA, (byte) 0xFE,
* (byte) 0xBA, (byte) 0xBE});
- * </pre></code>
+ * </pre>
*
* @param magicNumber the magic number to look for in the file.
*
@@ -145,10 +146,10 @@ public class MagicNumberFileFilter exten
* to look for that magic number.
* </p>
*
- * <code><pre>
+ * <pre>
* MagicNumberFileFilter tarFileFilter =
* MagicNumberFileFilter("ustar", 257);
- * </pre></code>
+ * </pre>
*
* @param magicNumber the magic number to look for in the file.
* The string is converted to bytes using the platform default charset.
@@ -180,15 +181,15 @@ public class MagicNumberFileFilter exten
* to look for that magic number.
* </p>
*
- * <code><pre>
+ * <pre>
* MagicNumberFileFilter tarFileFilter =
* MagicNumberFileFilter(new byte[] {0x75, 0x73, 0x74, 0x61, 0x72}, 257);
- * </pre></code>
+ * </pre>
*
- * <code><pre>
+ * <pre>
* MagicNumberFileFilter javaClassFileFilter =
* MagicNumberFileFilter(new byte[] {0xCA, 0xFE, 0xBA, 0xBE}, 0);
- * </pre></code>
+ * </pre>
*
* @param magicNumber the magic number to look for in the file.
* @param offset the byte offset in the file to start comparing bytes.
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/RegexFileFilter.java Fri Jan 31 19:45:30 2014
@@ -24,17 +24,17 @@ import org.apache.commons.io.IOCase;
/**
* Filters files using supplied regular expression(s).
- * <p/>
+ * <p>
* See java.util.regex.Pattern for regex matching rules
- * <p/>
+ * </p>
*
- * <p/>
+ * <p>
* e.g.
* <pre>
* File dir = new File(".");
* FileFilter fileFilter = new RegexFileFilter("^.*[tT]est(-\\d+)?\\.java$");
* File[] files = dir.listFiles(fileFilter);
- * for (int i = 0; i < files.length; i++) {
+ * for (int i = 0; i < files.length; i++) {
* System.out.println(files[i]);
* }
* </pre>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java Fri Jan 31 19:45:30 2014
@@ -40,7 +40,7 @@ import org.apache.commons.io.IOCase;
* File dir = new File(".");
* FileFilter fileFilter = new WildcardFileFilter("*test*.java~*~");
* File[] files = dir.listFiles(fileFilter);
- * for (int i = 0; i < files.length; i++) {
+ * for (int i = 0; i < files.length; i++) {
* System.out.println(files[i]);
* }
* </pre>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/filefilter/WildcardFilter.java Fri Jan 31 19:45:30 2014
@@ -39,7 +39,7 @@ import org.apache.commons.io.FilenameUti
* File dir = new File(".");
* FileFilter fileFilter = new WildcardFilter("*test*.java~*~");
* File[] files = dir.listFiles(fileFilter);
- * for (int i = 0; i < files.length; i++) {
+ * for (int i = 0; i < files.length; i++) {
* System.out.println(files[i]);
* }
* </pre>
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullInputStream.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullInputStream.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullInputStream.java Fri Jan 31 19:45:30 2014
@@ -50,7 +50,7 @@ import java.io.InputStream;
* return ... // return required value here
* }
* protected void processBytes(byte[] bytes, int offset, int length) {
- * for (int i = offset; i < length; i++) {
+ * for (int i = offset; i < length; i++) {
* bytes[i] = ... // set array value here
* }
* }
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullReader.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullReader.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullReader.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/NullReader.java Fri Jan 31 19:45:30 2014
@@ -50,7 +50,7 @@ import java.io.Reader;
* return ... // return required value here
* }
* protected void processChars(char[] chars, int offset, int length) {
- * for (int i = offset; i < length; i++) {
+ * for (int i = offset; i < length; i++) {
* chars[i] = ... // set array value here
* }
* }
Modified: commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/Tailer.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/Tailer.java?rev=1563227&r1=1563226&r2=1563227&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/Tailer.java (original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/Tailer.java Fri Jan 31 19:45:30 2014
@@ -29,7 +29,7 @@ import org.apache.commons.io.IOUtils;
/**
* Simple implementation of the unix "tail -f" functionality.
* <p>
- * <h2>1. Create a TailerListener implementation</h3>
+ * <h2>1. Create a TailerListener implementation</h2>
* <p>
* First you need to create a {@link TailerListener} implementation
* ({@link TailerListenerAdapter} is provided for convenience so that you don't have to
@@ -92,13 +92,13 @@ import org.apache.commons.io.IOUtils;
* thread.setDaemon(true); // optional
* thread.start();</pre>
*
- * <h2>3. Stopping a Tailer</h3>
+ * <h2>3. Stopping a Tailer</h2>
* <p>Remember to stop the tailer when you have done with it:</p>
* <pre>
* tailer.stop();
* </pre>
*
- * <h2>4. Interrupting a Tailer</h3>
+ * <h2>4. Interrupting a Tailer</h2>
* <p>You can interrupt the thread a tailer is running on by calling {@link Thread#interrupt()}.</p>
* <pre>
* thread.interrupt();