org.codehaus.plexus.util

Class InterpolationFilterReader

public class InterpolationFilterReader extends FilterReader

Constructor Summary
InterpolationFilterReader(Reader in, Map variables, String beginToken, String endToken)
InterpolationFilterReader(Reader in, Map variables)
Method Summary
intread(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
intread()
Returns the next character in the filtered stream, replacing tokens from the original stream.
longskip(long n)
Skips characters.

Constructor Detail

InterpolationFilterReader

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

InterpolationFilterReader

public InterpolationFilterReader(Reader in, Map variables)

Method Detail

read

public int read(char[] cbuf, int off, int len)
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: 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()
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

Throws: IOException if the underlying stream throws an IOException during reading

skip

public long skip(long n)
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

Throws: IllegalArgumentException If n is negative. IOException If an I/O error occurs

Copyright © 2001-2010 Codehaus. All Rights Reserved.