Reuse StandardCharsets

Author: Gary Gregory

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

@@ -2134,7 +2134,7 @@ public static LineIterator lineIterator(final File file) throws IOException {
      * The recommended usage pattern is:
      * </p>
      * <pre>
-     * LineIterator it = FileUtils.lineIterator(file, "UTF-8");
+     * LineIterator it = FileUtils.lineIterator(file, StandardCharsets.UTF_8.name());
      * try {
      *   while (it.hasNext()) {
      *     String line = it.nextLine();

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

@@ -1726,7 +1726,7 @@ public static LineIterator lineIterator(final InputStream input, final Charset c
      * </p>
      * <pre>
      * try {
-     *   LineIterator it = IOUtils.lineIterator(stream, "UTF-8");
+     *   LineIterator it = IOUtils.lineIterator(stream, StandardCharsets.UTF_8.name());
      *   while (it.hasNext()) {
      *     String line = it.nextLine();
      *     /// do something with line

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

@@ -35,7 +35,7 @@
  * <p>
  * The recommended usage pattern is:
  * <pre>
- * LineIterator it = FileUtils.lineIterator(file, "UTF-8");
+ * LineIterator it = FileUtils.lineIterator(file, StandardCharsets.UTF_8.name());
  * try {
  *   while (it.hasNext()) {
  *     String line = it.nextLine();
@@ -64,8 +64,10 @@ public class LineIterator implements Iterator<String>, Closeable {
     public static void closeQuietly(final LineIterator iterator) {
         IOUtils.closeQuietly(iterator);
     }
+
     /** The reader that is being read. */
     private final BufferedReader bufferedReader;
+
     /** The current line. */
     private String cachedLine;
 

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

@@ -25,6 +25,7 @@
 import java.nio.charset.CharsetDecoder;
 import java.nio.charset.CoderResult;
 import java.nio.charset.CodingErrorAction;
+import java.nio.charset.StandardCharsets;
 
 import org.apache.commons.io.Charsets;
 import org.apache.commons.io.charset.CharsetDecoders;
@@ -83,7 +84,7 @@ public class WriterOutputStream extends OutputStream {
      * @param charset the charset to check the support for
      */
     private static void checkIbmJdkWithBrokenUTF16(final Charset charset){
-        if (!"UTF-16".equals(charset.name())) {
+        if (!StandardCharsets.UTF_16.name().equals(charset.name())) {
             return;
         }
         final String TEST_STRING_2 = "v\u00e9s";

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

@@ -99,7 +99,7 @@ public void copy_inputStreamToWriter() throws Exception {
     @Test
     public void copy_inputStreamToWriterWithEncoding() throws Exception {
         final String inDataStr = "data";
-        final String charsetName = "UTF-8";
+        final String charsetName = StandardCharsets.UTF_8.name();
         final StringWriter writer = new StringWriter();
         CopyUtils.copy(new StringInputStream(inDataStr, charsetName), writer, charsetName);
         assertEquals(inDataStr, writer.toString());
@@ -160,7 +160,7 @@ public void copy_stringToWriter() throws Exception {
     @Test
     public void testCopy_byteArrayToWriterWithEncoding() throws Exception {
         final String inDataStr = "data";
-        final String charsetName = "UTF-8";
+        final String charsetName = StandardCharsets.UTF_8.name();
         final StringWriter writer = new StringWriter();
         CopyUtils.copy(inDataStr.getBytes(charsetName), writer, charsetName);
         assertEquals(inDataStr, writer.toString());

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

@@ -89,6 +89,8 @@
 @SuppressWarnings({"deprecation", "ResultOfMethodCallIgnored"}) // unit tests include tests of many deprecated methods
 public class FileUtilsTest extends AbstractTempDirTest {
 
+    private static final String UTF_8 = StandardCharsets.UTF_8.name();
+
     /**
      * DirectoryWalker implementation that recursively lists all files and directories.
      */
@@ -1426,16 +1428,16 @@ public void testFileUtils() throws Exception {
 
         final File file2 = new File(tempDirFile, "test2.txt");
 
-        FileUtils.writeStringToFile(file2, filename, "UTF-8");
+        FileUtils.writeStringToFile(file2, filename, UTF_8);
         assertTrue(file2.exists());
         assertTrue(file2.length() > 0);
 
-        final String file2contents = FileUtils.readFileToString(file2, "UTF-8");
+        final String file2contents = FileUtils.readFileToString(file2, UTF_8);
         assertEquals(filename, file2contents, "Second file's contents correct");
 
         assertTrue(file2.delete());
 
-        final String contents = FileUtils.readFileToString(new File(filename), "UTF-8");
+        final String contents = FileUtils.readFileToString(new File(filename), UTF_8);
         assertEquals("This is a test", contents, "FileUtils.fileRead()");
 
     }
@@ -2480,7 +2482,7 @@ public void testReadLines() throws Exception {
             final String[] data = {"hello", "/u1234", "", "this is", "some text"};
             TestUtils.createLineBasedFile(file, data);
 
-            final List<String> lines = FileUtils.readLines(file, "UTF-8");
+            final List<String> lines = FileUtils.readLines(file, UTF_8);
             assertEquals(Arrays.asList(data), lines);
         } finally {
             TestUtils.deleteFile(file);

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

@@ -92,6 +92,8 @@
 @SuppressWarnings("deprecation") // deliberately testing deprecated code
 public class IOUtilsTest {
 
+    private static final String UTF_8 = StandardCharsets.UTF_8.name();
+
     private static final int FILE_SIZE = 1024 * 4 + 1;
 
     /** Determine if this is windows. */
@@ -1028,7 +1030,7 @@ public void testReadLines_InputStream_String() throws Exception {
             TestUtils.createLineBasedFile(file, data);
 
             in = Files.newInputStream(file.toPath());
-            final List<String> lines = IOUtils.readLines(in, "UTF-8");
+            final List<String> lines = IOUtils.readLines(in, UTF_8);
             assertEquals(Arrays.asList(data), lines);
             assertEquals(-1, in.read());
         } finally {
@@ -1449,7 +1451,7 @@ public void testToByteArray_InputStream_SizeZero() throws Exception {
 
     @Test
     public void testToByteArray_Reader() throws IOException {
-        final String charsetName = "UTF-8";
+        final String charsetName = UTF_8;
         final byte[] expecteds = charsetName.getBytes(charsetName);
         byte[] actuals = IOUtils.toByteArray(new InputStreamReader(new ByteArrayInputStream(expecteds)));
         assertArrayEquals(expecteds, actuals);
@@ -1505,7 +1507,7 @@ public void testToCharArray_InputStream() throws Exception {
     @Test
     public void testToCharArray_InputStream_CharsetName() throws Exception {
         try (InputStream fin = Files.newInputStream(testFilePath)) {
-            final char[] out = IOUtils.toCharArray(fin, "UTF-8");
+            final char[] out = IOUtils.toCharArray(fin, UTF_8);
             assertNotNull(out);
             assertEquals(0, fin.available(), "Not all chars were read");
             assertEquals(FILE_SIZE, out.length, "Wrong output size");
@@ -1539,7 +1541,7 @@ public void testToInputStream_CharSequence() throws Exception {
         inStream = IOUtils.toInputStream(csq, (String) null);
         bytes = IOUtils.toByteArray(inStream);
         assertEqualContent(csq.toString().getBytes(), bytes);
-        inStream = IOUtils.toInputStream(csq, "UTF-8");
+        inStream = IOUtils.toInputStream(csq, UTF_8);
         bytes = IOUtils.toByteArray(inStream);
         assertEqualContent(csq.toString().getBytes(StandardCharsets.UTF_8), bytes);
     }
@@ -1560,7 +1562,7 @@ public void testToInputStream_String() throws Exception {
         inStream = IOUtils.toInputStream(str, (String) null);
         bytes = IOUtils.toByteArray(inStream);
         assertEqualContent(str.getBytes(), bytes);
-        inStream = IOUtils.toInputStream(str, "UTF-8");
+        inStream = IOUtils.toInputStream(str, UTF_8);
         bytes = IOUtils.toByteArray(inStream);
         assertEqualContent(str.getBytes(StandardCharsets.UTF_8), bytes);
     }

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

@@ -543,13 +543,13 @@ public void testWriteLines_OutputStream_Encoding() throws Exception {
         final ByteArrayOutputStream baout = new ByteArrayOutputStream();
         final ThrowOnFlushAndCloseOutputStream out = new ThrowOnFlushAndCloseOutputStream(baout, false, true);
 
-        IOUtils.writeLines(list, "*", out, "UTF-8");
+        IOUtils.writeLines(list, "*", out, StandardCharsets.UTF_8.name());
 
         out.off();
         out.flush();
 
         final String expected = "hello\u8364*world**this is**some text*";
-        final String actual = baout.toString("UTF-8");
+        final String actual = baout.toString(StandardCharsets.UTF_8.name());
         assertEquals(expected, actual);
     }
 

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

@@ -27,6 +27,7 @@
 import java.io.IOException;
 import java.io.Reader;
 import java.io.StringReader;
+import java.nio.charset.StandardCharsets;
 import java.nio.charset.UnsupportedCharsetException;
 import java.nio.file.Files;
 import java.nio.file.NoSuchFileException;
@@ -42,6 +43,8 @@
  */
 public class LineIteratorTest {
 
+    private static final String UTF_8 = StandardCharsets.UTF_8.name();
+
     @TempDir
     public File temporaryFolder;
 
@@ -108,7 +111,7 @@ private List<String> createStringLines(final int lineCount) {
      * @throws IOException If an I/O error occurs while creating the file
      */
     private void doTestFileWithSpecifiedLines(final int lineCount) throws IOException {
-        final String encoding = "UTF-8";
+        final String encoding = UTF_8;
 
         final String fileName = "LineIterator-" + lineCount + "-test.txt";
         final File testFile = new File(temporaryFolder, fileName);
@@ -134,7 +137,7 @@ private void doTestFileWithSpecifiedLines(final int lineCount) throws IOExceptio
 
     @Test
     public void testCloseEarly() throws Exception {
-        final String encoding = "UTF-8";
+        final String encoding = UTF_8;
 
         final File testFile = new File(temporaryFolder, "LineIterator-closeEarly.txt");
         createLinesFile(testFile, encoding, 3);
@@ -195,7 +198,7 @@ protected boolean isValidLine(final String line) {
 
     @Test
     public void testFilteringBufferedReader() throws Exception {
-        final String encoding = "UTF-8";
+        final String encoding = UTF_8;
 
         final String fileName = "LineIterator-Filter-test.txt";
         final File testFile = new File(temporaryFolder, fileName);
@@ -207,7 +210,7 @@ public void testFilteringBufferedReader() throws Exception {
 
     @Test
     public void testFilteringFileReader() throws Exception {
-        final String encoding = "UTF-8";
+        final String encoding = UTF_8;
 
         final String fileName = "LineIterator-Filter-test.txt";
         final File testFile = new File(temporaryFolder, fileName);
@@ -222,15 +225,15 @@ public void testInvalidEncoding() throws Exception {
         final String encoding = "XXXXXXXX";
 
         final File testFile = new File(temporaryFolder, "LineIterator-invalidEncoding.txt");
-        createLinesFile(testFile, "UTF-8", 3);
+        createLinesFile(testFile, UTF_8, 3);
 
         assertThrows(UnsupportedCharsetException.class, () -> FileUtils.lineIterator(testFile, encoding));
     }
 
     @Test
     public void testMissingFile() throws Exception {
         final File testFile = new File(temporaryFolder, "dummy-missing-file.txt");
-        assertThrows(NoSuchFileException.class, () -> FileUtils.lineIterator(testFile, "UTF-8"));
+        assertThrows(NoSuchFileException.class, () -> FileUtils.lineIterator(testFile, UTF_8));
     }
 
     @Test
@@ -255,7 +258,7 @@ public void testNextLineOnlyNullEncoding() throws Exception {
 
     @Test
     public void testNextLineOnlyUtf8Encoding() throws Exception {
-        final String encoding = "UTF-8";
+        final String encoding = UTF_8;
 
         final File testFile = new File(temporaryFolder, "LineIterator-nextOnly.txt");
         final List<String> lines = createLinesFile(testFile, encoding, 3);
@@ -310,7 +313,7 @@ public void testTwoLines() throws Exception {
 
     @Test
     public void testValidEncoding() throws Exception {
-        final String encoding = "UTF-8";
+        final String encoding = UTF_8;
 
         final File testFile = new File(temporaryFolder, "LineIterator-validEncoding.txt");
         createLinesFile(testFile, encoding, 3);

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

@@ -36,6 +36,8 @@
 
 public class CharSequenceInputStreamTest {
 
+    private static final String UTF_16 = StandardCharsets.UTF_16.name();
+    private static final String UTF_8 = StandardCharsets.UTF_8.name();
     private static final String ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
     private static final String LARGE_TEST_STRING;
 
@@ -172,7 +174,7 @@ public void testBufferedRead_RequiredCharset() throws IOException {
 
     @Test
     public void testBufferedRead_UTF8() throws IOException {
-        testBufferedRead(TEST_STRING, "UTF-8");
+        testBufferedRead(TEST_STRING, UTF_8);
     }
 
     private void testCharsetMismatchInfiniteLoop(final String csName) throws IOException {
@@ -222,37 +224,37 @@ private void testIO_356(final int bufferSize, final int dataSize, final int read
 
     @Test
     public void testIO_356_B10_D10_S0_UTF16() throws Exception {
-        testIO_356(10, 10, 0, "UTF-16");
+        testIO_356(10, 10, 0, UTF_16);
     }
 
     @Test
     public void testIO_356_B10_D10_S0_UTF8() throws Exception {
-        testIO_356(10, 10, 0, "UTF-8");
+        testIO_356(10, 10, 0, UTF_8);
     }
 
     @Test
     public void testIO_356_B10_D10_S1_UTF8() throws Exception {
-        testIO_356(10, 10, 1, "UTF-8");
+        testIO_356(10, 10, 1, UTF_8);
     }
 
     @Test
     public void testIO_356_B10_D10_S2_UTF8() throws Exception {
-        testIO_356(10, 10, 2, "UTF-8");
+        testIO_356(10, 10, 2, UTF_8);
     }
 
     @Test
     public void testIO_356_B10_D13_S0_UTF8() throws Exception {
-        testIO_356(10, 13, 0, "UTF-8");
+        testIO_356(10, 13, 0, UTF_8);
     }
 
     @Test
     public void testIO_356_B10_D13_S1_UTF8() throws Exception {
-        testIO_356(10, 13, 1, "UTF-8");
+        testIO_356(10, 13, 1, UTF_8);
     }
 
     @Test
     public void testIO_356_B10_D20_S0_UTF8() throws Exception {
-        testIO_356(10, 20, 0, "UTF-8");
+        testIO_356(10, 20, 0, UTF_8);
     }
 
     private void testIO_356_Loop(final String csName, final int maxBytesPerChar) throws Exception {
@@ -284,7 +286,7 @@ public void testLargeBufferedRead_RequiredCharsets() throws IOException {
 
     @Test
     public void testLargeBufferedRead_UTF8() throws IOException {
-        testBufferedRead(LARGE_TEST_STRING, "UTF-8");
+        testBufferedRead(LARGE_TEST_STRING, UTF_8);
     }
 
     @Test
@@ -296,7 +298,7 @@ public void testLargeSingleByteRead_RequiredCharsets() throws IOException {
 
     @Test
     public void testLargeSingleByteRead_UTF8() throws IOException {
-        testSingleByteRead(LARGE_TEST_STRING, "UTF-8");
+        testSingleByteRead(LARGE_TEST_STRING, UTF_8);
     }
 
     // This test is broken for charsets that don't create a single byte for each char
@@ -331,12 +333,12 @@ public void testMarkReset_USASCII() throws Exception {
 
     @Test
     public void testMarkReset_UTF8() throws Exception {
-        testMarkReset("UTF-8");
+        testMarkReset(UTF_8);
     }
 
     @Test
     public void testMarkSupported() throws Exception {
-        try (InputStream r = new CharSequenceInputStream("test", "UTF-8")) {
+        try (InputStream r = new CharSequenceInputStream("test", UTF_8)) {
             assertTrue(r.markSupported());
         }
     }
@@ -366,7 +368,7 @@ private void testReadZero(final String csName) throws Exception {
 
     @Test
     public void testReadZero_EmptyString() throws Exception {
-        try (InputStream r = new CharSequenceInputStream("", "UTF-8")) {
+        try (InputStream r = new CharSequenceInputStream("", UTF_8)) {
             final byte[] bytes = new byte[30];
             assertEquals(0, r.read(bytes, 0, 0));
         }
@@ -401,12 +403,12 @@ public void testSingleByteRead_RequiredCharsets() throws IOException {
 
     @Test
     public void testSingleByteRead_UTF16() throws IOException {
-        testSingleByteRead(TEST_STRING, "UTF-16");
+        testSingleByteRead(TEST_STRING, UTF_16);
     }
 
     @Test
     public void testSingleByteRead_UTF8() throws IOException {
-        testSingleByteRead(TEST_STRING, "UTF-8");
+        testSingleByteRead(TEST_STRING, UTF_8);
     }
 
     // This is broken for charsets that don't map each char to a byte
@@ -435,6 +437,6 @@ public void testSkip_USASCII() throws Exception {
 
     @Test
     public void testSkip_UTF8() throws Exception {
-        testSkip("UTF-8");
+        testSkip(UTF_8);
     }
 }