org.codehaus.plexus.util

Class InterpolationFilterReader


public class InterpolationFilterReader
extends FilterReader

Constructor Summary

InterpolationFilterReader(Reader in, Map variables)
InterpolationFilterReader(Reader in, Map variables, String beginToken, String endToken)

Method Summary

int
read()
Returns the next character in the filtered stream, replacing tokens from the original stream.
int
read(cbuf[] , int off, int len)
Reads characters into a portion of an array.
long
skip(long n)
Skips characters.

Constructor Details

InterpolationFilterReader

public InterpolationFilterReader(Reader in,
                                 Map variables)

InterpolationFilterReader

public InterpolationFilterReader(Reader in,
                                 Map variables,
                                 String beginToken,
                                 String endToken)

Method Details

read

public int read()
            throws IOException
Returns the next character in the filtered stream, replacing tokens from the original stream.
Returns:
the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

read

public int read(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.
Parameters:
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

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.
Parameters:
n - The number of characters to skip
Returns:
the number of characters actually skipped