Javadoc

Use HTML 'em' tag instead of 'i' tag

src/main/java/org/apache/commons/io/DirectoryWalker.java

@@ -157,7 +157,7 @@
  * What {@link DirectoryWalker} does provide for cancellation is:
  * </p>
  * <ul>
- * <li>{@link CancelException} which can be thrown in any of the <i>lifecycle</i> methods to stop processing.</li>
+ * <li>{@link CancelException} which can be thrown in any of the <em>lifecycle</em> methods to stop processing.</li>
  * <li>The {@code walk()} method traps thrown {@link CancelException} and calls the {@code handleCancelled()}
  * method, providing a place for custom cancel processing.</li>
  * </ul>
@@ -216,7 +216,7 @@
  *
  * <p>
  * This shows an example of how internal cancellation processing could be implemented. <b>Note</b> the decision logic
- * and throwing a {@link CancelException} could be implemented in any of the <i>lifecycle</i> methods.
+ * and throwing a {@link CancelException} could be implemented in any of the <em>lifecycle</em> methods.
  * </p>
  *
  * <pre>
@@ -323,14 +323,14 @@ public File getFile() {
     private final int depthLimit;
 
     /**
-     * Constructs an instance with no filtering and unlimited <i>depth</i>.
+     * Constructs an instance with no filtering and unlimited <em>depth</em>.
      */
     protected DirectoryWalker() {
         this(null, -1);
     }
 
     /**
-     * Constructs an instance with a filter and limit the <i>depth</i> navigated to.
+     * Constructs an instance with a filter and limit the <em>depth</em> navigated to.
      * <p>
      * The filter controls which files and directories will be navigated to as
      * part of the walk. The {@link FileFilterUtils} class is useful for combining
@@ -339,7 +339,7 @@ protected DirectoryWalker() {
      * </p>
      *
      * @param filter  the filter to apply, null means visit all files
-     * @param depthLimit  controls how <i>deep</i> the hierarchy is
+     * @param depthLimit  controls how <em>deep</em> the hierarchy is
      *  navigated to (less than 0 means unlimited)
      */
     protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
@@ -349,7 +349,7 @@ protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
 
     /**
      * Constructs an instance with a directory and a file filter and an optional
-     * limit on the <i>depth</i> navigated to.
+     * limit on the <em>depth</em> navigated to.
      * <p>
      * The filters control which files and directories will be navigated to as part
      * of the walk. This constructor uses {@link FileFilterUtils#makeDirectoryOnly(IOFileFilter)}
@@ -359,7 +359,7 @@ protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
      *
      * @param directoryFilter  the filter to apply to directories, null means visit all directories
      * @param fileFilter  the filter to apply to files, null means visit all files
-     * @param depthLimit  controls how <i>deep</i> the hierarchy is
+     * @param depthLimit  controls how <em>deep</em> the hierarchy is
      *  navigated to (less than 0 means unlimited)
      */
     protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter, final int depthLimit) {

src/main/java/org/apache/commons/io/FileSystem.java

@@ -204,15 +204,15 @@ private static String getSystemProperty(final String property) {
      * object at an index no smaller than {@code start}, then
      * the index of the first such occurrence is returned. For values
      * of {@code searchChar} in the range from 0 to 0xFFFF (inclusive),
-     * this is the smallest value <i>k</i> such that:
+     * this is the smallest value <em>k</em> such that:
      * </p>
      * <blockquote><pre>
-     * (this.charAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &gt;= start)
+     * (this.charAt(<em>k</em>) == searchChar) &amp;&amp; (<em>k</em> &gt;= start)
      * </pre></blockquote>
      * is true. For other values of {@code searchChar}, it is the
-     * smallest value <i>k</i> such that:
+     * smallest value <em>k</em> such that:
      * <blockquote><pre>
-     * (this.codePointAt(<i>k</i>) == searchChar) &amp;&amp; (<i>k</i> &gt;= start)
+     * (this.codePointAt(<em>k</em>) == searchChar) &amp;&amp; (<em>k</em> &gt;= start)
      * </pre></blockquote>
      * <p>
      * is true. In either case, if no such character occurs in {@code cs}

src/main/java/org/apache/commons/io/FileUtils.java

@@ -1567,7 +1567,7 @@ public static boolean isDirectory(final File file, final LinkOption... options)
      * @return whether the directory is empty.
      * @throws IOException if an I/O error occurs.
      * @throws NotDirectoryException if the file could not otherwise be opened because it is not a directory
-     *                               <i>(optional specific exception)</i>.
+     *                               <em>(optional specific exception)</em>.
      * @since 2.9.0
      */
     public static boolean isEmptyDirectory(final File directory) throws IOException {

src/main/java/org/apache/commons/io/ThreadMonitor.java

@@ -22,7 +22,7 @@
  * Monitors a thread, interrupting it if it reaches the specified timeout.
  * <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()} the <i>monitor</i>
+ * thread being monitored completes its work before being interrupted, it should {@code interrupt()} the <em>monitor</em>
  * thread.
  * </p>
  *

src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java

@@ -35,7 +35,7 @@
  *       ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of doing a <i>reverse</i> sort of an array of files using the
+ * Example of doing a <em>reverse</em> sort of an array of files using the
  * {@link #DEFAULT_REVERSE} singleton instance:
  * </p>
  * <pre>

src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java

@@ -34,7 +34,7 @@
  *       ((AbstractFileComparator) DirectoryFileComparator.DIRECTORY_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of doing a <i>reverse</i> sort of an array of files/directories using the {@link #DIRECTORY_REVERSE}
+ * Example of doing a <em>reverse</em> sort of an array of files/directories using the {@link #DIRECTORY_REVERSE}
  * singleton instance:
  * </p>
  *

src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java

@@ -34,15 +34,15 @@
  * and the reverse of those options.
  * </p>
  * <p>
- * Example of a <i>case-sensitive</i> file extension sort using the
+ * Example of a <em>case-sensitive</em> file extension sort using the
  * {@link #EXTENSION_COMPARATOR} singleton instance:
  * </p>
  * <pre>
  *       List&lt;File&gt; list = ...
  *       ((AbstractFileComparator) ExtensionFileComparator.EXTENSION_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of a <i>reverse case-insensitive</i> file extension sort using the
+ * Example of a <em>reverse case-insensitive</em> file extension sort using the
  * {@link #EXTENSION_INSENSITIVE_REVERSE} singleton instance:
  * </p>
  * <pre>

src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java

@@ -38,7 +38,7 @@
  *       ((AbstractFileComparator) LastModifiedFileComparator.LASTMODIFIED_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of doing a <i>reverse</i> sort of an array of files using the
+ * Example of doing a <em>reverse</em> sort of an array of files using the
  * {@link #LASTMODIFIED_REVERSE} singleton instance:
  * </p>
  * <pre>

src/main/java/org/apache/commons/io/comparator/NameFileComparator.java

@@ -32,15 +32,15 @@
  * and the reverse of those options.
  * </p>
  * <p>
- * Example of a <i>case-sensitive</i> file name sort using the
+ * Example of a <em>case-sensitive</em> file name sort using the
  * {@link #NAME_COMPARATOR} singleton instance:
  * </p>
  * <pre>
  *       List&lt;File&gt; list = ...
  *       ((AbstractFileComparator) NameFileComparator.NAME_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of a <i>reverse case-insensitive</i> file name sort using the
+ * Example of a <em>reverse case-insensitive</em> file name sort using the
  * {@link #NAME_INSENSITIVE_REVERSE} singleton instance:
  * </p>
  * <pre>

src/main/java/org/apache/commons/io/comparator/PathFileComparator.java

@@ -32,15 +32,15 @@
  * and the reverse of those options.
  * </p>
  * <p>
- * Example of a <i>case-sensitive</i> file path sort using the
+ * Example of a <em>case-sensitive</em> file path sort using the
  * {@link #PATH_COMPARATOR} singleton instance:
  * </p>
  * <pre>
  *       List&lt;File&gt; list = ...
  *       ((AbstractFileComparator) PathFileComparator.PATH_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of a <i>reverse case-insensitive</i> file path sort using the
+ * Example of a <em>reverse case-insensitive</em> file path sort using the
  * {@link #PATH_INSENSITIVE_REVERSE} singleton instance:
  * </p>
  * <pre>

src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java

@@ -38,7 +38,7 @@
  *       ((AbstractFileComparator) SizeFileComparator.SIZE_COMPARATOR).sort(list);
  * </pre>
  * <p>
- * Example of doing a <i>reverse</i> sort of an array of files using the
+ * Example of doing a <em>reverse</em> sort of an array of files using the
  * {@link #SIZE_REVERSE} singleton instance:
  * </p>
  * <pre>

src/main/java/org/apache/commons/io/comparator/package-info.java

@@ -20,7 +20,7 @@
  * for {@link java.io.File}s and {@link java.nio.file.Path}.
  * <h2>Sorting</h2>
  * <p>
- * All the comparators include <i>convenience</i> utility <code>sort(File...)</code> and
+ * All the comparators include <em>convenience</em> utility <code>sort(File...)</code> and
  * <code>sort(List)</code> methods.
  * </p>
  * <p>
@@ -55,8 +55,8 @@
  * </pre>
  * <h2>Singleton Instances (thread-safe)</h2>
  * <p>
- * The {@link java.util.Comparator} implementations have some <i>convenience</i>
- * singleton(<i>thread-safe</i>) instances ready to use:
+ * The {@link java.util.Comparator} implementations have some <em>convenience</em>
+ * singleton(<em>thread-safe</em>) instances ready to use:
  * </p>
  * <ul>
  * <li><a href="DefaultFileComparator.html">DefaultFileComparator</a> - default file compare:

src/main/java/org/apache/commons/io/file/PathUtils.java

@@ -1066,7 +1066,7 @@ public static boolean isEmpty(final Path path) throws IOException {
      *
      * @param directory the directory to query.
      * @return whether the directory is empty.
-     * @throws NotDirectoryException if the file could not otherwise be opened because it is not a directory <i>(optional specific exception)</i>.
+     * @throws NotDirectoryException if the file could not otherwise be opened because it is not a directory <em>(optional specific exception)</em>.
      * @throws IOException           if an I/O error occurs.
      * @throws SecurityException     In the case of the default provider, and a security manager is installed, the {@link SecurityManager#checkRead(String)
      *                               checkRead} method is invoked to check read access to the directory.

src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java

@@ -27,7 +27,7 @@
  * This filter accepts {@link File}s that can be executed.
  * <p>
  * Example, showing how to print out a list of the
- * current directory's <i>executable</i> files:
+ * current directory's <em>executable</em> files:
  * </p>
  * <h2>Using Classic IO</h2>
  * <pre>
@@ -40,7 +40,7 @@
  *
  * <p>
  * Example, showing how to print out a list of the
- * current directory's <i>non-executable</i> files:
+ * current directory's <em>non-executable</em> files:
  * </p>
  *
  * <pre>
@@ -59,10 +59,10 @@
  */
 public class CanExecuteFileFilter extends AbstractFileFilter implements Serializable {
 
-    /** Singleton instance of <i>executable</i> filter */
+    /** Singleton instance of <em>executable</em> filter */
     public static final IOFileFilter CAN_EXECUTE = new CanExecuteFileFilter();
 
-    /** Singleton instance of not <i>executable</i> filter */
+    /** Singleton instance of not <em>executable</em> filter */
     public static final IOFileFilter CANNOT_EXECUTE = CAN_EXECUTE.negate();
 
     private static final long serialVersionUID = 3179904805251622989L;

src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java

@@ -26,7 +26,7 @@
 /**
  * This filter accepts {@link File}s that can be read.
  * <p>
- * Example, showing how to print out a list of the current directory's <i>readable</i> files:
+ * Example, showing how to print out a list of the current directory's <em>readable</em> files:
  * </p>
  * <h2>Using Classic IO</h2>
  * <pre>
@@ -38,7 +38,7 @@
  * </pre>
  *
  * <p>
- * Example, showing how to print out a list of the current directory's <i>un-readable</i> files:
+ * Example, showing how to print out a list of the current directory's <em>un-readable</em> files:
  *
  * <pre>
  * File dir = FileUtils.current();
@@ -49,7 +49,7 @@
  * </pre>
  *
  * <p>
- * Example, showing how to print out a list of the current directory's <i>read-only</i> files:
+ * Example, showing how to print out a list of the current directory's <em>read-only</em> files:
  *
  * <pre>
  * File dir = FileUtils.current();
@@ -67,13 +67,13 @@
  */
 public class CanReadFileFilter extends AbstractFileFilter implements Serializable {
 
-    /** Singleton instance of <i>readable</i> filter */
+    /** Singleton instance of <em>readable</em> filter */
     public static final IOFileFilter CAN_READ = new CanReadFileFilter();
 
-    /** Singleton instance of not <i>readable</i> filter */
+    /** Singleton instance of not <em>readable</em> filter */
     public static final IOFileFilter CANNOT_READ = CAN_READ.negate();
 
-    /** Singleton instance of <i>read-only</i> filter */
+    /** Singleton instance of <em>read-only</em> filter */
     public static final IOFileFilter READ_ONLY = CAN_READ.and(CanWriteFileFilter.CANNOT_WRITE);
 
     private static final long serialVersionUID = 3179904805251622989L;

src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java

@@ -26,7 +26,7 @@
 /**
  * This filter accepts {@link File}s that can be written to.
  * <p>
- * Example, showing how to print out a list of the current directory's <i>writable</i> files:
+ * Example, showing how to print out a list of the current directory's <em>writable</em> files:
  * </p>
  * <h2>Using Classic IO</h2>
  * <pre>
@@ -37,7 +37,7 @@
  * }
  * </pre>
  * <p>
- * Example, showing how to print out a list of the current directory's <i>un-writable</i> files:
+ * Example, showing how to print out a list of the current directory's <em>un-writable</em> files:
  * </p>
  * <pre>
  * File dir = FileUtils.current();
@@ -58,10 +58,10 @@
  */
 public class CanWriteFileFilter extends AbstractFileFilter implements Serializable {
 
-    /** Singleton instance of <i>writable</i> filter */
+    /** Singleton instance of <em>writable</em> filter */
     public static final IOFileFilter CAN_WRITE = new CanWriteFileFilter();
 
-    /** Singleton instance of not <i>writable</i> filter */
+    /** Singleton instance of not <em>writable</em> filter */
     public static final IOFileFilter CANNOT_WRITE = CAN_WRITE.negate();
 
     private static final long serialVersionUID = 5132005214688990379L;

src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java

@@ -82,10 +82,10 @@
  */
 public class EmptyFileFilter extends AbstractFileFilter implements Serializable {
 
-    /** Singleton instance of <i>empty</i> filter */
+    /** Singleton instance of <em>empty</em> filter */
     public static final IOFileFilter EMPTY = new EmptyFileFilter();
 
-    /** Singleton instance of <i>not-empty</i> filter */
+    /** Singleton instance of <em>not-empty</em> filter */
     public static final IOFileFilter NOT_EMPTY = EMPTY.negate();
 
     private static final long serialVersionUID = 3631422087512832211L;
@@ -100,7 +100,7 @@ protected EmptyFileFilter() {
      * Checks to see if the file is empty.
      *
      * @param file the file or directory to check
-     * @return {@code true} if the file or directory is <i>empty</i>, otherwise {@code false}.
+     * @return {@code true} if the file or directory is <em>empty</em>, otherwise {@code false}.
      */
     @Override
     public boolean accept(final File file) {
@@ -118,7 +118,7 @@ public boolean accept(final File file) {
      * Checks to see if the file is empty.
      * @param file the file or directory to check
      *
-     * @return {@code true} if the file or directory is <i>empty</i>, otherwise {@code false}.
+     * @return {@code true} if the file or directory is <em>empty</em>, otherwise {@code false}.
      * @since 2.9.0
      */
     @Override