org.apache.maven.shared.filtering
Class InterpolatorFilterReaderLineEnding
- java.lang.Object
- java.io.Reader
- java.io.FilterReader
- org.apache.maven.shared.filtering.InterpolatorFilterReaderLineEnding
- All Implemented Interfaces:
- Closeable, AutoCloseable, Readable
public class InterpolatorFilterReaderLineEnding 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.- Since:
- 1.0
- Author:
- cstamas, Olivier Lamy
Field Summary
Fields Modifier and Type Field and 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 and Description InterpolatorFilterReaderLineEnding(Reader in, org.codehaus.plexus.interpolation.Interpolator interpolator, String beginToken, String endToken, boolean supportMultiLineFiltering)
Method Summary
Methods Modifier and Type Method and Description String
getEscapeString()
org.codehaus.plexus.interpolation.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)
InterpolatorFilterReaderLineEnding
setRecursionInterceptor(org.codehaus.plexus.interpolation.RecursionInterceptor recursionInterceptor)
long
skip(long n)
Skips characters.Methods inherited from class java.io.FilterReader
close, mark, markSupported, ready, reset
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
InterpolatorFilterReaderLineEnding
public InterpolatorFilterReaderLineEnding(Reader in, org.codehaus.plexus.interpolation.Interpolator interpolator, String beginToken, String endToken, boolean supportMultiLineFiltering)
- Parameters:
in
- reader to useinterpolator
- interpolator instance to usebeginToken
- start token to useendToken
- end token to usesupportMultiLineFiltering
- If multi line filtering is allowed
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 org.codehaus.plexus.interpolation.RecursionInterceptor getRecursionInterceptor()
setRecursionInterceptor
public InterpolatorFilterReaderLineEnding setRecursionInterceptor(org.codehaus.plexus.interpolation.RecursionInterceptor recursionInterceptor)
Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.