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 2022/07/16 11:41:41 UTC
[commons-io] branch master updated: (chore) Fix minor typos (#367)
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 c8dcd5e9 (chore) Fix minor typos (#367)
c8dcd5e9 is described below
commit c8dcd5e9c64b0cbd98b4028e0529d7af2ac81a83
Author: Marc Wrobel <ma...@gmail.com>
AuthorDate: Sat Jul 16 13:41:35 2022 +0200
(chore) Fix minor typos (#367)
Fix various minor typos in :
- project documentations,
- javadoc and comments,
- private field, constant or method names,
- method attribute and variable names,
- test class and method names,
- exception messages.
---
RELEASE-NOTES.txt | 24 +++++-----
src/changes/changes.xml | 8 ++--
.../apache/commons/io/CloseableURLConnection.java | 24 +++++-----
.../java/org/apache/commons/io/EndianUtils.java | 4 +-
.../java/org/apache/commons/io/FileSystem.java | 6 +--
.../org/apache/commons/io/FileSystemUtils.java | 8 ++--
src/main/java/org/apache/commons/io/FileUtils.java | 52 +++++++++++-----------
.../java/org/apache/commons/io/FilenameUtils.java | 10 ++---
src/main/java/org/apache/commons/io/HexDump.java | 2 +-
src/main/java/org/apache/commons/io/IOCase.java | 10 ++---
src/main/java/org/apache/commons/io/IOUtils.java | 6 +--
.../apache/commons/io/StandardLineSeparator.java | 4 +-
.../java/org/apache/commons/io/ThreadMonitor.java | 6 +--
.../io/comparator/CompositeFileComparator.java | 2 +-
.../io/comparator/ExtensionFileComparator.java | 6 +--
.../io/comparator/LastModifiedFileComparator.java | 2 +-
.../commons/io/comparator/NameFileComparator.java | 6 +--
.../commons/io/comparator/PathFileComparator.java | 6 +--
.../org/apache/commons/io/comparator/package.html | 6 +--
.../java/org/apache/commons/io/file/PathUtils.java | 28 ++++++------
.../commons/io/file/spi/FileSystemProviders.java | 2 +-
.../commons/io/filefilter/FileFilterUtils.java | 2 +-
.../commons/io/filefilter/NameFileFilter.java | 2 +-
.../commons/io/filefilter/PrefixFileFilter.java | 2 +-
.../commons/io/filefilter/SuffixFileFilter.java | 2 +-
.../commons/io/filefilter/WildcardFileFilter.java | 2 +-
.../apache/commons/io/input/BOMInputStream.java | 2 +-
.../commons/io/input/BoundedInputStream.java | 2 +-
.../apache/commons/io/input/ByteBufferCleaner.java | 2 +-
.../commons/io/input/CharSequenceInputStream.java | 16 +++----
.../io/input/MemoryMappedFileInputStream.java | 4 +-
.../apache/commons/io/input/NullInputStream.java | 2 +-
.../org/apache/commons/io/input/NullReader.java | 2 +-
.../commons/io/input/ReadAheadInputStream.java | 6 +--
.../apache/commons/io/input/ReaderInputStream.java | 2 +-
.../commons/io/input/ReversedLinesFileReader.java | 4 +-
.../io/input/buffer/CircularBufferInputStream.java | 2 +-
.../commons/io/monitor/FileAlterationObserver.java | 2 +-
.../io/output/AbstractByteArrayOutputStream.java | 24 +++++-----
.../io/output/DeferredFileOutputStream.java | 4 +-
src/site/xdoc/bestpractices.xml | 4 +-
src/site/xdoc/description.xml | 2 +-
src/site/xdoc/mail-lists.xml | 2 +-
src/site/xdoc/upgradeto1_1.xml | 6 +--
src/site/xdoc/upgradeto1_2.xml | 2 +-
src/site/xdoc/upgradeto1_3.xml | 6 +--
src/site/xdoc/upgradeto1_4.xml | 6 +--
src/site/xdoc/upgradeto2_0.xml | 2 +-
src/site/xdoc/upgradeto2_5.xml | 4 +-
.../org/apache/commons/io/DeleteDirectoryTest.java | 2 +-
.../org/apache/commons/io/DirectoryWalkerTest.java | 8 ++--
.../commons/io/DirectoryWalkerTestCaseJava4.java | 8 ++--
.../org/apache/commons/io/FileSystemUtilsTest.java | 4 +-
.../commons/io/FileUtilsCleanDirectoryTest.java | 2 +-
.../io/FileUtilsCopyDirectoryToDirectoryTest.java | 2 +-
.../io/FileUtilsDeleteDirectoryLinuxTest.java | 2 +-
.../org/apache/commons/io/IOUtilsCopyTest.java | 4 +-
.../java/org/apache/commons/io/IOUtilsTest.java | 2 +-
.../io/file/AccumulatorPathVisitorTest.java | 4 +-
.../io/filefilter/IOFileFilterAbstractTest.java | 2 +-
.../io/input/CharSequenceInputStreamTest.java | 2 +-
.../io/input/ClassLoaderObjectInputStreamTest.java | 4 +-
.../io/input/MarkShieldInputStreamTest.java | 4 +-
.../commons/io/input/StringInputStreamTest.java | 4 +-
.../io/input/WindowsLineEndingInputStreamTest.java | 4 +-
.../commons/io/input/XmlStreamReaderTest.java | 6 +--
.../commons/io/output/ChunkedOutputStreamTest.java | 2 +-
.../commons/io/output/ChunkedWriterTest.java | 2 +-
.../commons/io/output/XmlStreamWriterTest.java | 2 +-
.../commons/io/test/ThrowOnCloseInputStream.java | 2 +-
.../commons/io/test/ThrowOnCloseOutputStream.java | 2 +-
.../apache/commons/io/test/ThrowOnCloseReader.java | 2 +-
.../apache/commons/io/test/ThrowOnCloseWriter.java | 2 +-
73 files changed, 209 insertions(+), 209 deletions(-)
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
index 29a63379..dc2ee6b2 100644
--- a/RELEASE-NOTES.txt
+++ b/RELEASE-NOTES.txt
@@ -42,7 +42,7 @@ o Remove IOException from the method signatures that no longer throw IO
Changes:
o Add SymbolicLinkFileFilter. Thanks to Gary Gregory.
-o Add test to make sure the setter of AndFileFilter works correctly #244. Thanks to trncate.
+o Add test to make sure the setter of AndFileFilter works correctly #244. Thanks to trncate.
o Add XmlStreamReader(Path). Thanks to Gary Gregory.
o Bump mockito-inline from 3.11.0 to 3.11.2 #247. Thanks to Dependabot.
o Bump jmh.version from 1.27 to 1.32 #237. Thanks to Dependabot.
@@ -287,7 +287,7 @@ o IO-662: Refactor ByteArrayOutputStream into synchronized and unsynchronized v
Fixed Bugs:
o IO-589: Some tests fail if the base path contains a space.
-o IO-582: Make methods in ObservableInputStream.Obsever public. Thanks to Bruno Palos.
+o IO-582: Make methods in ObservableInputStream.Observer public. Thanks to Bruno Palos.
o IO-535: Thread bug in FileAlterationMonitor.stop(int). Thanks to Svetlin Zarev, Anthony Raymond.
o IO-557: Perform locale independent upper case conversions. Thanks to luccioman.
o IO-570: Missing Javadoc in FilenameUtils causing Travis-CI build to fail. Thanks to Pranet Verma.
@@ -554,7 +554,7 @@ o IO-338: When a file is rotated, finish reading previous file prior to startin
o IO-354: Commons IO Tailer does not respect UTF-8 Charset.
o IO-323: What should happen in FileUtils.sizeOf[Directory] when an overflow takes place?
Added Javadoc.
-o IO-372: FileUtils.moveDirectory can produce misleading error message on failiure
+o IO-372: FileUtils.moveDirectory can produce misleading error message on failure
o IO-362: IOUtils.contentEquals* methods returns false if input1 == input2, should return true. Thanks to mmadson, ggregory.
o IO-357: [Tailer] InterruptedException while the thread is sleeping is silently ignored Thanks to mortenh.
o IO-352: Spelling fixes. Thanks to scop.
@@ -671,7 +671,7 @@ Apache Commons IO Version 2.2
Changes in this version include:
New features:
-o Add IOUTils.toBufferedReader(Reader) Issue: IO-313. Thanks to ggregory.
+o Add IOUtils.toBufferedReader(Reader) Issue: IO-313. Thanks to ggregory.
o Allow applications to provide buffer (or size) for copyLarge methods. Issue: IO-308. Thanks to Manoj Mokashi.
o New copyLarge() method in IOUtils that takes additional offset, length arguments Issue: IO-305. Thanks to Manoj Mokashi.
o Use terabyte (TB), petabyte (PB) and exabyte (EB) in FileUtils.byteCountToDisplaySize(long size) Issue: IO-287. Thanks to Ron Kuris, Gary Gregory.
@@ -855,7 +855,7 @@ Bug fixes from 1.4
* [IO-207] FileUtils - fix race condition in forceMkdir() method
* [IO-217] FileUtils - fix copyDirectoryToDirectory() makes infinite loops
* [IO-166] FileUtils - fix URL decoding in toFile(URL)
- * [IO-190] FileUtils - fix copyDirectory not preserving lastmodified date on sub-directories
+ * [IO-190] FileUtils - fix copyDirectory not preserving lastmodified date on subdirectories
* [IO-240] FileFilterUtils - ensure cvsFilter and svnFilter are only created once.
* [IO-175] IOUtils - fix copyFile() issues with very large files
* [IO-191] Improvements from static analysis
@@ -933,7 +933,7 @@ Enhancements from 1.3.2
- Add new Reader implementation that handles any CharSequence (String,
StringBuffer, StringBuilder or CharBuffer)
-- ThesholdingOuputStream [IO-121]
+- ThresholdingOutputStream [IO-121]
- Add a reset() method which sets the count of the bytes written back to zero.
- DeferredFileOutputStream [IO-130]
@@ -952,10 +952,10 @@ Enhancements from 1.3.2
- Add Singleton Constants to several stream classes [IO-143]
- PrefixFileFilter [IO-126]
- - Add faciltiy to specify case sensitivity on prefix matching
+ - Add facility to specify case sensitivity on prefix matching
- SuffixFileFilter [IO-126]
- - Add faciltiy to specify case sensitivity on suffix matching
+ - Add facility to specify case sensitivity on suffix matching
- RegexFileFilter [IO-74]
- Add new regular expression file filter implementation
@@ -1105,7 +1105,7 @@ Bug fixes from 1.2
- Added a new copyLarge(Reader, Writer) method that returns a long
- CountingInputStream/CountingOutputStream [IO-84]
- - Methods were declared as int thus the count was innacurate for large streams
+ - Methods were declared as int thus the count was inaccurate for large streams
- new long based methods getByteCount()/resetByteCount() added
- existing methods changed to throw an exception if the count is greater than an int
@@ -1166,7 +1166,7 @@ Enhancements from 1.2
- FileDeleteStrategy
- FileCleaner [IO-56,IO-70]
- FileDeleteStrategy is a strategy for handling file deletion
- - This can be used as a calback in FileCleaner
+ - This can be used as a callback in FileCleaner
- Together these allow FileCleaner to do a forceDelete to kill directories
- FileCleaner.exitWhenFinished [IO-99]
@@ -1296,7 +1296,7 @@ Semantic compatible - Yes, except:
Generally this will make no difference
- LockableFileWriter
- Improved validation and now create directories if necesssary
+ Improved validation and now create directories if necessary
plus these bug fixes may affect you semantically:
- FileUtils.touch() (Bug fix 29821)
@@ -1367,7 +1367,7 @@ Enhancements from 1.0
- IOUtils - toCharArray(InputStream) [28979]
- toCharArray(InputStream,encoding)
- toCharArray(Reader)
- Reads a stream/reader into a charatcter array
+ Reads a stream/reader into a character array
- IOUtils - readLines(InputStream) [36214]
- readLines(InputStream,encoding)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index dc310f5e..20eb95e9 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -937,7 +937,7 @@ The <action> type attribute can be add,update,fix,remove.
Adding the CircularBufferInputStream, and the PeekableInputStream.
</action>
<action issue="IO-582" dev="jochen" type="fix" due-to="Bruno Palos">
- Make methods in ObservableInputStream.Obsever public.
+ Make methods in ObservableInputStream.Observer public.
</action>
<action issue="IO-535" dev="pschumacher" type="fix" due-to="Svetlin Zarev, Anthony Raymond">
Thread bug in FileAlterationMonitor#stop(int).
@@ -1304,7 +1304,7 @@ The <action> type attribute can be add,update,fix,remove.
Added ChunkedOutputStream, ChunkedWriter
</action>
<action issue="IO-385" dev="sebb" type="fix">
- FileUtils.doCopyFile can potentially loop for ever
+ FileUtils.doCopyFile can potentially loop forever
Exit loop if no data to copy
</action>
<action issue="IO-383" dev="sebb" type="fix">
@@ -1373,7 +1373,7 @@ The <action> type attribute can be add,update,fix,remove.
Added Javadoc.
</action>
<action issue="IO-372" dev="sebb" type="fix">
- FileUtils.moveDirectory can produce misleading error message on failiure
+ FileUtils.moveDirectory can produce misleading error message on failure
</action>
<action issue="IO-375" dev="sebb" type="update">
FilenameUtils.splitOnTokens(String text) check for '**' could be simplified
@@ -1490,7 +1490,7 @@ The <action> type attribute can be add,update,fix,remove.
<release version="2.2" date="2012-March-26" description="New features and bug fixes.">
<action issue="IO-313" dev="ggregory" type="add" due-to="ggregory">
- Add IOUTils.toBufferedReader(Reader)
+ Add IOUtils.toBufferedReader(Reader)
</action>
<!-- Note: the issue was not raised by Manoj, but arose from IO-305 and tests he performed -->
<action issue="IO-308" dev="sebb" type="add" due-to="Manoj Mokashi">
diff --git a/src/main/java/org/apache/commons/io/CloseableURLConnection.java b/src/main/java/org/apache/commons/io/CloseableURLConnection.java
index 6895bfd2..7b945b6f 100644
--- a/src/main/java/org/apache/commons/io/CloseableURLConnection.java
+++ b/src/main/java/org/apache/commons/io/CloseableURLConnection.java
@@ -223,8 +223,8 @@ class CloseableURLConnection extends URLConnection implements AutoCloseable {
}
@Override
- public void setAllowUserInteraction(final boolean allowuserinteraction) {
- urlConnection.setAllowUserInteraction(allowuserinteraction);
+ public void setAllowUserInteraction(final boolean allowUserInteraction) {
+ urlConnection.setAllowUserInteraction(allowUserInteraction);
}
@Override
@@ -233,23 +233,23 @@ class CloseableURLConnection extends URLConnection implements AutoCloseable {
}
@Override
- public void setDefaultUseCaches(final boolean defaultusecaches) {
- urlConnection.setDefaultUseCaches(defaultusecaches);
+ public void setDefaultUseCaches(final boolean defaultUseCaches) {
+ urlConnection.setDefaultUseCaches(defaultUseCaches);
}
@Override
- public void setDoInput(final boolean doinput) {
- urlConnection.setDoInput(doinput);
+ public void setDoInput(final boolean doInput) {
+ urlConnection.setDoInput(doInput);
}
@Override
- public void setDoOutput(final boolean dooutput) {
- urlConnection.setDoOutput(dooutput);
+ public void setDoOutput(final boolean doOutput) {
+ urlConnection.setDoOutput(doOutput);
}
@Override
- public void setIfModifiedSince(final long ifmodifiedsince) {
- urlConnection.setIfModifiedSince(ifmodifiedsince);
+ public void setIfModifiedSince(final long ifModifiedSince) {
+ urlConnection.setIfModifiedSince(ifModifiedSince);
}
@Override
@@ -263,8 +263,8 @@ class CloseableURLConnection extends URLConnection implements AutoCloseable {
}
@Override
- public void setUseCaches(final boolean usecaches) {
- urlConnection.setUseCaches(usecaches);
+ public void setUseCaches(final boolean useCaches) {
+ urlConnection.setUseCaches(useCaches);
}
@Override
diff --git a/src/main/java/org/apache/commons/io/EndianUtils.java b/src/main/java/org/apache/commons/io/EndianUtils.java
index fdb3fd8d..acc95319 100644
--- a/src/main/java/org/apache/commons/io/EndianUtils.java
+++ b/src/main/java/org/apache/commons/io/EndianUtils.java
@@ -196,7 +196,7 @@ public class EndianUtils {
}
/**
- * Reads a unsigned integer (32-bit) from an InputStream. The value is
+ * Reads an unsigned integer (32-bit) from an InputStream. The value is
* converted to the opposed endian system while reading.
* @param input source InputStream
* @return the value just read
@@ -226,7 +226,7 @@ public class EndianUtils {
}
/**
- * Reads a unsigned short (16-bit) from an InputStream. The value is
+ * Reads an unsigned short (16-bit) from an InputStream. The value is
* converted to the opposed endian system while reading.
* @param input source InputStream
* @return the value just read
diff --git a/src/main/java/org/apache/commons/io/FileSystem.java b/src/main/java/org/apache/commons/io/FileSystem.java
index d91718bc..42f51672 100644
--- a/src/main/java/org/apache/commons/io/FileSystem.java
+++ b/src/main/java/org/apache/commons/io/FileSystem.java
@@ -311,8 +311,8 @@ public enum FileSystem {
/**
* Constructs a new instance.
*
- * @param caseSensitive Whether this file system is case sensitive.
- * @param casePreserving Whether this file system is case preserving.
+ * @param caseSensitive Whether this file system is case-sensitive.
+ * @param casePreserving Whether this file system is case-preserving.
* @param maxFileLength The maximum length for file names. The file name does not include folders.
* @param maxPathLength The maximum length of the path to a file. This can include folders.
* @param illegalFileNameChars Illegal characters for this file system.
@@ -511,4 +511,4 @@ public enum FileSystem {
final int index = indexOf(cs, '.', 0);
return index < 0 ? cs : cs.subSequence(0, index);
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/org/apache/commons/io/FileSystemUtils.java b/src/main/java/org/apache/commons/io/FileSystemUtils.java
index a92da946..85763ecd 100644
--- a/src/main/java/org/apache/commons/io/FileSystemUtils.java
+++ b/src/main/java/org/apache/commons/io/FileSystemUtils.java
@@ -188,7 +188,7 @@ public class FileSystemUtils {
* The free space is calculated via the command line.
* It uses 'dir /-c' on Windows, 'df -kP' on AIX/HP-UX and 'df -k' on other Unix.
* <p>
- * In order to work, you must be running Windows, or have a implementation of
+ * In order to work, you must be running Windows, or have an implementation of
* Unix df that supports GNU format when passed -k (or -kP). If you are going
* to rely on this code, please check that it works on your OS by running
* some simple tests to compare the command line with the output from this class.
@@ -218,7 +218,7 @@ public class FileSystemUtils {
* The free space is calculated via the command line.
* It uses 'dir /-c' on Windows, 'df -kP' on AIX/HP-UX and 'df -k' on other Unix.
* <p>
- * In order to work, you must be running Windows, or have a implementation of
+ * In order to work, you must be running Windows, or have an implementation of
* Unix df that supports GNU format when passed -k (or -kP). If you are going
* to rely on this code, please check that it works on your OS by running
* some simple tests to compare the command line with the output from this class.
@@ -484,8 +484,8 @@ public class FileSystemUtils {
// http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4784692
// http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4801027
// http://forum.java.sun.com/thread.jspa?threadID=533029&messageID=2572018
- // however, its still not perfect as the JDK support is so poor
- // (see commons-exec or Ant for a better multi-threaded multi-os solution)
+ // however, it's still not perfect as the JDK support is so poor
+ // (see commons-exec or Ant for a better multithreaded multi-os solution)
final List<String> lines = new ArrayList<>(20);
Process proc = null;
diff --git a/src/main/java/org/apache/commons/io/FileUtils.java b/src/main/java/org/apache/commons/io/FileUtils.java
index cf915511..03fabb75 100644
--- a/src/main/java/org/apache/commons/io/FileUtils.java
+++ b/src/main/java/org/apache/commons/io/FileUtils.java
@@ -497,7 +497,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.1
*/
public static void copyDirectory(final File srcDir, final File destDir) throws IOException {
@@ -525,7 +525,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.1
*/
public static void copyDirectory(final File srcDir, final File destDir, final boolean preserveFileDate)
@@ -574,7 +574,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.4
*/
public static void copyDirectory(final File srcDir, final File destDir, final FileFilter filter)
@@ -624,7 +624,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.4
*/
public static void copyDirectory(final File srcDir, final File destDir, final FileFilter filter, final boolean preserveFileDate) throws IOException {
@@ -674,7 +674,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 2.8.0
*/
public static void copyDirectory(final File srcDir, final File destDir, final FileFilter fileFilter, final boolean preserveFileDate,
@@ -720,7 +720,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.2
*/
public static void copyDirectoryToDirectory(final File sourceDir, final File destinationDir) throws IOException {
@@ -746,7 +746,7 @@ public class FileUtils {
* @param destFile the new file, must not be {@code null}.
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IOException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @throws IOException if the output file length is not the same as the input file length after the copy completes.
* @see #copyFileToDirectory(File, File)
* @see #copyFile(File, File, boolean)
@@ -773,7 +773,7 @@ public class FileUtils {
* @param preserveFileDate true if the file date of the copy should be the same as the original.
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IOException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @throws IOException if the output file length is not the same as the input file length after the copy completes
* @see #copyFile(File, File, boolean, CopyOption...)
*/
@@ -806,7 +806,7 @@ public class FileUtils {
* @throws FileNotFoundException if the source does not exist.
* @throws IllegalArgumentException if source is not a file.
* @throws IOException if the output file length is not the same as the input file length after the copy completes.
- * @throws IOException if an I/O error occurs, or setting the last-modified time didn't succeeded.
+ * @throws IOException if an I/O error occurs, or setting the last-modified time didn't succeed.
* @see #copyFileToDirectory(File, File, boolean)
* @since 2.8.0
*/
@@ -887,7 +887,7 @@ public class FileUtils {
* @param destDir the directory to place the copy in, must not be {@code null}.
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @see #copyFile(File, File, boolean)
*/
public static void copyFileToDirectory(final File srcFile, final File destDir) throws IOException {
@@ -911,7 +911,7 @@ public class FileUtils {
* @param destinationDir the directory to place the copy in, must not be {@code null}.
* @param preserveFileDate true if the file date of the copy should be the same as the original.
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @throws IOException if the output file length is not the same as the input file length after the copy completes.
* @see #copyFile(File, File, CopyOption...)
* @since 1.3
@@ -971,7 +971,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @see #copyDirectoryToDirectory(File, File)
* @see #copyFileToDirectory(File, File)
* @since 2.6
@@ -1002,11 +1002,11 @@ public class FileUtils {
* If the modification operation fails, the methods throws IOException.
* </p>
*
- * @param sourceIterable a existing files to copy, must not be {@code null}.
- * @param destinationDir the directory to place the copy in, must not be {@code null}.
+ * @param sourceIterable existing files to copy, must not be {@code null}.
+ * @param destinationDir the directory to place the copies in, must not be {@code null}.
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IOException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @see #copyFileToDirectory(File, File)
* @since 2.6
*/
@@ -1077,9 +1077,9 @@ public class FileUtils {
* @param source the {@link URL} to copy bytes from, must not be {@code null}
* @param destination the non-directory {@link File} to write bytes to (possibly overwriting), must not be
* {@code null}
- * @param connectionTimeoutMillis the number of milliseconds until this method will timeout if no connection could
+ * @param connectionTimeoutMillis the number of milliseconds until this method will time out if no connection could
* be established to the {@code source}
- * @param readTimeoutMillis the number of milliseconds until this method will timeout if no data could be read from
+ * @param readTimeoutMillis the number of milliseconds until this method will time out if no data could be read from
* the {@code source}
* @throws IOException if {@code source} URL cannot be opened
* @throws IOException if {@code destination} is a directory
@@ -1223,7 +1223,7 @@ public class FileUtils {
}
/**
- * Deletes a file, never throwing an exception. If file is a directory, delete it and all sub-directories.
+ * Deletes a file, never throwing an exception. If file is a directory, delete it and all subdirectories.
* <p>
* The difference between File.delete() and this method are:
* </p>
@@ -1327,7 +1327,7 @@ public class FileUtils {
}
/**
- * Deletes a file or directory. For a directory, delete it and all sub-directories.
+ * Deletes a file or directory. For a directory, delete it and all subdirectories.
* <p>
* The difference between File.delete() and this method are:
* </p>
@@ -1359,7 +1359,7 @@ public class FileUtils {
/**
* Schedules a file to be deleted when JVM exits.
- * If file is directory delete it and all sub-directories.
+ * If file is directory delete it and all subdirectories.
*
* @param file file or directory to delete, must not be {@code null}.
* @throws NullPointerException if the file is {@code null}.
@@ -2306,7 +2306,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.4
*/
public static void moveDirectory(final File srcDir, final File destDir) throws IOException {
@@ -2336,7 +2336,7 @@ public class FileUtils {
* @throws NullPointerException if any of the given {@link File}s are {@code null}.
* @throws IllegalArgumentException if the source or destination is invalid.
* @throws FileNotFoundException if the source does not exist.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.4
*/
public static void moveDirectoryToDirectory(final File source, final File destDir, final boolean createDestDir) throws IOException {
@@ -2388,7 +2388,7 @@ public class FileUtils {
* @throws FileExistsException if the destination file exists.
* @throws FileNotFoundException if the source file does not exist.
* @throws IOException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 2.9.0
*/
public static void moveFile(final File srcFile, final File destFile, final CopyOption... copyOptions) throws IOException {
@@ -2416,7 +2416,7 @@ public class FileUtils {
* @throws FileExistsException if the destination file exists.
* @throws FileNotFoundException if the source file does not exist.
* @throws IOException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.4
*/
public static void moveFileToDirectory(final File srcFile, final File destDir, final boolean createDestDir) throws IOException {
@@ -2443,7 +2443,7 @@ public class FileUtils {
* @throws FileExistsException if the directory or file exists in the destination directory.
* @throws FileNotFoundException if the source file does not exist.
* @throws IOException if source or destination is invalid.
- * @throws IOException if an error occurs or setting the last-modified time didn't succeeded.
+ * @throws IOException if an error occurs or setting the last-modified time didn't succeed.
* @since 1.4
*/
public static void moveToDirectory(final File src, final File destDir, final boolean createDestDir) throws IOException {
@@ -2857,7 +2857,7 @@ public class FileUtils {
* @param name The parameter name to use in the exception message in case of null input.
* @return the given directory.
* @throws NullPointerException if the given {@link File} is {@code null}.
- * @throws IllegalArgumentException if the given {@link File} does exists but is not a directory.
+ * @throws IllegalArgumentException if the given {@link File} exists but is not a directory.
*/
private static File requireFileIfExists(final File file, final String name) {
Objects.requireNonNull(file, name);
diff --git a/src/main/java/org/apache/commons/io/FilenameUtils.java b/src/main/java/org/apache/commons/io/FilenameUtils.java
index 67d2303c..c23384df 100644
--- a/src/main/java/org/apache/commons/io/FilenameUtils.java
+++ b/src/main/java/org/apache/commons/io/FilenameUtils.java
@@ -1300,8 +1300,8 @@ public class FilenameUtils {
* the separator character.
*
* @param fileName the fileName to normalize, null returns null
- * @param unixSeparator {@code true} if a unix separator should
- * be used or {@code false} if a windows separator should be used.
+ * @param unixSeparator {@code true} if a Unix separator should
+ * be used or {@code false} if a Windows separator should be used.
* @return the normalized fileName, or null if invalid
* @throws IllegalArgumentException if the fileName contains the null character ({@code U+0000})
* @since 2.0
@@ -1394,8 +1394,8 @@ public class FilenameUtils {
* </pre>
*
* @param fileName the fileName to normalize, null returns null
- * @param unixSeparator {@code true} if a unix separator should
- * be used or {@code false} if a windows separator should be used.
+ * @param unixSeparator {@code true} if a Unix separator should
+ * be used or {@code false} if a Windows separator should be used.
* @return the normalized fileName, or null if invalid
* @throws IllegalArgumentException if the fileName contains the null character ({@code U+0000})
* @since 2.0
@@ -1436,7 +1436,7 @@ public class FilenameUtils {
}
/**
- * Checks the input for null characters ({@code U+0000}), a sign of unsanitized data being passed to to file level functions.
+ * Checks the input for null characters ({@code U+0000}), a sign of unsanitized data being passed to file level functions.
*
* This may be used for poison byte attacks.
*
diff --git a/src/main/java/org/apache/commons/io/HexDump.java b/src/main/java/org/apache/commons/io/HexDump.java
index 6674668b..5482b851 100644
--- a/src/main/java/org/apache/commons/io/HexDump.java
+++ b/src/main/java/org/apache/commons/io/HexDump.java
@@ -34,7 +34,7 @@ import java.util.Objects;
public class HexDump {
/**
- * The line-separator (initializes to "line.separator" system property.
+ * The line-separator (initializes to "line.separator" system property).
*
* @deprecated Use {@link System#lineSeparator()}.
*/
diff --git a/src/main/java/org/apache/commons/io/IOCase.java b/src/main/java/org/apache/commons/io/IOCase.java
index 4893ec16..dbb6f0a2 100644
--- a/src/main/java/org/apache/commons/io/IOCase.java
+++ b/src/main/java/org/apache/commons/io/IOCase.java
@@ -40,12 +40,12 @@ import java.util.stream.Stream;
public enum IOCase {
/**
- * The constant for case sensitive regardless of operating system.
+ * The constant for case-sensitive regardless of operating system.
*/
SENSITIVE("Sensitive", true),
/**
- * The constant for case insensitive regardless of operating system.
+ * The constant for case-insensitive regardless of operating system.
*/
INSENSITIVE("Insensitive", false),
@@ -54,7 +54,7 @@ public enum IOCase {
* Windows is case-insensitive when comparing file names, Unix is case-sensitive.
* <p>
* <strong>Note:</strong> This only caters for Windows and Unix. Other operating
- * systems (e.g. OSX and OpenVMS) are treated as case sensitive if they use the
+ * systems (e.g. OSX and OpenVMS) are treated as case-sensitive if they use the
* Unix file separator and case-insensitive if they use the Windows file separator
* (see {@link java.io.File#separatorChar}).
* </p>
@@ -245,9 +245,9 @@ public enum IOCase {
}
/**
- * Does the object represent case sensitive comparison.
+ * Does the object represent case-sensitive comparison.
*
- * @return true if case sensitive
+ * @return true if case-sensitive
*/
public boolean isCaseSensitive() {
return sensitive;
diff --git a/src/main/java/org/apache/commons/io/IOUtils.java b/src/main/java/org/apache/commons/io/IOUtils.java
index c161d51a..a798a75f 100644
--- a/src/main/java/org/apache/commons/io/IOUtils.java
+++ b/src/main/java/org/apache/commons/io/IOUtils.java
@@ -2255,7 +2255,7 @@ public class IOUtils {
}
/*
* N.B. no need to synchronize access to SKIP_BYTE_BUFFER: - we don't care if the buffer is created multiple
- * times (the data is ignored) - we always use the same size buffer, so if it it is recreated it will still be
+ * times (the data is ignored) - we always use the same size buffer, so if it is recreated it will still be
* OK (if the buffer size were variable, we would need to synch. to ensure some other thread did not create a
* smaller one)
*/
@@ -2518,10 +2518,10 @@ public class IOUtils {
public static byte[] toByteArray(final InputStream inputStream) throws IOException {
// We use a ThresholdingOutputStream to avoid reading AND writing more than Integer.MAX_VALUE.
try (UnsynchronizedByteArrayOutputStream ubaOutput = new UnsynchronizedByteArrayOutputStream();
- ThresholdingOutputStream thresholdOuput = new ThresholdingOutputStream(Integer.MAX_VALUE, os -> {
+ ThresholdingOutputStream thresholdOutput = new ThresholdingOutputStream(Integer.MAX_VALUE, os -> {
throw new IllegalArgumentException(String.format("Cannot read more than %,d into a byte array", Integer.MAX_VALUE));
}, os -> ubaOutput)) {
- copy(inputStream, thresholdOuput);
+ copy(inputStream, thresholdOutput);
return ubaOutput.toByteArray();
}
}
diff --git a/src/main/java/org/apache/commons/io/StandardLineSeparator.java b/src/main/java/org/apache/commons/io/StandardLineSeparator.java
index c0b4ff96..4d40ada2 100644
--- a/src/main/java/org/apache/commons/io/StandardLineSeparator.java
+++ b/src/main/java/org/apache/commons/io/StandardLineSeparator.java
@@ -28,7 +28,7 @@ import java.util.Objects;
public enum StandardLineSeparator {
/**
- * Carriage return. This is the line ending used on Macos 9 and earlier.
+ * Carriage return. This is the line ending used on Mac OS 9 and earlier.
*/
CR("\r"),
@@ -38,7 +38,7 @@ public enum StandardLineSeparator {
CRLF("\r\n"),
/**
- * Line feed. This is the line ending used on Linux and Macos X and later.
+ * Line feed. This is the line ending used on Linux and Mac OS X and later.
*/
LF("\n");
diff --git a/src/main/java/org/apache/commons/io/ThreadMonitor.java b/src/main/java/org/apache/commons/io/ThreadMonitor.java
index 0db54d09..1b691904 100644
--- a/src/main/java/org/apache/commons/io/ThreadMonitor.java
+++ b/src/main/java/org/apache/commons/io/ThreadMonitor.java
@@ -41,7 +41,7 @@ import java.time.Instant;
*/
class ThreadMonitor implements Runnable {
- private static int getNanosOfMiili(final Duration duration) {
+ private static int getNanosOfMilli(final Duration duration) {
return duration.getNano() % 1_000_000;
}
/**
@@ -57,7 +57,7 @@ class ThreadMonitor implements Runnable {
final Instant finishInstant = Instant.now().plus(duration);
Duration remainingDuration = duration;
do {
- Thread.sleep(remainingDuration.toMillis(), getNanosOfMiili(remainingDuration));
+ Thread.sleep(remainingDuration.toMillis(), getNanosOfMilli(remainingDuration));
remainingDuration = Duration.between(Instant.now(), finishInstant);
} while (!remainingDuration.isNegative());
}
@@ -75,7 +75,7 @@ class ThreadMonitor implements Runnable {
/**
* Starts monitoring the specified thread.
*
- * @param thread The thread The thread to monitor
+ * @param thread The thread to monitor
* @param timeout The timeout amount. or no timeout if the value is zero or less.
* @return The monitor thread or {@code null} if the timeout amount is not greater than zero.
*/
diff --git a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
index 5ca90e61..2c9d7dcf 100644
--- a/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/CompositeFileComparator.java
@@ -25,7 +25,7 @@ import java.util.stream.StreamSupport;
* Compare two files using a set of delegate file {@link Comparator}.
* <p>
* This comparator can be used to sort lists or arrays of files
- * by combining a number other comparators.
+ * by combining a number of other comparators.
* <p>
* Example of sorting a list of files by type (i.e. directory or file)
* and then by name:
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 b1b15162..e855fbff 100644
--- a/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/ExtensionFileComparator.java
@@ -29,7 +29,7 @@ import org.apache.commons.io.IOCase;
* <p>
* This comparator can be used to sort lists or arrays of files
* by their file extension either in a case-sensitive, case-insensitive or
- * system dependent case sensitive way. A number of singleton instances
+ * system dependent case-sensitive way. A number of singleton instances
* are provided for the various case sensitivity options (using {@link IOCase})
* and the reverse of those options.
* </p>
@@ -76,11 +76,11 @@ public class ExtensionFileComparator extends AbstractFileComparator implements S
/** Reverse system sensitive path comparator instance (see {@link IOCase#SYSTEM}) */
public static final Comparator<File> EXTENSION_SYSTEM_REVERSE = new ReverseFileComparator(EXTENSION_SYSTEM_COMPARATOR);
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase ioCase;
/**
- * Constructs a case sensitive file extension comparator instance.
+ * Constructs a case-sensitive file extension comparator instance.
*/
public ExtensionFileComparator() {
this.ioCase = IOCase.SENSITIVE;
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 60d4517d..fdfadb75 100644
--- a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
@@ -59,7 +59,7 @@ public class LastModifiedFileComparator extends AbstractFileComparator implement
public static final Comparator<File> LASTMODIFIED_REVERSE = new ReverseFileComparator(LASTMODIFIED_COMPARATOR);
/**
- * Compares the last the last modified date/time of two files.
+ * Compares the last modified date/time of two files.
*
* @param file1 The first file to compare.
* @param file2 The second file to compare.
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 f9448009..db3e8b24 100644
--- a/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/NameFileComparator.java
@@ -27,7 +27,7 @@ import org.apache.commons.io.IOCase;
* <p>
* This comparator can be used to sort lists or arrays of files
* by their name either in a case-sensitive, case-insensitive or
- * system dependent case sensitive way. A number of singleton instances
+ * system dependent case-sensitive way. A number of singleton instances
* are provided for the various case sensitivity options (using {@link IOCase})
* and the reverse of those options.
* </p>
@@ -72,11 +72,11 @@ public class NameFileComparator extends AbstractFileComparator implements Serial
/** Reverse system sensitive name comparator instance (see {@link IOCase#SYSTEM}) */
public static final Comparator<File> NAME_SYSTEM_REVERSE = new ReverseFileComparator(NAME_SYSTEM_COMPARATOR);
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase ioCase;
/**
- * Constructs a case sensitive file name comparator instance.
+ * Constructs a case-sensitive file name comparator instance.
*/
public NameFileComparator() {
this.ioCase = IOCase.SENSITIVE;
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 751cf5de..4386c1a4 100644
--- a/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
+++ b/src/main/java/org/apache/commons/io/comparator/PathFileComparator.java
@@ -27,7 +27,7 @@ import org.apache.commons.io.IOCase;
* <p>
* This comparator can be used to sort lists or arrays of files
* by their path either in a case-sensitive, case-insensitive or
- * system dependent case sensitive way. A number of singleton instances
+ * system dependent case-sensitive way. A number of singleton instances
* are provided for the various case sensitivity options (using {@link IOCase})
* and the reverse of those options.
* </p>
@@ -72,11 +72,11 @@ public class PathFileComparator extends AbstractFileComparator implements Serial
/** Reverse system sensitive path comparator instance (see {@link IOCase#SYSTEM}) */
public static final Comparator<File> PATH_SYSTEM_REVERSE = new ReverseFileComparator(PATH_SYSTEM_COMPARATOR);
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase ioCase;
/**
- * Constructs a case sensitive file path comparator instance.
+ * Constructs a case-sensitive file path comparator instance.
*/
public PathFileComparator() {
this.ioCase = IOCase.SENSITIVE;
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 bd2d2394..433420ae 100644
--- a/src/main/java/org/apache/commons/io/comparator/package.html
+++ b/src/main/java/org/apache/commons/io/comparator/package.html
@@ -22,7 +22,7 @@ for {@link java.io.File}s.
</p>
<h2>Sorting</h2>
<p>
- All the compartors include <i>convenience</i> utility <code>sort(File...)</code> and
+ All the comparators include <i>convenience</i> utility <code>sort(File...)</code> and
<code>sort(List)</code> methods.
</p>
<p>
@@ -42,7 +42,7 @@ for {@link java.io.File}s.
<h2>Composite Comparator</h2>
<p>
The <a href="CompositeFileComparator.html">CompositeFileComparator</a> can be used
- to compare (and sort lists or arrays of files) by combining a number other comparators.
+ to compare (and sort lists or arrays of files) by combining a number of other comparators.
</p>
<p>
For example, to sort an array of files by type (i.e. directory or file)
@@ -83,7 +83,7 @@ for {@link java.io.File}s.
</li>
</ul>
</li>
- <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extenstions:
+ <li><a href="ExtensionFileComparator.html">ExtensionFileComparator</a> - compare file extensions:
<ul>
<li><a href="ExtensionFileComparator.html#EXTENSION_COMPARATOR">EXTENSION_COMPARATOR</a>
- Compare using <code>FilenameUtils.getExtension(String)</code> method.
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 d0e1a57d..32292bb4 100644
--- a/src/main/java/org/apache/commons/io/file/PathUtils.java
+++ b/src/main/java/org/apache/commons/io/file/PathUtils.java
@@ -214,7 +214,7 @@ public final class PathUtils {
}
/**
- * Cleans a directory including sub-directories without deleting directories.
+ * Cleans a directory including subdirectories without deleting directories.
*
* @param directory directory to clean.
* @return The visitation path counters.
@@ -225,7 +225,7 @@ public final class PathUtils {
}
/**
- * Cleans a directory including sub-directories without deleting directories.
+ * Cleans a directory including subdirectories without deleting directories.
*
* @param directory directory to clean.
* @param deleteOptions How to handle deletion.
@@ -315,7 +315,7 @@ public final class PathUtils {
}
/**
- * Counts aspects of a directory including sub-directories.
+ * Counts aspects of a directory including subdirectories.
*
* @param directory directory to delete.
* @return The visitor used to count the given directory.
@@ -326,7 +326,7 @@ public final class PathUtils {
}
/**
- * Counts aspects of a directory including sub-directories.
+ * Counts aspects of a directory including subdirectories.
*
* @param directory directory to count.
* @return The visitor used to count the given directory.
@@ -378,7 +378,7 @@ public final class PathUtils {
}
/**
- * Deletes a file or directory. If the path is a directory, delete it and all sub-directories.
+ * Deletes a file or directory. If the path is a directory, delete it and all subdirectories.
* <p>
* The difference between File.delete() and this method are:
* </p>
@@ -397,7 +397,7 @@ public final class PathUtils {
}
/**
- * Deletes a file or directory. If the path is a directory, delete it and all sub-directories.
+ * Deletes a file or directory. If the path is a directory, delete it and all subdirectories.
* <p>
* The difference between File.delete() and this method are:
* </p>
@@ -419,7 +419,7 @@ public final class PathUtils {
}
/**
- * Deletes a file or directory. If the path is a directory, delete it and all sub-directories.
+ * Deletes a file or directory. If the path is a directory, delete it and all subdirectories.
* <p>
* The difference between File.delete() and this method are:
* </p>
@@ -442,7 +442,7 @@ public final class PathUtils {
}
/**
- * Deletes a directory including sub-directories.
+ * Deletes a directory including subdirectories.
*
* @param directory directory to delete.
* @return The visitor used to delete the given directory.
@@ -453,7 +453,7 @@ public final class PathUtils {
}
/**
- * Deletes a directory including sub-directories.
+ * Deletes a directory including subdirectories.
*
* @param directory directory to delete.
* @param deleteOptions How to handle deletion.
@@ -469,7 +469,7 @@ public final class PathUtils {
}
/**
- * Deletes a directory including sub-directories.
+ * Deletes a directory including subdirectories.
*
* @param directory directory to delete.
* @param linkOptions How to handle symbolic links.
@@ -564,7 +564,7 @@ public final class PathUtils {
/**
* Compares the file sets of two Paths to determine if they are equal or not while considering file contents. The
- * comparison includes all files in all sub-directories.
+ * comparison includes all files in all subdirectories.
*
* @param path1 The first directory.
* @param path2 The second directory.
@@ -577,7 +577,7 @@ public final class PathUtils {
/**
* Compares the file sets of two Paths to determine if they are equal or not while considering file contents. The
- * comparison includes all files in all sub-directories.
+ * comparison includes all files in all subdirectories.
*
* @param path1 The first directory.
* @param path2 The second directory.
@@ -621,7 +621,7 @@ public final class PathUtils {
/**
* Compares the file sets of two Paths to determine if they are equal or not without considering file contents. The
- * comparison includes all files in all sub-directories.
+ * comparison includes all files in all subdirectories.
*
* @param path1 The first directory.
* @param path2 The second directory.
@@ -634,7 +634,7 @@ public final class PathUtils {
/**
* Compares the file sets of two Paths to determine if they are equal or not without considering file contents. The
- * comparison includes all files in all sub-directories.
+ * comparison includes all files in all subdirectories.
*
* @param path1 The first directory.
* @param path2 The second directory.
diff --git a/src/main/java/org/apache/commons/io/file/spi/FileSystemProviders.java b/src/main/java/org/apache/commons/io/file/spi/FileSystemProviders.java
index 93926662..4058b795 100644
--- a/src/main/java/org/apache/commons/io/file/spi/FileSystemProviders.java
+++ b/src/main/java/org/apache/commons/io/file/spi/FileSystemProviders.java
@@ -27,7 +27,7 @@ import java.util.List;
import java.util.Objects;
/**
- * Helps working with {@link FileSystemProvider}.
+ * Helps to work with {@link FileSystemProvider}.
*
* @since 2.9.0
*/
diff --git a/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java b/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
index b62e21c4..e47655dd 100644
--- a/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
+++ b/src/main/java/org/apache/commons/io/filefilter/FileFilterUtils.java
@@ -510,7 +510,7 @@ public class FileFilterUtils {
*
* @param filter the filter to decorate, null means an unrestricted filter
* @return the decorated filter, never null
- * @since 1.1 (method existed but had bug in 1.0)
+ * @since 1.1 (method existed but had a bug in 1.0)
*/
public static IOFileFilter makeCVSAware(final IOFileFilter filter) {
return filter == null ? CVS_FILTER : and(filter, CVS_FILTER);
diff --git a/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
index b916fae6..71fe7c93 100644
--- a/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/NameFileFilter.java
@@ -72,7 +72,7 @@ public class NameFileFilter extends AbstractFileFilter implements Serializable {
/** The file names to search for */
private final String[] names;
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase ioCase;
/**
diff --git a/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
index f573ad9f..22081a55 100644
--- a/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/PrefixFileFilter.java
@@ -72,7 +72,7 @@ public class PrefixFileFilter extends AbstractFileFilter implements Serializable
/** The file name prefixes to search for */
private final String[] prefixes;
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase isCase;
/**
diff --git a/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
index 92532273..dad16460 100644
--- a/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/SuffixFileFilter.java
@@ -73,7 +73,7 @@ public class SuffixFileFilter extends AbstractFileFilter implements Serializable
/** The file name suffixes to search for */
private final String[] suffixes;
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase ioCase;
/**
diff --git a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
index af54b094..a532e441 100644
--- a/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
+++ b/src/main/java/org/apache/commons/io/filefilter/WildcardFileFilter.java
@@ -82,7 +82,7 @@ public class WildcardFileFilter extends AbstractFileFilter implements Serializab
/** The wildcards that will be used to match file names. */
private final String[] wildcards;
- /** Whether the comparison is case sensitive. */
+ /** Whether the comparison is case-sensitive. */
private final IOCase ioCase;
/**
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index 363ee110..7098b4c0 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -119,7 +119,7 @@ public class BOMInputStream extends ProxyInputStream {
}
/**
- * Constructs a new BOM InputStream that detects a a {@link ByteOrderMark#UTF_8} and optionally includes it.
+ * Constructs a new BOM InputStream that detects a {@link ByteOrderMark#UTF_8} and optionally includes it.
*
* @param delegate
* the InputStream to delegate to
diff --git a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
index f35839dc..829f7260 100644
--- a/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BoundedInputStream.java
@@ -70,7 +70,7 @@ public class BoundedInputStream extends InputStream {
* @param size The maximum number of bytes to return
*/
public BoundedInputStream(final InputStream in, final long size) {
- // Some badly designed methods - eg the servlet API - overload length
+ // Some badly designed methods - e.g. the servlet API - overload length
// such that "-1" means stream finished
this.max = size;
this.in = in;
diff --git a/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java b/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
index bf595464..fc334e96 100644
--- a/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
+++ b/src/main/java/org/apache/commons/io/input/ByteBufferCleaner.java
@@ -22,7 +22,7 @@ import java.nio.ByteBuffer;
/**
* Cleans a direct {@link ByteBuffer}. Without manual intervention, direct ByteBuffers will be cleaned eventually upon
- * garbage collection. However, this should not be be relied upon since it may not occur in a timely fashion -
+ * garbage collection. However, this should not be relied upon since it may not occur in a timely fashion -
* especially since off heap ByeBuffers don't put pressure on the garbage collector.
* <p>
* <b>Warning:</b> Do not attempt to use a direct {@link ByteBuffer} that has been cleaned or bad things will happen.
diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index 5dd89d75..6fe6d9e8 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -117,8 +117,8 @@ public class CharSequenceInputStream extends InputStream {
*/
@Override
public int available() throws IOException {
- // The cached entries are in bbuf; since encoding always creates at least one byte
- // per character, we can add the two to get a better estimate (e.g. if bbuf is empty)
+ // The cached entries are in bBuf; since encoding always creates at least one byte
+ // per character, we can add the two to get a better estimate (e.g. if bBuf is empty)
// Note that the previous implementation (2.4) could return zero even though there were
// encoded bytes still available.
return this.bBuf.remaining() + this.cBuf.remaining();
@@ -163,8 +163,8 @@ public class CharSequenceInputStream extends InputStream {
this.bBufMark = this.bBuf.position();
this.cBuf.mark();
this.bBuf.mark();
- // It would be nice to be able to use mark & reset on the cbuf and bbuf;
- // however the bbuf is re-used so that won't work
+ // It would be nice to be able to use mark & reset on the cBuf and bBuf;
+ // however the bBuf is re-used so that won't work
}
@Override
@@ -225,16 +225,16 @@ public class CharSequenceInputStream extends InputStream {
//
// This is not the most efficient implementation, as it re-encodes from the beginning.
//
- // Since the bbuf is re-used, in general it's necessary to re-encode the data.
+ // Since the bBuf is re-used, in general it's necessary to re-encode the data.
//
// It should be possible to apply some optimisations however:
- // + use mark/reset on the cbuf and bbuf. This would only work if the buffer had not been (re)filled since
+ // + use mark/reset on the cBuf and bBuf. This would only work if the buffer had not been (re)filled since
// the mark. The code would have to catch InvalidMarkException - does not seem possible to check if mark is
- // valid otherwise. + Try saving the state of the cbuf before each fillBuffer; it might be possible to
+ // valid otherwise. + Try saving the state of the cBuf before each fillBuffer; it might be possible to
// restart from there.
//
if (this.cBufMark != NO_MARK) {
- // if cbuf is at 0, we have not started reading anything, so skip re-encoding
+ // if cBuf is at 0, we have not started reading anything, so skip re-encoding
if (this.cBuf.position() != 0) {
this.charsetEncoder.reset();
this.cBuf.rewind();
diff --git a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
index 7be5c6a3..797a41e9 100644
--- a/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/MemoryMappedFileInputStream.java
@@ -73,7 +73,7 @@ public class MemoryMappedFileInputStream extends InputStream {
/**
* Constructs a new instance.
*
- * @param file The path of the file to to open.
+ * @param file The path of the file to open.
* @throws IOException If an I/O error occurs
*/
public MemoryMappedFileInputStream(final Path file) throws IOException {
@@ -83,7 +83,7 @@ public class MemoryMappedFileInputStream extends InputStream {
/**
* Constructs a new instance.
*
- * @param file The path of the file to to open.
+ * @param file The path of the file to open.
* @param bufferSize Size of the sliding buffer.
* @throws IOException If an I/O error occurs.
*/
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 438d602f..9c5745fe 100644
--- a/src/main/java/org/apache/commons/io/input/NullInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/NullInputStream.java
@@ -309,7 +309,7 @@ public class NullInputStream extends InputStream {
*
* @throws UnsupportedOperationException if mark is not supported.
* @throws IOException If no position has been marked
- * or the read limit has been exceed since the last position was
+ * or the read limit has been exceeded since the last position was
* marked.
*/
@Override
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 6e214eba..194d16fd 100644
--- a/src/main/java/org/apache/commons/io/input/NullReader.java
+++ b/src/main/java/org/apache/commons/io/input/NullReader.java
@@ -293,7 +293,7 @@ public class NullReader extends Reader {
*
* @throws UnsupportedOperationException if mark is not supported.
* @throws IOException If no position has been marked
- * or the read limit has been exceed since the last position was
+ * or the read limit has been exceeded since the last position was
* marked.
*/
@Override
diff --git a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
index 1af228fe..1939f266 100644
--- a/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReadAheadInputStream.java
@@ -140,7 +140,7 @@ public class ReadAheadInputStream extends InputStream {
* @param inputStream The underlying input stream.
* @param bufferSizeInBytes The buffer size.
* @param executorService An executor service for the read-ahead thread.
- * @param shutdownExecutorService Whether or not to shutdown the given ExecutorService on close.
+ * @param shutdownExecutorService Whether or not to shut down the given ExecutorService on close.
*/
private ReadAheadInputStream(final InputStream inputStream, final int bufferSizeInBytes,
final ExecutorService executorService, final boolean shutdownExecutorService) {
@@ -268,7 +268,7 @@ public class ReadAheadInputStream extends InputStream {
return EOF;
}
}
- // Swap the newly read read ahead buffer in place of empty active buffer.
+ // Swap the newly read ahead buffer in place of empty active buffer.
swapBuffers();
// After swapping buffers, trigger another async read for read ahead buffer.
readAsync();
@@ -448,7 +448,7 @@ public class ReadAheadInputStream extends InputStream {
try {
isWaiting.set(true);
// There is only one reader, and one writer, so the writer should signal only once,
- // but a while loop checking the wake up condition is still needed to avoid spurious wakeups.
+ // but a while loop checking the wake-up condition is still needed to avoid spurious wakeups.
while (readInProgress) {
asyncReadComplete.await();
}
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 c4f6fbfb..a9e479c8 100644
--- a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -190,7 +190,7 @@ public class ReaderInputStream extends InputStream {
* </p>
*
* @param reader the target {@link Reader}
- * @param charsetEncoder the charset encoder, null defauls to the default Charset encoder.
+ * @param charsetEncoder the charset encoder, null defaults to the default Charset encoder.
* @param bufferSize the size of the input buffer in number of characters
* @since 2.1
*/
diff --git a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
index 5d7e94c3..79aa6225 100644
--- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
+++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
@@ -84,7 +84,7 @@ public class ReversedLinesFileReader implements Closeable {
}
/**
- * Creates the buffer containing any left over bytes.
+ * Creates the buffer containing any leftover bytes.
*/
private void createLeftOver() {
final int lineLengthBytes = currentLastBytePos + 1;
@@ -404,7 +404,7 @@ public class ReversedLinesFileReader implements Closeable {
while (line == null) {
currentFilePart = currentFilePart.rollOver();
if (currentFilePart == null) {
- // no more fileparts: we're done, leave line set to null
+ // no more FileParts: we're done, leave line set to null
break;
}
line = currentFilePart.readLine();
diff --git a/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java b/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java
index c8393a16..02201b25 100644
--- a/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/buffer/CircularBufferInputStream.java
@@ -39,7 +39,7 @@ public class CircularBufferInputStream extends InputStream {
/** Internal buffer size. */
protected final int bufferSize;
- /** Whether we've see the input stream EOF. */
+ /** Whether we've seen the input stream EOF. */
private boolean eof;
/**
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 2f3f8f96..9e9687ca 100644
--- a/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
+++ b/src/main/java/org/apache/commons/io/monitor/FileAlterationObserver.java
@@ -84,7 +84,7 @@ import org.apache.commons.io.comparator.NameFileComparator;
* noise from <i>unwanted</i> file system events.
* <p>
* <a href="https://commons.apache.org/io/">Commons IO</a> has a good range of
- * useful, ready made
+ * useful, ready-made
* <a href="../filefilter/package-summary.html">File Filter</a>
* implementations for this purpose.
* <p>
diff --git a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
index 9ba57f58..dd8b0e42 100644
--- a/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java
@@ -116,9 +116,9 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
* Makes a new buffer available either by allocating
* a new one or re-cycling an existing one.
*
- * @param newcount the size of the buffer if one is created
+ * @param newCount the size of the buffer if one is created
*/
- protected void needNewBuffer(final int newcount) {
+ protected void needNewBuffer(final int newCount) {
if (currentBufferIndex < buffers.size() - 1) {
// Recycling old buffer
filledBufferSum += currentBuffer.length;
@@ -129,10 +129,10 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
// Creating new buffer
final int newBufferSize;
if (currentBuffer == null) {
- newBufferSize = newcount;
+ newBufferSize = newCount;
filledBufferSum = 0;
} else {
- newBufferSize = Math.max(currentBuffer.length << 1, newcount - filledBufferSum);
+ newBufferSize = Math.max(currentBuffer.length << 1, newCount - filledBufferSum);
filledBufferSum += currentBuffer.length;
}
@@ -194,18 +194,18 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
if (remaining == 0) {
return IOUtils.EMPTY_BYTE_ARRAY;
}
- final byte[] newbuf = IOUtils.byteArray(remaining);
+ final byte[] newBuf = IOUtils.byteArray(remaining);
int pos = 0;
for (final byte[] buf : buffers) {
final int c = Math.min(buf.length, remaining);
- System.arraycopy(buf, 0, newbuf, pos, c);
+ System.arraycopy(buf, 0, newBuf, pos, c);
pos += c;
remaining -= c;
if (remaining == 0) {
break;
}
}
- return newbuf;
+ return newBuf;
}
/**
@@ -301,7 +301,7 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
/**
* Writes the entire contents of the specified input stream to this
* byte stream. Bytes from the input stream are read directly into the
- * internal buffers of this streams.
+ * internal buffer of this stream.
*
* @param in the input stream to read from
* @return total number of bytes read from the input stream
@@ -321,7 +321,7 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
* @param len The number of bytes to write
*/
protected void writeImpl(final byte[] b, final int off, final int len) {
- final int newcount = count + len;
+ final int newCount = count + len;
int remaining = len;
int inBufferPos = count - filledBufferSum;
while (remaining > 0) {
@@ -329,17 +329,17 @@ public abstract class AbstractByteArrayOutputStream extends OutputStream {
System.arraycopy(b, off + len - remaining, currentBuffer, inBufferPos, part);
remaining -= part;
if (remaining > 0) {
- needNewBuffer(newcount);
+ needNewBuffer(newCount);
inBufferPos = 0;
}
}
- count = newcount;
+ count = newCount;
}
/**
* Writes the entire contents of the specified input stream to this
* byte stream. Bytes from the input stream are read directly into the
- * internal buffers of this streams.
+ * internal buffer of this stream.
*
* @param in the input stream to read from
* @return total number of bytes read from the input stream
diff --git a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
index 4e419fab..551b2be9 100644
--- a/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DeferredFileOutputStream.java
@@ -122,7 +122,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream {
public DeferredFileOutputStream(final int threshold, final int initialBufferSize, final File outputFile) {
this(threshold, outputFile, null, null, null, initialBufferSize);
if (initialBufferSize < 0) {
- throw new IllegalArgumentException("Initial buffer size must be atleast 0.");
+ throw new IllegalArgumentException("Initial buffer size must be at least 0.");
}
}
@@ -143,7 +143,7 @@ public class DeferredFileOutputStream extends ThresholdingOutputStream {
this(threshold, null, prefix, suffix, directory, initialBufferSize);
Objects.requireNonNull("prefix", prefix);
if (initialBufferSize < 0) {
- throw new IllegalArgumentException("Initial buffer size must be atleast 0.");
+ throw new IllegalArgumentException("Initial buffer size must be at least 0.");
}
}
diff --git a/src/site/xdoc/bestpractices.xml b/src/site/xdoc/bestpractices.xml
index 94206032..eb1a61e5 100644
--- a/src/site/xdoc/bestpractices.xml
+++ b/src/site/xdoc/bestpractices.xml
@@ -98,9 +98,9 @@ limitations under the License.
<section name="Buffering streams">
<p>
- IO performance depends a lot from the buffering strategy. Usually, it's
+ IO performance depends a lot on the buffering strategy. Usually, it's
quite fast to read packets with the size of 512 or 1024 bytes because
- these sizes match well with the packet sizes used on harddisks in
+ these sizes match well with the packet sizes used on hard disks in
file systems or file system caches. But as soon as you have to read only
a few bytes and that many times performance drops significantly.
</p>
diff --git a/src/site/xdoc/description.xml b/src/site/xdoc/description.xml
index 0ddccca9..828f4240 100644
--- a/src/site/xdoc/description.xml
+++ b/src/site/xdoc/description.xml
@@ -48,7 +48,7 @@ limitations under the License.
</p>
<p>
As an example, consider the task of reading bytes
- from a URL, and printing them. This would typically done like this:
+ from a URL, and printing them. This would typically be done like this:
</p>
<source>
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
index e8e020fd..36189d55 100644
--- a/src/site/xdoc/mail-lists.xml
+++ b/src/site/xdoc/mail-lists.xml
@@ -158,7 +158,7 @@ limitations under the License.
<td>
<strong>Commons Commits List</strong>
<br /><br />
- Only for e-mails automatically generated by the <a href="scm.html">source control</a> sytem.
+ Only for e-mails automatically generated by the <a href="scm.html">source control</a> system.
<br /><br />
</td>
<td><a href="mailto:commits-subscribe@commons.apache.org">Subscribe</a></td>
diff --git a/src/site/xdoc/upgradeto1_1.xml b/src/site/xdoc/upgradeto1_1.xml
index e48e36a5..5920adf0 100644
--- a/src/site/xdoc/upgradeto1_1.xml
+++ b/src/site/xdoc/upgradeto1_1.xml
@@ -47,7 +47,7 @@ Semantic compatible - Yes, except:
Generally this will make no difference
- LockableFileWriter
- Improved validation and now create directories if necesssary
+ Improved validation and now create directories if necessary
plus these bug fixes may affect you semantically:
- FileUtils.touch() (Bug fix 29821)
@@ -121,7 +121,7 @@ Enhancements from 1.0
- IOUtils - toCharArray(InputStream) [28979]
- toCharArray(InputStream,encoding)
- toCharArray(Reader)
- Reads a stream/reader into a charatcter array
+ Reads a stream/reader into a character array
- IOUtils - readLines(InputStream) [36214]
- readLines(InputStream,encoding)
@@ -195,7 +195,7 @@ Enhancements from 1.0
- LockableFileWriter - encoding support [36825]
Add support for character encodings to LockableFileWriter
Improve the validation
- Create directories if necesssary
+ Create directories if necessary
- IOUtils and EndianUtils are no longer final [28978]
Allows developers to have subclasses if desired
diff --git a/src/site/xdoc/upgradeto1_2.xml b/src/site/xdoc/upgradeto1_2.xml
index 67b45d3a..a38e89d6 100644
--- a/src/site/xdoc/upgradeto1_2.xml
+++ b/src/site/xdoc/upgradeto1_2.xml
@@ -64,7 +64,7 @@ Bug fixes from 1.1
Enhancements from 1.1
---------------------
- AgeFileFilter/SizeFileFilter
- New file filters that compares against the age and size of the file
+ New file filters that compare against the age and size of the file
- FileSystemUtils.freeSpaceKb(drive)
New method that unifies result to be in kilobytes [38574]
diff --git a/src/site/xdoc/upgradeto1_3.xml b/src/site/xdoc/upgradeto1_3.xml
index bd413a9f..91a18088 100644
--- a/src/site/xdoc/upgradeto1_3.xml
+++ b/src/site/xdoc/upgradeto1_3.xml
@@ -88,12 +88,12 @@ Bug fixes from 1.2
- IOUtils.copy [IO-84]
- Copy methods could return inaccurate byte/char count for large streams
- The copy(InputStream, OutputStream) method now returns -1 if the count is greater than an int
- - The copy(Reader, Writer) method now throws now returns -1 if the count is greater than an int
+ - The copy(Reader, Writer) method now returns -1 if the count is greater than an int
- Added a new copyLarge(InputStream, OutputStream) method that returns a long
- Added a new copyLarge(Reader, Writer) method that returns a long
- CountingInputStream/CountingOutputStream [IO-84]
- - Methods were declared as int thus the count was innacurate for large streams
+ - Methods were declared as int thus the count was inaccurate for large streams
- new long based methods getByteCount()/resetByteCount() added
- existing methods changed to throw an exception if the count is greater than an int
@@ -154,7 +154,7 @@ Enhancements from 1.2
- FileDeleteStrategy
- FileCleaner [IO-56,IO-70]
- FileDeleteStrategy is a strategy for handling file deletion
- - This can be used as a calback in FileCleaner
+ - This can be used as a callback in FileCleaner
- Together these allow FileCleaner to do a forceDelete to kill directories
- FileCleaner.exitWhenFinished [IO-99]
diff --git a/src/site/xdoc/upgradeto1_4.xml b/src/site/xdoc/upgradeto1_4.xml
index 7056de7a..ccc61104 100644
--- a/src/site/xdoc/upgradeto1_4.xml
+++ b/src/site/xdoc/upgradeto1_4.xml
@@ -89,7 +89,7 @@ Enhancements from 1.3.2
- Add new Reader implementation that handles any CharSequence (String,
StringBuffer, StringBuilder or CharBuffer)
-- ThesholdingOuputStream [IO-121]
+- ThresholdingOutputStream [IO-121]
- Add a reset() method which sets the count of the bytes written back to zero.
- DeferredFileOutputStream [IO-130]
@@ -108,10 +108,10 @@ Enhancements from 1.3.2
- Add Singleton Constants to several stream classes [IO-143]
- PrefixFileFilter [IO-126]
- - Add faciltiy to specify case sensitivity on prefix matching
+ - Add facility to specify case sensitivity on prefix matching
- SuffixFileFilter [IO-126]
- - Add faciltiy to specify case sensitivity on suffix matching
+ - Add facility to specify case sensitivity on suffix matching
- RegexFileFilter [IO-74]
- Add new regular expression file filter implementation
diff --git a/src/site/xdoc/upgradeto2_0.xml b/src/site/xdoc/upgradeto2_0.xml
index 3a9dd0aa..7f21cc09 100644
--- a/src/site/xdoc/upgradeto2_0.xml
+++ b/src/site/xdoc/upgradeto2_0.xml
@@ -126,7 +126,7 @@ Bug fixes from 1.4
* [IO-207] FileUtils - fix race condition in forceMkdir() method
* [IO-217] FileUtils - fix copyDirectoryToDirectory() makes infinite loops
* [IO-166] FileUtils - fix URL decoding in toFile(URL)
- * [IO-190] FileUtils - fix copyDirectory not preserving lastmodified date on sub-directories
+ * [IO-190] FileUtils - fix copyDirectory not preserving lastmodified date on subdirectories
* [IO-240] FileFilterUtils - ensure cvsFilter and svnFilter are only created once.
* [IO-175] IOUtils - fix copyFile() issues with very large files
* [IO-191] Improvements from static analysis
diff --git a/src/site/xdoc/upgradeto2_5.xml b/src/site/xdoc/upgradeto2_5.xml
index 52838ead..b8eb402b 100644
--- a/src/site/xdoc/upgradeto2_5.xml
+++ b/src/site/xdoc/upgradeto2_5.xml
@@ -92,7 +92,7 @@ limitations under the License.
o IO-389: FileUtils.sizeOfDirectory can throw IllegalArgumentException Thanks to Austin Doupnik.
o IO-390: FileUtils.sizeOfDirectoryAsBigInteger can overflow.
Ensure that recursive calls all use BigInteger
- o IO-385: FileUtils.doCopyFile can potentially loop for ever
+ o IO-385: FileUtils.doCopyFile can potentially loop forever
Exit loop if no data to copy
o IO-383: FileUtils.doCopyFile caches the file size; needs to be documented
Added Javadoc; show file lengths in exception message
@@ -107,7 +107,7 @@ limitations under the License.
o IO-354: Commons IO Tailer does not respect UTF-8 Charset.
o IO-323: What should happen in FileUtils.sizeOf[Directory] when an overflow takes place?
Added Javadoc.
- o IO-372: FileUtils.moveDirectory can produce misleading error message on failiure
+ o IO-372: FileUtils.moveDirectory can produce misleading error message on failure
o IO-362: IOUtils.contentEquals* methods returns false if input1 == input2, should return true. Thanks to mmadson, ggregory.
o IO-357: [Tailer] InterruptedException while the thread is sleeping is silently ignored Thanks to mortenh.
o IO-352: Spelling fixes. Thanks to scop.
diff --git a/src/test/java/org/apache/commons/io/DeleteDirectoryTest.java b/src/test/java/org/apache/commons/io/DeleteDirectoryTest.java
index 871bb75a..aaffbbe8 100644
--- a/src/test/java/org/apache/commons/io/DeleteDirectoryTest.java
+++ b/src/test/java/org/apache/commons/io/DeleteDirectoryTest.java
@@ -40,7 +40,7 @@ import org.junit.jupiter.api.condition.OS;
/**
* Tests <a href="https://issues.apache.org/jira/browse/IO-751">IO-751</a>.
* <p>
- * Must be run on a POSIX file system, macOS or Linux, disbled on Windows.
+ * Must be run on a POSIX file system, macOS or Linux, disabled on Windows.
* </p>
*/
@DisabledOnOs(OS.WINDOWS)
diff --git a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
index f6524aee..5fc0b1b9 100644
--- a/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
+++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTest.java
@@ -249,11 +249,11 @@ public class DirectoryWalkerTest {
private static final IOFileFilter dirsFilter = createNameFilter(dirs);
- private static final IOFileFilter iofilesFilter = createNameFilter(ioFiles);
+ private static final IOFileFilter ioFilesFilter = createNameFilter(ioFiles);
private static final IOFileFilter outputFilesFilter = createNameFilter(outputFiles);
- private static final IOFileFilter ioDirAndFilesFilter = dirsFilter.or(iofilesFilter);
+ private static final IOFileFilter ioDirAndFilesFilter = dirsFilter.or(ioFilesFilter);
private static final IOFileFilter dirsAndFilesFilter = ioDirAndFilesFilter.or(outputFilesFilter);
@@ -421,7 +421,7 @@ public class DirectoryWalkerTest {
*/
@Test
public void testFilterDirAndFile1() {
- final List<File> results = new TestFileFinder(dirsFilter, iofilesFilter, -1).find(javaDir);
+ final List<File> results = new TestFileFinder(dirsFilter, ioFilesFilter, -1).find(javaDir);
assertEquals(1 + dirs.length + ioFiles.length, results.size(), "[DirAndFile1] Result Size");
assertTrue(results.contains(javaDir), "[DirAndFile1] Start Dir");
checkContainsFiles("[DirAndFile1] Dir", dirs, results);
@@ -457,7 +457,7 @@ public class DirectoryWalkerTest {
*/
@Test
public void testFilterDirAndFile4() {
- final List<File> results = new TestFileFinder(null, iofilesFilter, -1).find(javaDir);
+ final List<File> results = new TestFileFinder(null, ioFilesFilter, -1).find(javaDir);
final List<File> resultFiles = filesOnly(results);
assertEquals(ioFiles.length, resultFiles.size(), "[DirAndFile4] Result Size");
assertTrue(results.contains(javaDir), "[DirAndFile4] Start Dir");
diff --git a/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java b/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
index 46d2bf4a..f55699ad 100644
--- a/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
+++ b/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
@@ -247,12 +247,12 @@ public class DirectoryWalkerTestCaseJava4 {
// Filters
private static final IOFileFilter dirsFilter = createNameFilter(dirs);
- private static final IOFileFilter iofilesFilter = createNameFilter(ioFiles);
+ private static final IOFileFilter ioFilesFilter = createNameFilter(ioFiles);
private static final IOFileFilter outputFilesFilter = createNameFilter(outputFiles);
- private static final IOFileFilter ioDirAndFilesFilter = new OrFileFilter(dirsFilter, iofilesFilter);
+ private static final IOFileFilter ioDirAndFilesFilter = new OrFileFilter(dirsFilter, ioFilesFilter);
private static final IOFileFilter dirsAndFilesFilter = new OrFileFilter(ioDirAndFilesFilter, outputFilesFilter);
@@ -406,7 +406,7 @@ public class DirectoryWalkerTestCaseJava4 {
*/
@Test
public void testFilterDirAndFile1() {
- final List<File> results = new TestFileFinder(dirsFilter, iofilesFilter, -1).find(javaDir);
+ final List<File> results = new TestFileFinder(dirsFilter, ioFilesFilter, -1).find(javaDir);
assertEquals(1 + dirs.length + ioFiles.length, results.size(), "[DirAndFile1] Result Size");
assertTrue(results.contains(javaDir), "[DirAndFile1] Start Dir");
checkContainsFiles("[DirAndFile1] Dir", dirs, results);
@@ -442,7 +442,7 @@ public class DirectoryWalkerTestCaseJava4 {
*/
@Test
public void testFilterDirAndFile4() {
- final List<File> results = new TestFileFinder(null, iofilesFilter, -1).find(javaDir);
+ final List<File> results = new TestFileFinder(null, ioFilesFilter, -1).find(javaDir);
final List resultFiles = filesOnly(results);
assertEquals(ioFiles.length, resultFiles.size(), "[DirAndFile4] Result Size");
assertTrue(results.contains(javaDir), "[DirAndFile4] Start Dir");
diff --git a/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java b/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java
index 642c9a80..4d936cd5 100644
--- a/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java
+++ b/src/test/java/org/apache/commons/io/FileSystemUtilsTest.java
@@ -98,7 +98,7 @@ public class FileSystemUtilsTest {
public void testGetFreeSpace_String() throws Exception {
// test coverage, as we can't check value
if (File.separatorChar == '/') {
- // have to figure out unix block size
+ // have to figure out Unix block size
final String[] cmd;
String osName = System.getProperty("os.name");
osName = osName.toLowerCase(Locale.ENGLISH);
@@ -126,7 +126,7 @@ public class FileSystemUtilsTest {
final long kb = FileSystemUtils.freeSpaceKb("/");
// Assume disk space does not fluctuate
// more than 1% between the above two calls;
- // this also also small enough to verify freeSpaceKb uses
+ // this is also small enough to verify freeSpaceKb uses
// kibibytes (1024) instead of SI kilobytes (1000)
final double acceptableDelta = kb * 0.01d;
if (kilobyteBlock) {
diff --git a/src/test/java/org/apache/commons/io/FileUtilsCleanDirectoryTest.java b/src/test/java/org/apache/commons/io/FileUtilsCleanDirectoryTest.java
index 04ea31fe..2a0afc7c 100644
--- a/src/test/java/org/apache/commons/io/FileUtilsCleanDirectoryTest.java
+++ b/src/test/java/org/apache/commons/io/FileUtilsCleanDirectoryTest.java
@@ -116,7 +116,7 @@ public class FileUtilsCleanDirectoryTest extends AbstractTempDirTest {
@DisabledOnOs(OS.WINDOWS)
@Test
public void testThrowsOnNullList() throws Exception {
- // test wont work if we can't restrict permissions on the
+ // test won't work if we can't restrict permissions on the
// directory, so skip it.
assumeTrue(chmod(tempDirFile, 0, false));
diff --git a/src/test/java/org/apache/commons/io/FileUtilsCopyDirectoryToDirectoryTest.java b/src/test/java/org/apache/commons/io/FileUtilsCopyDirectoryToDirectoryTest.java
index 5102f261..6bc2223e 100644
--- a/src/test/java/org/apache/commons/io/FileUtilsCopyDirectoryToDirectoryTest.java
+++ b/src/test/java/org/apache/commons/io/FileUtilsCopyDirectoryToDirectoryTest.java
@@ -74,7 +74,7 @@ public class FileUtilsCopyDirectoryToDirectoryTest {
@Test
public void copyDirectoryToDirectoryThrowsIllegalExceptionWithCorrectMessageWhenSrcDirIsNotDirectory()
throws IOException {
- try (TempFile srcDir = TempFile.create("notadireotry", null)) {
+ try (TempFile srcDir = TempFile.create("notadirectory", null)) {
final File destDir = new File(temporaryFolder, "destinationDirectory");
destDir.mkdirs();
final String expectedMessage = String.format("Parameter 'sourceDir' is not a directory: '%s'", srcDir);
diff --git a/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java b/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java
index 26fb2703..315d097e 100644
--- a/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java
+++ b/src/test/java/org/apache/commons/io/FileUtilsDeleteDirectoryLinuxTest.java
@@ -100,7 +100,7 @@ public class FileUtilsDeleteDirectoryLinuxTest extends FileUtilsDeleteDirectoryB
final File nested = new File(top, "nested");
assertTrue(nested.mkdirs());
- // test wont work if we can't restrict permissions on the
+ // test won't work if we can't restrict permissions on the
// directory, so skip it.
assumeTrue(chmod(nested, 0, false));
diff --git a/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java b/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
index 6a81fdae..6ce0e7df 100644
--- a/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
+++ b/src/test/java/org/apache/commons/io/IOUtilsCopyTest.java
@@ -72,10 +72,10 @@ public class IOUtilsCopyTest {
final InputStream in = IOUtils.copy(out);
final byte[] inData2 = new byte[FILE_SIZE];
- final int insize = in.read(inData2);
+ final int inSize = in.read(inData2);
assertEquals(0, in.available(), "Not all bytes were read");
- assertEquals(inData.length, insize, "Sizes differ");
+ assertEquals(inData.length, inSize, "Sizes differ");
assertArrayEquals(inData, inData2, "Content differs");
}
diff --git a/src/test/java/org/apache/commons/io/IOUtilsTest.java b/src/test/java/org/apache/commons/io/IOUtilsTest.java
index 5f7cb642..105dd00e 100644
--- a/src/test/java/org/apache/commons/io/IOUtilsTest.java
+++ b/src/test/java/org/apache/commons/io/IOUtilsTest.java
@@ -87,7 +87,7 @@ import org.junit.jupiter.api.io.TempDir;
* <li>The output stream must not have been closed (a byte/char is written to test this, and subsequent size
* checked)</li>
* </ul>
- * Due to interdependencies in IOUtils and IOUtilsTestlet, one bug may cause multiple tests to fail.
+ * Due to interdependencies in IOUtils and IOUtilsTest, one bug may cause multiple tests to fail.
*/
@SuppressWarnings("deprecation") // deliberately testing deprecated code
public class IOUtilsTest {
diff --git a/src/test/java/org/apache/commons/io/file/AccumulatorPathVisitorTest.java b/src/test/java/org/apache/commons/io/file/AccumulatorPathVisitorTest.java
index 06903a1e..69d0e5cd 100644
--- a/src/test/java/org/apache/commons/io/file/AccumulatorPathVisitorTest.java
+++ b/src/test/java/org/apache/commons/io/file/AccumulatorPathVisitorTest.java
@@ -133,7 +133,7 @@ public class AccumulatorPathVisitorTest {
}
/**
- * Tests IO-755 with a directory with 100 files, and delete all of them mid-way through the visit.
+ * Tests IO-755 with a directory with 100 files, and delete all of them midway through the visit.
*
* Random failure like:
*
@@ -192,7 +192,7 @@ public class AccumulatorPathVisitorTest {
}
/**
- * Tests IO-755 with a directory with 100 files, and delete all of them mid-way through the visit.
+ * Tests IO-755 with a directory with 100 files, and delete all of them midway through the visit.
*/
@ParameterizedTest
@MethodSource("testParametersIgnoreFailures")
diff --git a/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTest.java b/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTest.java
index b4ec8f4d..5009ec5d 100644
--- a/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTest.java
+++ b/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTest.java
@@ -96,7 +96,7 @@ public abstract class IOFileFilterAbstractTest {
}
public static void assertFilenameFiltering(final int testNumber, final IOFileFilter filter, final File file, final boolean expected) {
- // Assumes file has parent and is not passed as null
+ // Assumes file has a parent and is not passed as null
assertEquals(expected, filter.accept(file.getParentFile(), file.getName()),
"test " + testNumber + " Filter(File, String) " + filter.getClass().getName() + " not " + expected + " for " + file);
}
diff --git a/src/test/java/org/apache/commons/io/input/CharSequenceInputStreamTest.java b/src/test/java/org/apache/commons/io/input/CharSequenceInputStreamTest.java
index 2c6b370f..e7f47b32 100644
--- a/src/test/java/org/apache/commons/io/input/CharSequenceInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/CharSequenceInputStreamTest.java
@@ -80,7 +80,7 @@ public class CharSequenceInputStreamTest {
public void testAvailable() throws Exception {
for (final String csName : Charset.availableCharsets().keySet()) {
// prevent java.lang.UnsupportedOperationException at sun.nio.cs.ext.ISO2022_CN.newEncoder.
- // also try and avoid the following Effor on Continuum
+ // also try and avoid the following exception
// java.lang.UnsupportedOperationException: null
// at java.nio.CharBuffer.array(CharBuffer.java:940)
// at sun.nio.cs.ext.COMPOUND_TEXT_Encoder.encodeLoop(COMPOUND_TEXT_Encoder.java:75)
diff --git a/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java b/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
index be77df4d..2e8d0f53 100644
--- a/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/ClassLoaderObjectInputStreamTest.java
@@ -67,8 +67,8 @@ public class ClassLoaderObjectInputStreamTest {
@Override
public boolean equals(final Object other) {
if (other instanceof Test) {
- final Test tother = (Test) other;
- return this.i == tother.i & this.e == tother.e & equalObject(tother.o);
+ final Test tOther = (Test) other;
+ return this.i == tOther.i & this.e == tOther.e & equalObject(tOther.o);
}
return false;
}
diff --git a/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java b/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
index b4c6f423..a72e0f3c 100644
--- a/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/MarkShieldInputStreamTest.java
@@ -97,7 +97,7 @@ public class MarkShieldInputStreamTest {
}
@Test
- public void resetThrowsExceptionWhenUnderylingDoesNotSupport() throws IOException {
+ public void resetThrowsExceptionWhenUnderlyingDoesNotSupport() throws IOException {
// test wrapping an underlying stream which does NOT support marking
try (MarkShieldInputStream msis = new MarkShieldInputStream(
new NullInputStream(64, false, false))) {
@@ -106,7 +106,7 @@ public class MarkShieldInputStreamTest {
}
@Test
- public void resetThrowsExceptionWhenUnderylingSupports() throws IOException {
+ public void resetThrowsExceptionWhenUnderlyingSupports() throws IOException {
// test wrapping an underlying stream which supports marking
try (MarkShieldInputStream msis = new MarkShieldInputStream(
new NullInputStream(64, true, false))) {
diff --git a/src/test/java/org/apache/commons/io/input/StringInputStreamTest.java b/src/test/java/org/apache/commons/io/input/StringInputStreamTest.java
index 3be20412..66a0cb6c 100644
--- a/src/test/java/org/apache/commons/io/input/StringInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/StringInputStreamTest.java
@@ -32,14 +32,14 @@ import org.junit.jupiter.api.Test;
public class StringInputStreamTest {
@Test
- public void testStrinConstructorString() throws IOException {
+ public void testStringConstructorString() throws IOException {
try (StringInputStream input = StringInputStream.on("01")) {
assertEquals("01", IOUtils.toString(input, Charset.defaultCharset()));
}
}
@Test
- public void testStrinConstructorStringCharset() throws IOException {
+ public void testStringConstructorStringCharset() throws IOException {
try (StringInputStream input = new StringInputStream("01", Charset.defaultCharset())) {
assertEquals("01", IOUtils.toString(input, Charset.defaultCharset()));
}
diff --git a/src/test/java/org/apache/commons/io/input/WindowsLineEndingInputStreamTest.java b/src/test/java/org/apache/commons/io/input/WindowsLineEndingInputStreamTest.java
index 9ad0b57c..f643e6e7 100644
--- a/src/test/java/org/apache/commons/io/input/WindowsLineEndingInputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/input/WindowsLineEndingInputStreamTest.java
@@ -30,7 +30,7 @@ public class WindowsLineEndingInputStreamTest {
}
@Test
- public void linuxLinefeeds() throws Exception {
+ public void linuxLineFeeds() throws Exception {
final String roundtrip = roundtrip("ab\nc", false);
assertEquals("ab\r\nc", roundtrip);
}
@@ -72,4 +72,4 @@ public class WindowsLineEndingInputStreamTest {
public void twoLinesAtEnd() throws Exception {
assertEquals("a\r\n\r\n", roundtrip("a\r\n\r\n"));
}
-}
\ No newline at end of file
+}
diff --git a/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java b/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
index 08f8df86..4acb4d9b 100644
--- a/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
+++ b/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
@@ -297,10 +297,10 @@ public class XmlStreamReaderTest {
}
protected void testHttpLenient(final String cT, final String bomEnc, final String streamEnc,
- final String prologEnc, final String shouldbe) throws Exception {
+ final String prologEnc, final String shouldBe) throws Exception {
try (InputStream is = getXmlInputStream(bomEnc, prologEnc == null ? XML2 : XML3, streamEnc, prologEnc);
XmlStreamReader xmlReader = new XmlStreamReader(is, cT, true)) {
- assertEquals(xmlReader.getEncoding(), shouldbe);
+ assertEquals(xmlReader.getEncoding(), shouldBe);
}
}
@@ -319,7 +319,7 @@ public class XmlStreamReaderTest {
}
}
- // Turkish language has specific rules to convert dotted and dottless i character.
+ // Turkish language has specific rules to convert dotted and dotless i character.
@Test
@DefaultLocale(language = "tr")
public void testLowerCaseEncodingWithTurkishLocale_IO_557() throws Exception {
diff --git a/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java b/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java
index 9379d679..11eacbf1 100644
--- a/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/io/output/ChunkedOutputStreamTest.java
@@ -40,7 +40,7 @@ public class ChunkedOutputStreamTest {
}
@Test
- public void negative_chunksize_not_permitted() {
+ public void negative_chunkSize_not_permitted() {
assertThrows(IllegalArgumentException.class, () -> new ChunkedOutputStream(new ByteArrayOutputStream(), 0));
}
diff --git a/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java b/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java
index 339dd1b7..96e89ae1 100644
--- a/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/ChunkedWriterTest.java
@@ -38,7 +38,7 @@ public class ChunkedWriterTest {
}
@Test
- public void negative_chunksize_not_permitted() {
+ public void negative_chunkSize_not_permitted() {
assertThrows(IllegalArgumentException.class,
() -> new ChunkedWriter(new OutputStreamWriter(new ByteArrayOutputStream()), 0));
}
diff --git a/src/test/java/org/apache/commons/io/output/XmlStreamWriterTest.java b/src/test/java/org/apache/commons/io/output/XmlStreamWriterTest.java
index bd7a7201..4f4e126c 100644
--- a/src/test/java/org/apache/commons/io/output/XmlStreamWriterTest.java
+++ b/src/test/java/org/apache/commons/io/output/XmlStreamWriterTest.java
@@ -131,7 +131,7 @@ public class XmlStreamWriterTest {
checkXmlWriter(TEXT_LATIN7, "ISO-8859-7");
}
- /** Turkish language has specific rules to convert dotted and dottless i character. */
+ /** Turkish language has specific rules to convert dotted and dotless i character. */
@Test
@DefaultLocale(language = "tr")
public void testLowerCaseEncodingWithTurkishLocale_IO_557() throws IOException {
diff --git a/src/test/java/org/apache/commons/io/test/ThrowOnCloseInputStream.java b/src/test/java/org/apache/commons/io/test/ThrowOnCloseInputStream.java
index a0d77953..5a123796 100644
--- a/src/test/java/org/apache/commons/io/test/ThrowOnCloseInputStream.java
+++ b/src/test/java/org/apache/commons/io/test/ThrowOnCloseInputStream.java
@@ -28,7 +28,7 @@ import org.apache.commons.io.input.ProxyInputStream;
public class ThrowOnCloseInputStream extends ProxyInputStream {
/**
- * Defaultconstructor.
+ * Default constructor.
*/
public ThrowOnCloseInputStream() {
super(NullInputStream.INSTANCE);
diff --git a/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java b/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
index 467b27a8..d85a2c3b 100644
--- a/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
+++ b/src/test/java/org/apache/commons/io/test/ThrowOnCloseOutputStream.java
@@ -28,7 +28,7 @@ import org.apache.commons.io.output.ProxyOutputStream;
public class ThrowOnCloseOutputStream extends ProxyOutputStream {
/**
- * Defaultconstructor.
+ * Default constructor.
*/
public ThrowOnCloseOutputStream() {
super(NullOutputStream.INSTANCE);
diff --git a/src/test/java/org/apache/commons/io/test/ThrowOnCloseReader.java b/src/test/java/org/apache/commons/io/test/ThrowOnCloseReader.java
index 747d23ec..855d3da0 100644
--- a/src/test/java/org/apache/commons/io/test/ThrowOnCloseReader.java
+++ b/src/test/java/org/apache/commons/io/test/ThrowOnCloseReader.java
@@ -28,7 +28,7 @@ import org.apache.commons.io.input.ProxyReader;
public class ThrowOnCloseReader extends ProxyReader {
/**
- * Defaultconstructor.
+ * Default constructor.
*/
public ThrowOnCloseReader() {
super(NullReader.INSTANCE);
diff --git a/src/test/java/org/apache/commons/io/test/ThrowOnCloseWriter.java b/src/test/java/org/apache/commons/io/test/ThrowOnCloseWriter.java
index d5f37736..307f1b0a 100644
--- a/src/test/java/org/apache/commons/io/test/ThrowOnCloseWriter.java
+++ b/src/test/java/org/apache/commons/io/test/ThrowOnCloseWriter.java
@@ -28,7 +28,7 @@ import org.apache.commons.io.output.ProxyWriter;
public class ThrowOnCloseWriter extends ProxyWriter {
/**
- * Defaultconstructor.
+ * Default constructor.
*/
public ThrowOnCloseWriter() {
super(NullWriter.INSTANCE);