Class StringSubstitutorReader

java.lang.Object
java.io.Reader
java.io.FilterReader
org.apache.commons.text.io.StringSubstitutorReader
All Implemented Interfaces:
Closeable, AutoCloseable, Readable

public class StringSubstitutorReader
extends FilterReader
A Reader that performs string substitution on a source Reader using a StringSubstitutor.

Using this Reader avoids reading a whole file into memory as a String to perform string substitution, for example, when a Servlet filters a file to a client.

This class is not thread-safe.

Since:
1.9
  • Constructor Details

  • Method Details

    • read

      public int read() throws IOException
      Reads a single character.
      Overrides:
      read in class FilterReader
      Returns:
      a character as an int or -1 for end-of-stream.
      Throws:
      IOException - If an I/O error occurs
    • read

      public int read​(char[] target, int targetIndexIn, int targetLengthIn) throws IOException
      Reads characters into a portion of an array.
      Overrides:
      read in class FilterReader
      Parameters:
      target - Target buffer.
      targetIndexIn - Index in the target at which to start storing characters.
      targetLengthIn - Maximum number of characters to read.
      Returns:
      The number of characters read, or -1 on end of stream.
      Throws:
      IOException - If an I/O error occurs