Replace new StringInputStream with existing CharSequenceInputStream

Add CharSequenceInputStream.Builder

Author: garydgregory

src/changes/changes.xml

@@ -53,9 +53,10 @@ The <action> type attribute can be add,update,fix,remove.
         Regression in FileUtils.touch() - no longer creates parent directories.
       </action>
       <!-- ADD -->
-      <action issue="IO-793" dev="ggregory" type="add" due-to="Gary Gregory, K P">
-        Add StringInputStream. StringInputStream.java should be in main source folder.
+      <action dev="ggregory" type="fix" due-to="Gary Gregory">
+        Add CharSequenceInputStream.Builder.
       </action>
+      <!-- UPDATE -->
     </release>
     <release version="2.12.0" date="2023-05-13" description="Java 8 required.">
       <!-- FIX -->

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

@@ -32,6 +32,7 @@
 
 import org.apache.commons.io.Charsets;
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
  * Implements an {@link InputStream} to read from String, StringBuffer, StringBuilder or CharBuffer.
@@ -43,6 +44,58 @@
  */
 public class CharSequenceInputStream extends InputStream {
 
+    /**
+     * Builds a new {@link CharSequenceInputStream} instance.
+     * <p>
+     * For example:
+     * </p>
+     *
+     * <pre>{@code
+     * CharSequenceInputStream s = CharSequenceInputStream.builder()
+     *   .setBufferSize(8192)
+     *   .setCharSequence("String")
+     *   .setCharsetEncoder(Charset.defaultCharset())
+     *   .get()}
+     * </pre>
+     * @since 2.13.0
+     */
+    public static class Builder extends AbstractStreamBuilder<CharSequenceInputStream, Builder> {
+
+        private CharSequence source;
+
+        /**
+         * Constructs a new instance.
+         *
+         * Uses the buffer size, CharSequence, and Charset aspects.
+         */
+        @Override
+        public CharSequenceInputStream get() {
+            return new CharSequenceInputStream(source, getCharset(), getBufferSize());
+        }
+
+        /**
+         * Sets the non-null CharSequence.
+         *
+         * @param source The source string, MUST not be null.
+         * @return this.
+         */
+        public Builder setCharSequence(final CharSequence source) {
+            this.source = Objects.requireNonNull(source, "source");
+            return this;
+        }
+
+    }
+
+    /**
+     * Constructs a new {@link Builder}.
+     *
+     * @return a new {@link Builder}.
+     * @since 2.12.0
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
     private static final int NO_MARK = -1;
 
     private final CharsetEncoder charsetEncoder;
@@ -58,7 +111,9 @@ public class CharSequenceInputStream extends InputStream {
      * @param cs the input character sequence.
      * @param charset the character set name to use.
      * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character.
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
+    @Deprecated
     public CharSequenceInputStream(final CharSequence cs, final Charset charset) {
         this(cs, charset, IOUtils.DEFAULT_BUFFER_SIZE);
     }
@@ -70,7 +125,9 @@ public CharSequenceInputStream(final CharSequence cs, final Charset charset) {
      * @param charset the character set name to use, null maps to the default Charset.
      * @param bufferSize the buffer size to use.
      * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character.
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
+    @Deprecated
     public CharSequenceInputStream(final CharSequence cs, final Charset charset, final int bufferSize) {
         // @formatter:off
         this.charsetEncoder = Charsets.toCharset(charset).newEncoder()
@@ -91,7 +148,9 @@ public CharSequenceInputStream(final CharSequence cs, final Charset charset, fin
      * @param cs the input character sequence.
      * @param charset the character set name to use.
      * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character.
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
+    @Deprecated
     public CharSequenceInputStream(final CharSequence cs, final String charset) {
         this(cs, charset, IOUtils.DEFAULT_BUFFER_SIZE);
     }
@@ -103,7 +162,9 @@ public CharSequenceInputStream(final CharSequence cs, final String charset) {
      * @param charset the character set name to use, null maps to the default Charset.
      * @param bufferSize the buffer size to use.
      * @throws IllegalArgumentException if the buffer is not large enough to hold a complete character.
+     * @deprecated Use {@link #builder()} and {@link Builder#get()}
      */
+    @Deprecated
     public CharSequenceInputStream(final CharSequence cs, final String charset, final int bufferSize) {
         this(cs, Charsets.toCharset(charset), bufferSize);
     }

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

@@ -27,7 +27,7 @@
 import java.io.Writer;
 import java.nio.charset.StandardCharsets;
 
-import org.apache.commons.io.input.StringInputStream;
+import org.apache.commons.io.input.CharSequenceInputStream;
 import org.apache.commons.io.output.ByteArrayOutputStream;
 import org.apache.commons.io.test.TestUtils;
 import org.apache.commons.io.test.ThrowOnCloseInputStream;
@@ -101,7 +101,7 @@ public void copy_inputStreamToWriterWithEncoding() throws Exception {
         final String inDataStr = "data";
         final String charsetName = StandardCharsets.UTF_8.name();
         final StringWriter writer = new StringWriter();
-        CopyUtils.copy(new StringInputStream.Builder().setString(inDataStr).setCharset(charsetName).get(), writer, charsetName);
+        CopyUtils.copy(new CharSequenceInputStream.Builder().setCharSequence(inDataStr).setCharset(charsetName).get(), writer, charsetName);
         assertEquals(inDataStr, writer.toString());
     }
 

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

@@ -25,8 +25,8 @@
 import java.util.HashMap;
 import java.util.Random;
 
+import org.apache.commons.io.input.CharSequenceInputStream;
 import org.apache.commons.io.input.DemuxInputStream;
-import org.apache.commons.io.input.StringInputStream;
 import org.apache.commons.io.output.ByteArrayOutputStream;
 import org.apache.commons.io.output.DemuxOutputStream;
 import org.apache.commons.io.test.TestUtils;
@@ -140,7 +140,7 @@ private String getOutput(final String threadName) {
     }
 
     private void startReader(final String name, final String data, final DemuxInputStream demux) {
-        final InputStream input = new StringInputStream.Builder().setString(data).get();
+        final InputStream input = CharSequenceInputStream.builder().setCharSequence(data).get();
         final ReaderThread thread = new ReaderThread(name, input, demux);
         threadMap.put(name, thread);
     }

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

@@ -64,10 +64,10 @@
 
 import org.apache.commons.io.function.IOConsumer;
 import org.apache.commons.io.input.BrokenInputStream;
+import org.apache.commons.io.input.CharSequenceInputStream;
 import org.apache.commons.io.input.CircularInputStream;
 import org.apache.commons.io.input.NullInputStream;
 import org.apache.commons.io.input.NullReader;
-import org.apache.commons.io.input.StringInputStream;
 import org.apache.commons.io.output.AppendableWriter;
 import org.apache.commons.io.output.BrokenOutputStream;
 import org.apache.commons.io.output.CountingOutputStream;
@@ -966,7 +966,7 @@ public void testReadFully_InputStream_ByteArray() throws Exception {
 
     @Test
     public void testReadFully_InputStream_Offset() throws Exception {
-        final StringInputStream stream = new StringInputStream.Builder().setString("abcd1234").setCharset(StandardCharsets.UTF_8).get();
+        final InputStream stream = CharSequenceInputStream.builder().setCharSequence("abcd1234").setCharset(StandardCharsets.UTF_8).get();
         final byte[] buffer = "wx00000000".getBytes(StandardCharsets.UTF_8);
         IOUtils.readFully(stream, buffer, 2, 8);
         assertEquals("wxabcd1234", new String(buffer, 0, buffer.length, StandardCharsets.UTF_8));

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

@@ -154,7 +154,7 @@ private InputStream createUtf8Input(final byte[] baseData, final boolean addBOM)
 
     private boolean doesSaxSupportCharacterSet(final String charsetName) throws ParserConfigurationException, SAXException, IOException {
         final DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
-        try (StringInputStream byteStream = new StringInputStream.Builder().setString("<?xml version=\"1.0\" encoding=\"" + charsetName + "\"?><Z/>")
+        try (InputStream byteStream = CharSequenceInputStream.builder().setCharSequence("<?xml version=\"1.0\" encoding=\"" + charsetName + "\"?><Z/>")
                 .setCharset(charsetName).get()) {
             final InputSource is = new InputSource(byteStream);
             is.setEncoding(charsetName);

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

@@ -184,6 +184,9 @@ private void testCharsetMismatchInfiniteLoop(final String csName) throws IOExcep
         try (InputStream stream = new CharSequenceInputStream(new String(inputChars), charset, 512)) {
             IOUtils.toCharArray(stream, charset);
         }
+        try (InputStream stream = CharSequenceInputStream.builder().setCharSequence(new String(inputChars)).setCharset(charset).setBufferSize(512).get()) {
+            IOUtils.toCharArray(stream, charset);
+        }
     }
 
     @Test
@@ -338,7 +341,11 @@ public void testMarkReset_UTF8() throws Exception {
 
     @Test
     public void testMarkSupported() throws Exception {
-        try (InputStream r = new CharSequenceInputStream("test", UTF_8)) {
+        try (@SuppressWarnings("deprecation")
+        InputStream r = new CharSequenceInputStream("test", UTF_8)) {
+            assertTrue(r.markSupported());
+        }
+        try (InputStream r = CharSequenceInputStream.builder().setCharSequence("test").setCharset(UTF_8).get()) {
             assertTrue(r.markSupported());
         }
     }
@@ -349,6 +356,10 @@ public void testNullCharset() throws IOException {
             IOUtils.toByteArray(in);
             assertEquals(Charset.defaultCharset(), in.getCharsetEncoder().charset());
         }
+        try (CharSequenceInputStream in = CharSequenceInputStream.builder().setCharSequence("test").setCharset((Charset) null).get()) {
+            IOUtils.toByteArray(in);
+            assertEquals(Charset.defaultCharset(), in.getCharsetEncoder().charset());
+        }
     }
 
     @Test
@@ -357,6 +368,10 @@ public void testNullCharsetName() throws IOException {
             IOUtils.toByteArray(in);
             assertEquals(Charset.defaultCharset(), in.getCharsetEncoder().charset());
         }
+        try (CharSequenceInputStream in = CharSequenceInputStream.builder().setCharSequence("test").setCharset((String) null).get()) {
+            IOUtils.toByteArray(in);
+            assertEquals(Charset.defaultCharset(), in.getCharsetEncoder().charset());
+        }
     }
 
     private void testReadZero(final String csName) throws Exception {

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

@@ -33,7 +33,7 @@ public class CountingInputStreamTest {
     @Test
     public void testCounting() throws Exception {
         final String text = "A piece of text";
-        try (CountingInputStream cis = new CountingInputStream(new StringInputStream.Builder().setString(text).get())) {
+        try (CountingInputStream cis = new CountingInputStream(CharSequenceInputStream.builder().setCharSequence(text).get())) {
 
             // have to declare this larger as we're going to read
             // off the end of the stream and input stream seems
@@ -149,7 +149,7 @@ public void testResetting() throws Exception {
     @Test
     public void testSkipping() throws IOException {
         final String text = "Hello World!";
-        try (CountingInputStream cis = new CountingInputStream(new StringInputStream.Builder().setString(text).get())) {
+        try (CountingInputStream cis = new CountingInputStream(CharSequenceInputStream.builder().setCharSequence(text).get())) {
 
             assertEquals(6, cis.skip(6));
             assertEquals(6, cis.getCount());