Package org.codehaus.plexus.interpolation

Class InterpolatorFilterReader

java.lang.Object
java.io.Reader
java.io.FilterReader
org.codehaus.plexus.interpolation.InterpolatorFilterReader
All Implemented Interfaces:
Closeable, AutoCloseable, Readable
public class InterpolatorFilterReader extends FilterReader
A FilterReader implementation, that works with Interpolator interface instead of it's own interpolation implementation. This implementation is heavily based on org.codehaus.plexus.util.InterpolationFilterReader.

  • Field Details

    • interpolator

      private Interpolator interpolator
      Interpolator used to interpolate

    • recursionInterceptor

      private RecursionInterceptor recursionInterceptor
      Since:
      1.12

    • replaceData

      private String replaceData
      replacement text from a token

    • replaceIndex

      private int replaceIndex
      Index into replacement data

    • previousIndex

      private int previousIndex
      Index into previous data

    • DEFAULT_BEGIN_TOKEN

      public static final String DEFAULT_BEGIN_TOKEN
      Default begin token.
      See Also:

    • DEFAULT_END_TOKEN

      public static final String DEFAULT_END_TOKEN
      Default end token.
      See Also:

    • beginToken

      private String beginToken

    • orginalBeginToken

      private String orginalBeginToken

    • endToken

      private String endToken

    • interpolateWithPrefixPattern

      private boolean interpolateWithPrefixPattern
      true by default to preserve backward comp

    • escapeString

      private String escapeString

    • useEscape

      private boolean useEscape

    • preserveEscapeString

      private boolean preserveEscapeString
      if true escapeString will be preserved \{foo} -> \{foo}

  • Constructor Details

    • InterpolatorFilterReader

      public InterpolatorFilterReader(Reader in, Interpolator interpolator)
      this constructor use default begin token ${ and default end token }
      Parameters:
      in - reader to use
      interpolator - interpolator instance to use

    • InterpolatorFilterReader

      public InterpolatorFilterReader(Reader in, Interpolator interpolator, String beginToken, String endToken)
      Parameters:
      in - reader to use
      interpolator - interpolator instance to use
      beginToken - start token to use
      endToken - end token to use

    • InterpolatorFilterReader

      public InterpolatorFilterReader(Reader in, Interpolator interpolator, RecursionInterceptor ri)
      this constructor use default begin token ${ and default end token }
      Parameters:
      in - reader to use
      interpolator - interpolator instance to use
      ri - The RecursionInterceptor to use to prevent recursive expressions.
      Since:
      1.12

    • InterpolatorFilterReader

      public InterpolatorFilterReader(Reader in, Interpolator interpolator, String beginToken, String endToken, RecursionInterceptor ri)
      Parameters:
      in - reader to use
      interpolator - interpolator instance to use
      beginToken - start token to use
      endToken - end token to use
      ri - The RecursionInterceptor to use to prevent recursive expressions.
      Since:
      1.12

  • Method Details

    • skip

      public long skip(long n) throws IOException
      Skips characters. This method will block until some characters are available, an I/O error occurs, or the end of the stream is reached.
      Overrides:
      skip in class FilterReader
      Parameters:
      n - The number of characters to skip
      Returns:
      the number of characters actually skipped
      Throws:
      IllegalArgumentException - If n is negative.
      IOException - If an I/O error occurs

    • read

      public int read(char[] cbuf, int off, int len) throws IOException
      Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.
      Overrides:
      read in class FilterReader
      Parameters:
      cbuf - Destination buffer to write characters to. Must not be null.
      off - Offset at which to start storing characters.
      len - Maximum number of characters to read.
      Returns:
      the number of characters read, or -1 if the end of the stream has been reached
      Throws:
      IOException - If an I/O error occurs

    • read

      public int read() throws IOException
      Returns the next character in the filtered stream, replacing tokens from the original stream.
      Overrides:
      read in class FilterReader
      Returns:
      the next character in the resulting stream, or -1 if the end of the resulting stream has been reached
      Throws:
      IOException - if the underlying stream throws an IOException during reading

    • isInterpolateWithPrefixPattern

      public boolean isInterpolateWithPrefixPattern()

    • setInterpolateWithPrefixPattern

      public void setInterpolateWithPrefixPattern(boolean interpolateWithPrefixPattern)

    • getEscapeString

      public String getEscapeString()

    • setEscapeString

      public void setEscapeString(String escapeString)

    • isPreserveEscapeString

      public boolean isPreserveEscapeString()

    • setPreserveEscapeString

      public void setPreserveEscapeString(boolean preserveEscapeString)

    • getRecursionInterceptor

      public RecursionInterceptor getRecursionInterceptor()

    • setRecursionInterceptor

      public InterpolatorFilterReader setRecursionInterceptor(RecursionInterceptor recursionInterceptor)