org.apache.maven.shared.filtering

Class MultiDelimiterInterpolatorFilterReaderLineEnding

java.lang.Object

java.io.Reader

java.io.FilterReader

org.apache.maven.shared.filtering.AbstractFilterReaderLineEnding

org.apache.maven.shared.filtering.MultiDelimiterInterpolatorFilterReaderLineEnding

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class MultiDelimiterInterpolatorFilterReaderLineEnding
extends AbstractFilterReaderLineEnding

A FilterReader implementation, that works with Interpolator interface instead of its 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 org.apache.maven.shared.filtering.AbstractFilterReaderLineEnding

delimiters, markLength, useEscape

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
MultiDelimiterInterpolatorFilterReaderLineEnding(Reader in, Interpolator interpolator, boolean supportMultiLineFiltering) This constructor uses default begin token ${ and default end token }.
MultiDelimiterInterpolatorFilterReaderLineEnding(Reader in, Interpolator interpolator, RecursionInterceptor ri, boolean supportMultiLineFiltering)

Method Summary

Modifier and Type	Method and Description
RecursionInterceptor	getRecursionInterceptor()
boolean	isInterpolateWithPrefixPattern()
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.
boolean	removeDelimiterSpec(String delimiterSpec)
AbstractFilterReaderLineEnding	setDelimiterSpecs(Set<String> specs)
void	setInterpolateWithPrefixPattern(boolean interpolateWithPrefixPattern)
AbstractFilterReaderLineEnding	setRecursionInterceptor(RecursionInterceptor givenRecursionInterceptor)
long	skip(long n) Skips characters.

Methods inherited from class org.apache.maven.shared.filtering.AbstractFilterReaderLineEnding

calculateMarkLength, getEscapeString, isPreserveEscapeString, setEscapeString, setPreserveEscapeString

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

MultiDelimiterInterpolatorFilterReaderLineEnding

public MultiDelimiterInterpolatorFilterReaderLineEnding(Reader in,
                                                        Interpolator interpolator,
                                                        boolean supportMultiLineFiltering)

This constructor uses default begin token ${ and default end token }.

Parameters:

in - reader to use

interpolator - interpolator instance to use

supportMultiLineFiltering - If multi line filtering is allowed

MultiDelimiterInterpolatorFilterReaderLineEnding

public MultiDelimiterInterpolatorFilterReaderLineEnding(Reader in,
                                                        Interpolator interpolator,
                                                        RecursionInterceptor ri,
                                                        boolean supportMultiLineFiltering)

Parameters:

in - reader to use

interpolator - interpolator instance to use

ri - The RecursionInterceptor to use to prevent recursive expressions.

supportMultiLineFiltering - If multi line filtering is allowed

Method Detail

removeDelimiterSpec

public boolean removeDelimiterSpec(String delimiterSpec)

Parameters:

delimiterSpec - delimiter spec.

Returns:

true/false.

setDelimiterSpecs

public AbstractFilterReaderLineEnding setDelimiterSpecs(Set<String> specs)

Parameters:

specs - set of specs.

Returns:

MultiDelimiterInterpolatorFilterReaderLineEnding

skip

public long skip(long n)
          throws IOException,
                 IllegalArgumentException

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

Returns:

interpolate with prefix pattern true (active) false otherwise.

setInterpolateWithPrefixPattern

public void setInterpolateWithPrefixPattern(boolean interpolateWithPrefixPattern)

Parameters:

interpolateWithPrefixPattern - set the interpolate with prefix pattern.

getRecursionInterceptor

public RecursionInterceptor getRecursionInterceptor()

Returns:

RecursionInterceptor

setRecursionInterceptor

public AbstractFilterReaderLineEnding setRecursionInterceptor(RecursionInterceptor givenRecursionInterceptor)

Parameters:

givenRecursionInterceptor - RecursionInterceptor

Returns:

this