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.

Author:

cstamas

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BEGIN_TOKEN	Default begin token.
static final String	DEFAULT_END_TOKEN	Default end token.

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

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

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

read, read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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 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)