Fix Typos in JavaDoc, Comments and Tests (#201)

* Fixed incorrect/missing JavaDoc.

* Fixed misc. typos in comments and tests.

* Fixed typos in exception messages.

Author: RillingDev

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

@@ -2192,7 +2192,7 @@ public static Collection<File> listFilesAndDirs(
      * @throws IOException if the directory was not created along with all its parent directories.
      * @throws IOException if the given file object is not a directory.
      * @throws SecurityException See {@link File#mkdirs()}.
-     * @see @see File#mkdirs()
+     * @see File#mkdirs()
      */
     private static File mkdirs(final File directory) throws IOException {
         if (directory != null) {
@@ -2625,7 +2625,7 @@ private static void requireCanWrite(final File file, final String name) {
      * Requires that the given {@code File} is a directory.
      *
      * @param directory The {@code File} to check.
-     * @param name
+     * @param name The parameter name to use in the exception message in case of null input or if the file is not a directory.
      * @return the given directory.
      * @throws NullPointerException if the given {@code File} is {@code null}.
      * @throws IllegalArgumentException if the given {@code File} does not exist or is not a directory.
@@ -3052,7 +3052,7 @@ private static int toMaxDepth(final boolean recursive) {
      *
      * @param extensions an array of extensions. Format: {"java", "xml"}
      * @return an array of suffixes. Format: {".java", ".xml"}
-     * @throws NullPointerException
+     * @throws NullPointerException if the parameter is null
      */
     private static String[] toSuffixes(final String... extensions) {
         Objects.requireNonNull(extensions, "extensions");

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

@@ -1430,7 +1430,7 @@ public static boolean wildcardMatch(final String fileName, final String wildcard
                     } else {
                         // matching from current position
                         if (!caseSensitivity.checkRegionMatches(fileName, textIdx, wcs[wcsIdx])) {
-                            // couldnt match token
+                            // couldn't match token
                             break;
                         }
                     }

src/main/java/org/apache/commons/io/input/XmlStreamReader.java

@@ -512,7 +512,7 @@ public XmlStreamReader(final URL url) throws IOException {
      *         the URLConnection.
      */
     public XmlStreamReader(final URLConnection conn, final String defaultEncoding) throws IOException {
-        Objects.requireNonNull(conn, "conm");
+        Objects.requireNonNull(conn, "conn");
         this.defaultEncoding = defaultEncoding;
         final boolean lenient = true;
         final String contentType = conn.getContentType();

src/main/java/org/apache/commons/io/output/AbstractByteArrayOutputStream.java

@@ -301,7 +301,7 @@ protected void writeToImpl(final OutputStream out) throws IOException {
      * @see #reset()
      * @since 2.7
      */
-    @SuppressWarnings("resource") // The result InputStream MUIST be managed by the call site.
+    @SuppressWarnings("resource") // The result InputStream MUST be managed by the call site.
     protected <T extends InputStream> InputStream toInputStream(
             final InputStreamConstructor<T> isConstructor) {
         int remaining = count;

src/main/java/org/apache/commons/io/output/WriterOutputStream.java

@@ -333,14 +333,14 @@ private static void checkIbmJdkWithBrokenUTF16(final Charset charset){
             try {
                 charsetDecoder2.decode(bb2, cb2, i == (len - 1));
             } catch ( final IllegalArgumentException e){
-                throw new UnsupportedOperationException("UTF-16 requested when runninng on an IBM JDK with broken UTF-16 support. " +
+                throw new UnsupportedOperationException("UTF-16 requested when running on an IBM JDK with broken UTF-16 support. " +
                         "Please find a JDK that supports UTF-16 if you intend to use UF-16 with WriterOutputStream");
             }
             bb2.compact();
         }
         cb2.rewind();
         if (!TEST_STRING_2.equals(cb2.toString())){
-            throw new UnsupportedOperationException("UTF-16 requested when runninng on an IBM JDK with broken UTF-16 support. " +
+            throw new UnsupportedOperationException("UTF-16 requested when running on an IBM JDK with broken UTF-16 support. " +
                     "Please find a JDK that supports UTF-16 if you intend to use UF-16 with WriterOutputStream");
         }
 

src/test/java/org/apache/commons/io/FileSystemUtilsTestCase.java

@@ -72,7 +72,7 @@ public void testGetFreeSpace_String() throws Exception {
             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 verifiy freeSpaceKb uses
+            // this also also small enough to verify freeSpaceKb uses
             // kibibytes (1024) instead of SI kilobytes (1000)
             final double acceptableDelta = kb * 0.01d;
             if (kilobyteBlock) {

src/test/java/org/apache/commons/io/FileUtilsDirectoryContainsTestCase.java

@@ -156,7 +156,7 @@ public void testFileDoesNotExistBug() throws IOException {
         final File file = new File(top, "DOESNOTEXIST");
         assertTrue(top.exists(), "Check directory exists");
         assertFalse(file.exists(), "Check file does not exist");
-        assertFalse(FileUtils.directoryContains(top, file), "Direcory does not contain unrealized file");
+        assertFalse(FileUtils.directoryContains(top, file), "Directory does not contain unrealized file");
     }
 
     @Test

src/test/java/org/apache/commons/io/input/BufferedFileChannelInputStreamTest.java

@@ -24,7 +24,7 @@
 /**
  * Tests functionality of {@link BufferedFileChannelInputStream}.
  *
- * This class was ported and adapted from Apache Spark commit 933dc6cb7b3de1d8ccaf73d124d6eb95b947ed19 wher it was
+ * This class was ported and adapted from Apache Spark commit 933dc6cb7b3de1d8ccaf73d124d6eb95b947ed19 where it was
  * called {@code BufferedFileChannelInputStreamSuite}.
  */
 public class BufferedFileChannelInputStreamTest extends AbstractInputStreamTest {

src/test/java/org/apache/commons/io/input/NullInputStreamTest.java

@@ -46,7 +46,7 @@ public void testRead() throws Exception {
         }
         assertEquals(0, input.available(), "Available after contents all read");
 
-        // Check availabale is zero after End of file
+        // Check available is zero after End of file
         assertEquals(-1, input.read(), "End of File");
         assertEquals(0, input.available(), "Available after End of File");
 

src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java

@@ -481,7 +481,7 @@ protected InputStream getXmlStream(final String bomType, final String xmlType,
         final String xmlDoc = getXML(bomType, xmlType, streamEnc, prologEnc);
         writer.write(xmlDoc);
 
-        // PADDDING TO TEST THINGS WORK BEYOND PUSHBACK_SIZE
+        // PADDING TO TEST THINGS WORK BEYOND PUSHBACK_SIZE
         writer.write("<da>\n");
         for (int i = 0; i < 10000; i++) {
             writer.write("<do/>\n");