commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brit...@apache.org
Subject [05/19] commons-io git commit: fix javadoc errors reported by java 9
Date Sat, 14 Oct 2017 12:14:39 GMT
fix javadoc errors reported by java 9


Project: http://git-wip-us.apache.org/repos/asf/commons-io/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-io/commit/c898e483
Tree: http://git-wip-us.apache.org/repos/asf/commons-io/tree/c898e483
Diff: http://git-wip-us.apache.org/repos/asf/commons-io/diff/c898e483

Branch: refs/heads/release
Commit: c898e483939740e706157b63b32cbe6f08a931a5
Parents: 5e223a4
Author: pascalschumacher <pascalschumacher@gmx.net>
Authored: Sun Oct 1 15:38:00 2017 +0200
Committer: pascalschumacher <pascalschumacher@gmx.net>
Committed: Sun Oct 1 15:38:00 2017 +0200

----------------------------------------------------------------------
 .../apache/commons/io/comparator/package.html   | 260 +++++++++----------
 .../apache/commons/io/filefilter/package.html   |   8 +-
 .../commons/io/input/ReaderInputStream.java     |   2 +-
 3 files changed, 131 insertions(+), 139 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-io/blob/c898e483/src/main/java/org/apache/commons/io/comparator/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/io/comparator/package.html b/src/main/java/org/apache/commons/io/comparator/package.html
index d007158..fa66bb0 100644
--- a/src/main/java/org/apache/commons/io/comparator/package.html
+++ b/src/main/java/org/apache/commons/io/comparator/package.html
@@ -35,11 +35,9 @@ for {@link java.io.File}s.
 <p>
   ...alternatively you can do this in one line:
 </p>
-<p>
-  <pre>
-        File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
-  </pre>
-</p>
+<pre>
+      File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
+</pre>
 
 <h3>Composite Comparator</h3>
 <p>
@@ -50,139 +48,137 @@ for {@link java.io.File}s.
   For example, to sort an array of files by type (i.e. directory or file)
   and then by name:
 </p>
-<p>
-  <pre>
-        CompositeFileComparator comparator =
-                        new CompositeFileComparator(
-                                    DirectoryFileComparator.DIRECTORY_COMPARATOR,
-                                    NameFileComparator.NAME_COMPARATOR);
-        File[] files = dir.listFiles();
-        comparator.sort(files);
-  </pre>
-</p>
+<pre>
+      CompositeFileComparator comparator =
+                      new CompositeFileComparator(
+                                  DirectoryFileComparator.DIRECTORY_COMPARATOR,
+                                  NameFileComparator.NAME_COMPARATOR);
+      File[] files = dir.listFiles();
+      comparator.sort(files);
+</pre>
 
 <h3>Singleton Instances (thread-safe)</h3>
 <p>
  The {@link java.util.Comparator} implementations have some <i>convenience</i>
  singleton(<i>thread-safe</i>) instances ready to use:
- <ul>
-    <li><a href="DefaultFileComparator.html">DefaultFileComparator</a>
- default file compare:
-        <ul>
-           <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
-               - Compare using <code>File.compareTo(File)</code> method.
-           </li>
-           <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
-               - Reverse compare of <code>File.compareTo(File)</code> method.
-           </li>
-        </ul>
-    </li>
-    <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a>
- compare by type (directory or file):
-        <ul>
-           <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
-               - Compare using <code>File.isDirectory()</code> method (directories
< files).
-           </li>
-           <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
-               - Reverse compare of <code>File.isDirectory()</code> method  (directories
> files).
-           </li>
-        </ul>
-    </li>
-    <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a>
- compare file extenstions:
-        <ul>
-           <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
-               - Compare using <code>FilenameUtils.getExtension(String)</code>
method.
-           </li>
-           <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
-               - Reverse compare of <code>FilenameUtils.getExtension(String)</code>
method.
-           </li>
-           <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
-               - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code>
method.
-           </li>
-           <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
-               - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code>
method.
-           </li>
-           <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
-               -  System sensitive compare using <code>FilenameUtils.getExtension(String)</code>
method.
-           </li>
-           <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
-               - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code>
method.
-           </li>
-        </ul>
-    </li>
-    <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
-        - compare the file's last modified date/time:
-        <ul>
-           <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
-               - Compare using <code>File.lastModified()</code> method.
-           </li>
-           <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
-               - Reverse compare of <code>File.lastModified()</code> method.
-           </li>
-        </ul>
-    </li>
-     <li><a href="NameFileComparator.html">NameFileComparator</a> - compare
file names:
-        <ul>
-           <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
-               - Compare using <code>File.getName()</code> method.
-           </li>
-           <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
-               - Reverse compare of <code>File.getName()</code> method.
-           </li>
-           <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
-               - Case-insensitive compare using <code>File.getName()</code> method.
-           </li>
-           <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
-               - Reverse case-insensitive compare of <code>File.getName()</code>
method.
-           </li>
-           <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
-               -  System sensitive compare using <code>File.getName()</code>
method.
-           </li>
-           <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
-               - Reverse system sensitive compare of <code>File.getName()</code>
method.
-           </li>
-        </ul>
-    </li>
-     <li><a href="PathFileComparator.html">PathFileComparator</a> - compare
file paths:
-        <ul>
-           <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
-               - Compare using <code>File.getPath()</code> method.
-           </li>
-           <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
-               - Reverse compare of <code>File.getPath()</code> method.
-           </li>
-           <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
-               - Case-insensitive compare using <code>File.getPath()</code> method.
-           </li>
-           <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
-               - Reverse case-insensitive compare of <code>File.getPath()</code>
method.
-           </li>
-           <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
-               -  System sensitive compare using <code>File.getPath()</code>
method.
-           </li>
-           <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
-               - Reverse system sensitive compare of <code>File.getPath()</code>
method.
-           </li>
-        </ul>
-    </li>
-    <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare
the file's size:
-        <ul>
-           <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
-               - Compare using <code>File.length()</code> method (directories
treated as zero length).
-           </li>
-           <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
-               - Reverse compare of <code>File.length()</code> method (directories
treated as zero length).
-           </li>
-           <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
-               - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
-                (sums the size of a directory's contents).
-           </li>
-           <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
-               - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code>
method
-                (sums the size of a directory's contents).
-           </li>
-        </ul>
-    </li>
- </ul>
 </p>
+<ul>
+   <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> -
default file compare:
+       <ul>
+          <li><a href="DefaultFileComparator.html#DEFAULT_COMPARATOR">DEFAULT_COMPARATOR</a>
+              - Compare using <code>File.compareTo(File)</code> method.
+          </li>
+          <li><a href="DefaultFileComparator.html#DEFAULT_REVERSE">DEFAULT_REVERSE</a>
+              - Reverse compare of <code>File.compareTo(File)</code> method.
+          </li>
+       </ul>
+   </li>
+   <li><a href="DirectoryFileComparator.html">DirectoryFileComparator</a>
- compare by type (directory or file):
+       <ul>
+          <li><a href="DirectoryFileComparator.html#DIRECTORY_COMPARATOR">DIRECTORY_COMPARATOR</a>
+              - Compare using <code>File.isDirectory()</code> method (directories
&lt; files).
+          </li>
+          <li><a href="DirectoryFileComparator.html#DIRECTORY_REVERSE">DIRECTORY_REVERSE</a>
+              - Reverse compare of <code>File.isDirectory()</code> method  (directories
&gt;files).
+          </li>
+       </ul>
+   </li>
+   <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a>
- compare file extenstions:
+       <ul>
+          <li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
+              - Compare using <code>FilenameUtils.getExtension(String)</code>
method.
+          </li>
+          <li><a href="ExtensionFileComparator.html#EXTENSION_REVERSE">EXTENSION_REVERSE</a>
+              - Reverse compare of <code>FilenameUtils.getExtension(String)</code>
method.
+          </li>
+          <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_COMPARATOR">EXTENSION_INSENSITIVE_COMPARATOR</a>
+              - Case-insensitive compare using <code>FilenameUtils.getExtension(String)</code>
method.
+          </li>
+          <li><a href="ExtensionFileComparator.html#EXTENSION_INSENSITIVE_REVERSE">EXTENSION_INSENSITIVE_REVERSE</a>
+              - Reverse case-insensitive compare of <code>FilenameUtils.getExtension(String)</code>
method.
+          </li>
+          <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_COMPARATOR">EXTENSION_SYSTEM_COMPARATOR</a>
+              -  System sensitive compare using <code>FilenameUtils.getExtension(String)</code>
method.
+          </li>
+          <li><a href="ExtensionFileComparator.html#EXTENSION_SYSTEM_REVERSE">EXTENSION_SYSTEM_REVERSE</a>
+              - Reverse system sensitive compare of <code>FilenameUtils.getExtension(String)</code>
method.
+          </li>
+       </ul>
+   </li>
+   <li><a href="LastModifiedFileComparator.html">LastModifiedFileComparator</a>
+       - compare the file's last modified date/time:
+       <ul>
+          <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_COMPARATOR">LASTMODIFIED_COMPARATOR</a>
+              - Compare using <code>File.lastModified()</code> method.
+          </li>
+          <li><a href="LastModifiedFileComparator.html#LASTMODIFIED_REVERSE">LASTMODIFIED_REVERSE</a>
+              - Reverse compare of <code>File.lastModified()</code> method.
+          </li>
+       </ul>
+   </li>
+    <li><a href="NameFileComparator.html">NameFileComparator</a> - compare
file names:
+       <ul>
+          <li><a href="NameFileComparator.html#NAME_COMPARATOR">NAME_COMPARATOR</a>
+              - Compare using <code>File.getName()</code> method.
+          </li>
+          <li><a href="NameFileComparator.html#NAME_REVERSE">NAME_REVERSE</a>
+              - Reverse compare of <code>File.getName()</code> method.
+          </li>
+          <li><a href="NameFileComparator.html#NAME_INSENSITIVE_COMPARATOR">NAME_INSENSITIVE_COMPARATOR</a>
+              - Case-insensitive compare using <code>File.getName()</code> method.
+          </li>
+          <li><a href="NameFileComparator.html#NAME_INSENSITIVE_REVERSE">NAME_INSENSITIVE_REVERSE</a>
+              - Reverse case-insensitive compare of <code>File.getName()</code>
method.
+          </li>
+          <li><a href="NameFileComparator.html#NAME_SYSTEM_COMPARATOR">NAME_SYSTEM_COMPARATOR</a>
+              -  System sensitive compare using <code>File.getName()</code> method.
+          </li>
+          <li><a href="NameFileComparator.html#NAME_SYSTEM_REVERSE">NAME_SYSTEM_REVERSE</a>
+              - Reverse system sensitive compare of <code>File.getName()</code>
method.
+          </li>
+       </ul>
+   </li>
+    <li><a href="PathFileComparator.html">PathFileComparator</a> - compare
file paths:
+       <ul>
+          <li><a href="PathFileComparator.html#PATH_COMPARATOR">PATH_COMPARATOR</a>
+              - Compare using <code>File.getPath()</code> method.
+          </li>
+          <li><a href="PathFileComparator.html#PATH_REVERSE">PATH_REVERSE</a>
+              - Reverse compare of <code>File.getPath()</code> method.
+          </li>
+          <li><a href="PathFileComparator.html#PATH_INSENSITIVE_COMPARATOR">PATH_INSENSITIVE_COMPARATOR</a>
+              - Case-insensitive compare using <code>File.getPath()</code> method.
+          </li>
+          <li><a href="PathFileComparator.html#PATH_INSENSITIVE_REVERSE">PATH_INSENSITIVE_REVERSE</a>
+              - Reverse case-insensitive compare of <code>File.getPath()</code>
method.
+          </li>
+          <li><a href="PathFileComparator.html#PATH_SYSTEM_COMPARATOR">PATH_SYSTEM_COMPARATOR</a>
+              -  System sensitive compare using <code>File.getPath()</code> method.
+          </li>
+          <li><a href="PathFileComparator.html#PATH_SYSTEM_REVERSE">PATH_SYSTEM_REVERSE</a>
+              - Reverse system sensitive compare of <code>File.getPath()</code>
method.
+          </li>
+       </ul>
+   </li>
+   <li><a href="SizeFileComparator.html">SizeFileComparator</a> - compare
the file's size:
+       <ul>
+          <li><a href="SizeFileComparator.html#SIZE_COMPARATOR">SIZE_COMPARATOR</a>
+              - Compare using <code>File.length()</code> method (directories
treated as zero length).
+          </li>
+          <li><a href="SizeFileComparator.html#SIZE_REVERSE">LASTMODIFIED_REVERSE</a>
+              - Reverse compare of <code>File.length()</code> method (directories
treated as zero length).
+          </li>
+          <li><a href="SizeFileComparator.html#SIZE_SUMDIR_COMPARATOR">SIZE_SUMDIR_COMPARATOR</a>
+              - Compare using <code>FileUtils.sizeOfDirectory(File)</code> method
+               (sums the size of a directory's contents).
+          </li>
+          <li><a href="SizeFileComparator.html#SIZE_SUMDIR_REVERSE">SIZE_SUMDIR_REVERSE</a>
+              - Reverse compare of <code>FileUtils.sizeOfDirectory(File)</code>
method
+               (sums the size of a directory's contents).
+          </li>
+       </ul>
+   </li>
+</ul>
 
 </body>
 </html>

http://git-wip-us.apache.org/repos/asf/commons-io/blob/c898e483/src/main/java/org/apache/commons/io/filefilter/package.html
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/io/filefilter/package.html b/src/main/java/org/apache/commons/io/filefilter/package.html
index e495e95..e32a192 100644
--- a/src/main/java/org/apache/commons/io/filefilter/package.html
+++ b/src/main/java/org/apache/commons/io/filefilter/package.html
@@ -24,10 +24,8 @@ IOFileFilter interface including implementation that allow you to combine
 other such filters.</p>
 <p>These filter can be used to list files or in {@link java.awt.FileDialog}, 
 for example.</p>
-     
-<p>There are a number of 'primitive' filters:</p>
-     
 <table>
+    <caption>There are a number of 'primitive' filters:</caption>
        <tbody>
     <tr>
       <td><a href="DirectoryFileFilter.html">DirectoryFilter</a></td>
@@ -59,10 +57,8 @@ for example.</p>
     </tr>
   </tbody>
 </table>
-     
-<p>And there are five 'boolean' filters:</p>
-     
 <table>
+    <caption>And there are five 'boolean' filters:</caption>
        <tbody>
        <tr>
       <td><a href="TrueFileFilter.html">TrueFileFilter</a></td>

http://git-wip-us.apache.org/repos/asf/commons-io/blob/c898e483/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
index b8e151f..41ed2d4 100644
--- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -62,7 +62,7 @@ import java.nio.charset.CodingErrorAction;
  * in the design of the code. This class is typically used in situations where an existing
  * API only accepts an {@link InputStream}, but where the most natural way to produce the
data
  * is as a character stream, i.e. by providing a {@link Reader} instance. An example of a
situation
- * where this problem may appear is when implementing the {@link javax.activation.DataSource}
+ * where this problem may appear is when implementing the {@code javax.activation.DataSource}
  * interface from the Java Activation Framework.
  * <p>
  * Given the fact that the {@link Reader} class doesn't provide any way to predict whether
the next


Mime
View raw message