This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-io.git
The following commit(s) were added to refs/heads/master by this push: new 88109593c Javadoc 88109593c is described below commit 88109593cc4961ff2dde598e2fd4add8a501d05f Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Sun Jul 21 11:34:37 2024 -0400 Javadoc Use HTML 'em' tag instead of 'i' tag --- src/main/java/org/apache/commons/io/DirectoryWalker.java | 14 +++++++------- src/main/java/org/apache/commons/io/FileSystem.java | 8 ++++---- src/main/java/org/apache/commons/io/FileUtils.java | 2 +- src/main/java/org/apache/commons/io/ThreadMonitor.java | 2 +- .../commons/io/comparator/DefaultFileComparator.java | 2 +- .../commons/io/comparator/DirectoryFileComparator.java | 2 +- .../commons/io/comparator/ExtensionFileComparator.java | 4 ++-- .../commons/io/comparator/LastModifiedFileComparator.java | 2 +- .../apache/commons/io/comparator/NameFileComparator.java | 4 ++-- .../apache/commons/io/comparator/PathFileComparator.java | 4 ++-- .../apache/commons/io/comparator/SizeFileComparator.java | 2 +- .../org/apache/commons/io/comparator/package-info.java | 6 +++--- src/main/java/org/apache/commons/io/file/PathUtils.java | 2 +- .../apache/commons/io/filefilter/CanExecuteFileFilter.java | 8 ++++---- .../apache/commons/io/filefilter/CanReadFileFilter.java | 12 ++++++------ .../apache/commons/io/filefilter/CanWriteFileFilter.java | 8 ++++---- .../org/apache/commons/io/filefilter/EmptyFileFilter.java | 8 ++++---- .../org/apache/commons/io/filefilter/HiddenFileFilter.java | 12 ++++++------ .../java/org/apache/commons/io/input/NullInputStream.java | 4 ++-- src/main/java/org/apache/commons/io/input/NullReader.java | 4 ++-- .../apache/commons/io/monitor/FileAlterationObserver.java | 2 +- .../org/apache/commons/io/output/StringBuilderWriter.java | 2 +- 22 files changed, 57 insertions(+), 57 deletions(-) diff --git a/src/main/java/org/apache/commons/io/DirectoryWalker.java b/src/main/java/org/apache/commons/io/DirectoryWalker.java index 6995ccfd2..e8a4a2e24 100644 --- a/src/main/java/org/apache/commons/io/DirectoryWalker.java +++ b/src/main/java/org/apache/commons/io/DirectoryWalker.java @@ -157,7 +157,7 @@ import org.apache.commons.io.filefilter.TrueFileFilter; * 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 @@ import org.apache.commons.io.filefilter.TrueFileFilter; * * <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 abstract class DirectoryWalker<T> { 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 @@ public abstract class DirectoryWalker<T> { * </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 @@ public abstract class DirectoryWalker<T> { /** * 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 @@ public abstract class DirectoryWalker<T> { * * @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) { diff --git a/src/main/java/org/apache/commons/io/FileSystem.java b/src/main/java/org/apache/commons/io/FileSystem.java index c7dbdfa8a..8f1b2d27e 100644 --- a/src/main/java/org/apache/commons/io/FileSystem.java +++ b/src/main/java/org/apache/commons/io/FileSystem.java @@ -204,15 +204,15 @@ public enum FileSystem { * 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) && (<i>k</i> >= start) + * (this.charAt(<em>k</em>) == searchChar) && (<em>k</em> >= 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) && (<i>k</i> >= start) + * (this.codePointAt(<em>k</em>) == searchChar) && (<em>k</em> >= start) * </pre></blockquote> * <p> * is true. In either case, if no such character occurs in {@code cs} diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java index aac463675..15e277045 100644 --- a/src/main/java/org/apache/commons/io/FileUtils.java +++ b/src/main/java/org/apache/commons/io/FileUtils.java @@ -1567,7 +1567,7 @@ public class FileUtils { * @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 { diff --git a/src/main/java/org/apache/commons/io/ThreadMonitor.java b/src/main/java/org/apache/commons/io/ThreadMonitor.java index 463b4ae69..a1826f5a1 100644 --- a/src/main/java/org/apache/commons/io/ThreadMonitor.java +++ b/src/main/java/org/apache/commons/io/ThreadMonitor.java @@ -22,7 +22,7 @@ import java.time.Duration; * 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> * diff --git a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java index c9d76e6a4..b8d50edfe 100644 --- a/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/DefaultFileComparator.java @@ -35,7 +35,7 @@ import java.util.Comparator; * ((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> diff --git a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java index 35f98bfa9..cedf0b1ea 100644 --- a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java @@ -34,7 +34,7 @@ import java.util.Comparator; * ((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> * diff --git a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java index a48daec6a..be56c8bec 100644 --- a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java @@ -34,7 +34,7 @@ import org.apache.commons.io.IOCase; * 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> @@ -42,7 +42,7 @@ import org.apache.commons.io.IOCase; * ((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> diff --git a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java index 7849f80b3..be7652897 100644 --- a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java @@ -38,7 +38,7 @@ import org.apache.commons.io.FileUtils; * ((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> diff --git a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java index 76f4dbd0e..4e2167bdf 100644 --- a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java @@ -32,7 +32,7 @@ import org.apache.commons.io.IOCase; * 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> @@ -40,7 +40,7 @@ import org.apache.commons.io.IOCase; * ((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> diff --git a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java index 9d6d36828..86432efb8 100644 --- a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java @@ -32,7 +32,7 @@ import org.apache.commons.io.IOCase; * 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> @@ -40,7 +40,7 @@ import org.apache.commons.io.IOCase; * ((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> diff --git a/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java b/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java index b9d086420..804563473 100644 --- a/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java +++ b/src/main/java/org/apache/commons/io/comparator/SizeFileComparator.java @@ -38,7 +38,7 @@ import org.apache.commons.io.FileUtils; * ((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> diff --git a/src/main/java/org/apache/commons/io/comparator/package-info.java b/src/main/java/org/apache/commons/io/comparator/package-info.java index 17f6a9626..1dbdd871a 100644 --- a/src/main/java/org/apache/commons/io/comparator/package-info.java +++ b/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: diff --git a/src/main/java/org/apache/commons/io/file/PathUtils.java b/src/main/java/org/apache/commons/io/file/PathUtils.java index 3758867a5..ce3ceca64 100644 --- a/src/main/java/org/apache/commons/io/file/PathUtils.java +++ b/src/main/java/org/apache/commons/io/file/PathUtils.java @@ -1066,7 +1066,7 @@ public final class PathUtils { * * @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. diff --git a/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java index b128ec0eb..ba686c3cb 100644 --- a/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/CanExecuteFileFilter.java @@ -27,7 +27,7 @@ import java.nio.file.attribute.BasicFileAttributes; * 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 @@ import java.nio.file.attribute.BasicFileAttributes; * * <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 @@ import java.nio.file.attribute.BasicFileAttributes; */ 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; diff --git a/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java index 266ea353e..152662740 100644 --- a/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/CanReadFileFilter.java @@ -26,7 +26,7 @@ import java.nio.file.attribute.BasicFileAttributes; /** * 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 @@ import java.nio.file.attribute.BasicFileAttributes; * </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 @@ import java.nio.file.attribute.BasicFileAttributes; * </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 @@ import java.nio.file.attribute.BasicFileAttributes; */ 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; diff --git a/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java index 24bf6481d..a9ec2dc4e 100644 --- a/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/CanWriteFileFilter.java @@ -26,7 +26,7 @@ import java.nio.file.attribute.BasicFileAttributes; /** * 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 @@ import java.nio.file.attribute.BasicFileAttributes; * } * </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 @@ import java.nio.file.attribute.BasicFileAttributes; */ 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; diff --git a/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java index f5d232815..d536cb3f6 100644 --- a/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/EmptyFileFilter.java @@ -82,10 +82,10 @@ import org.apache.commons.io.IOUtils; */ 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 @@ public class EmptyFileFilter extends AbstractFileFilter implements Serializable * 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 class EmptyFileFilter extends AbstractFileFilter implements Serializable * 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 diff --git a/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java index c340c43c1..c7a312897 100644 --- a/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java +++ b/src/main/java/org/apache/commons/io/filefilter/HiddenFileFilter.java @@ -27,7 +27,7 @@ import java.nio.file.attribute.BasicFileAttributes; * This filter accepts {@link File}s that are hidden. * <p> * Example, showing how to print out a list of the - * current directory's <i>hidden</i> files: + * current directory's <em>hidden</em> files: * </p> * <h2>Using Classic IO</h2> * <pre> @@ -40,7 +40,7 @@ import java.nio.file.attribute.BasicFileAttributes; * * <p> * Example, showing how to print out a list of the - * current directory's <i>visible</i> (i.e. not hidden) files: + * current directory's <em>visible</em> (i.e. not hidden) files: * </p> * * <pre> @@ -78,12 +78,12 @@ import java.nio.file.attribute.BasicFileAttributes; */ public class HiddenFileFilter extends AbstractFileFilter implements Serializable { - /** Singleton instance of <i>hidden</i> filter */ + /** Singleton instance of <em>hidden</em> filter */ public static final IOFileFilter HIDDEN = new HiddenFileFilter(); private static final long serialVersionUID = 8930842316112759062L; - /** Singleton instance of <i>visible</i> filter */ + /** Singleton instance of <em>visible</em> filter */ public static final IOFileFilter VISIBLE = HIDDEN.negate(); /** @@ -97,7 +97,7 @@ public class HiddenFileFilter extends AbstractFileFilter implements Serializable * * @param file the File to check * @return {@code true} if the file is - * <i>hidden</i>, otherwise {@code false}. + * <em>hidden</em>, otherwise {@code false}. */ @Override public boolean accept(final File file) { @@ -109,7 +109,7 @@ public class HiddenFileFilter extends AbstractFileFilter implements Serializable * @param file the File to check * * @return {@code true} if the file is - * <i>hidden</i>, otherwise {@code false}. + * <em>hidden</em>, otherwise {@code false}. * @since 2.9.0 */ @Override diff --git a/src/main/java/org/apache/commons/io/input/NullInputStream.java b/src/main/java/org/apache/commons/io/input/NullInputStream.java index 3bb495e77..a63fcd8bb 100644 --- a/src/main/java/org/apache/commons/io/input/NullInputStream.java +++ b/src/main/java/org/apache/commons/io/input/NullInputStream.java @@ -205,9 +205,9 @@ public class NullInputStream extends AbstractInputStream { } /** - * Tests whether <i>mark</i> is supported. + * Tests whether <em>mark</em> is supported. * - * @return Whether <i>mark</i> is supported or not. + * @return Whether <em>mark</em> is supported or not. */ @Override public boolean markSupported() { diff --git a/src/main/java/org/apache/commons/io/input/NullReader.java b/src/main/java/org/apache/commons/io/input/NullReader.java index 0daeff65c..62119f0db 100644 --- a/src/main/java/org/apache/commons/io/input/NullReader.java +++ b/src/main/java/org/apache/commons/io/input/NullReader.java @@ -182,9 +182,9 @@ public class NullReader extends Reader { } /** - * Indicates whether <i>mark</i> is supported. + * Indicates whether <em>mark</em> is supported. * - * @return Whether <i>mark</i> is supported or not. + * @return Whether <em>mark</em> is supported or not. */ @Override public boolean markSupported() { diff --git a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java index 902177830..4b3289a9b 100644 --- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java +++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java @@ -77,7 +77,7 @@ import org.apache.commons.io.filefilter.TrueFileFilter; * monitor.stop(); * </pre> * <h2>File Filters</h2> This implementation can monitor portions of the file system by using {@link FileFilter}s to observe only the files and/or directories - * that are of interest. This makes it more efficient and reduces the noise from <i>unwanted</i> file system events. + * that are of interest. This makes it more efficient and reduces the noise from <em>unwanted</em> file system events. * <p> * <a href="https://commons.apache.org/io/">Commons IO</a> has a good range of useful, ready-made <a href="../filefilter/package-summary.html">File Filter</a> * implementations for this purpose. diff --git a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java index e951946e3..c314bb7b3 100644 --- a/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java +++ b/src/main/java/org/apache/commons/io/output/StringBuilderWriter.java @@ -24,7 +24,7 @@ import java.io.Writer; * {@link Writer} implementation that outputs to a {@link StringBuilder}. * <p> * <strong>NOTE:</strong> This implementation, as an alternative to - * {@link StringWriter}, provides an <i>un-synchronized</i> + * {@link StringWriter}, provides an <em>un-synchronized</em> * (i.e. for use in a single thread) implementation for better performance. * For safe usage with multiple {@link Thread}s then * {@link StringWriter} should be used.