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.- Author:
- cstamas
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_BEGIN_TOKEN
Default begin token.static String
DEFAULT_END_TOKEN
Default end token.-
Fields inherited from class java.io.FilterReader
in
-
-
Constructor Summary
Constructors Constructor Description InterpolatorFilterReader(Reader in, Interpolator interpolator)
this constructor use default begin token ${ and default end token }InterpolatorFilterReader(Reader in, Interpolator interpolator, String beginToken, String endToken)
InterpolatorFilterReader(Reader in, Interpolator interpolator, String beginToken, String endToken, RecursionInterceptor ri)
InterpolatorFilterReader(Reader in, Interpolator interpolator, RecursionInterceptor ri)
this constructor use default begin token ${ and default end token }
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getEscapeString()
RecursionInterceptor
getRecursionInterceptor()
boolean
isInterpolateWithPrefixPattern()
boolean
isPreserveEscapeString()
int
read()
Returns the next character in the filtered stream, replacing tokens from the original stream.int
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.void
setEscapeString(String escapeString)
void
setInterpolateWithPrefixPattern(boolean interpolateWithPrefixPattern)
void
setPreserveEscapeString(boolean preserveEscapeString)
InterpolatorFilterReader
setRecursionInterceptor(RecursionInterceptor recursionInterceptor)
long
skip(long n)
Skips characters.-
Methods inherited from class java.io.FilterReader
close, mark, markSupported, ready, reset
-
Methods inherited from class java.io.Reader
nullReader, read, read, transferTo
-
-
-
-
Field Detail
-
DEFAULT_BEGIN_TOKEN
public static final String DEFAULT_BEGIN_TOKEN
Default begin token.- See Also:
- Constant Field Values
-
DEFAULT_END_TOKEN
public static final String DEFAULT_END_TOKEN
Default end token.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
InterpolatorFilterReader
public InterpolatorFilterReader(Reader in, Interpolator interpolator)
this constructor use default begin token ${ and default end token }- Parameters:
in
- reader to useinterpolator
- interpolator instance to use
-
InterpolatorFilterReader
public InterpolatorFilterReader(Reader in, Interpolator interpolator, String beginToken, String endToken)
- Parameters:
in
- reader to useinterpolator
- interpolator instance to usebeginToken
- start token to useendToken
- 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 useinterpolator
- interpolator instance to useri
- TheRecursionInterceptor
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 useinterpolator
- interpolator instance to usebeginToken
- start token to useendToken
- end token to useri
- TheRecursionInterceptor
to use to prevent recursive expressions.- Since:
- 1.12
-
-
Method Detail
-
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 classFilterReader
- Parameters:
n
- The number of characters to skip- Returns:
- the number of characters actually skipped
- Throws:
IllegalArgumentException
- Ifn
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 classFilterReader
- Parameters:
cbuf
- Destination buffer to write characters to. Must not benull
.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 classFilterReader
- 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)
-
-