Apache Ant Core 1.10.14 · org.apache.tools.ant.filters.TailFilter

Field Summary

Modifier and Type	Field and Description
private boolean	completedReadAhead Whether or not read-ahead been completed.
private static final int	DEFAULT_NUM_LINES Default number of lines to show
private String	line the current line from the input stream
private LinkedList<String>	lineList
private int	linePos the position in the current line
private long	lines Number of lines to be returned in the filtered stream.
private static final String	LINES_KEY Parameter name for the number of lines to be returned.
private LineTokenizer	lineTokenizer A line tokenizer
private long	skip Number of lines to be skipped.
private static final String	SKIP_KEY Parameter name for the number of lines to be skipped.

Constructor Summary

Access	Constructor and Description
public	TailFilter() Constructor for "dummy" instances.
public	TailFilter(final Reader A Reader object providing the underlying stream. Must not be `null`. in) Creates a new filtered reader.

Method Summary

Modifier and Type	Method and Description
public Reader	Returns: a new filter based on this configuration, but filtering the specified reader chain(final Reader A Reader object providing the underlying stream. Must not be `null`. rdr) Implements org.apache.tools.ant.filters.ChainableReader.chain. Creates a new TailFilter using the passed in Reader for instantiation.
private long	Returns: the number of lines to be returned in the filtered stream getLines() Returns the number of lines to be returned in the filtered stream.
private long	Returns: the number of lines to be skipped in the filtered stream getSkip() Returns the number of lines to be skipped in the filtered stream.
private void	initialize() Scans the parameters list for the "lines" parameter and uses it to set the number of lines to be returned in the filtered stream.
public int	Returns: the next character in the resulting stream, or -1 if the end of the resulting stream has been reached read() Overrides java.io.FilterReader.read. Returns the next character in the filtered stream.
public void	setLines(final long the number of lines to be returned in the filtered stream lines) Sets the number of lines to be returned in the filtered stream.
public void	setSkip(final long the number of lines to be skipped in the filtered stream skip) Sets the number of lines to be skipped in the filtered stream.
private String	Returns: "" while reading in the lines, line while outputting the lines null at the end of outputting the lines tailFilter(String line) implement a tail filter on a stream of lines.

Inherited from org.apache.tools.ant.filters.BaseParamFilterReader:: getParameters setParameters

Field Detail

completedReadAhead	back to summary
private boolean completedReadAhead Whether or not read-ahead been completed.

DEFAULT_NUM_LINES	back to summary
private static final int DEFAULT_NUM_LINES Default number of lines to show

line	back to summary
private String line the current line from the input stream

lineList	back to summary
private LinkedList<String> lineList

linePos	back to summary
private int linePos the position in the current line

lines	back to summary
private long lines Number of lines to be returned in the filtered stream.

LINES_KEY	back to summary
private static final String LINES_KEY Parameter name for the number of lines to be returned.

lineTokenizer	back to summary
private LineTokenizer lineTokenizer A line tokenizer

skip	back to summary
private long skip Number of lines to be skipped.

SKIP_KEY	back to summary
private static final String SKIP_KEY Parameter name for the number of lines to be skipped.

Constructor Detail

TailFilter back to summary

TailFilter	back to summary
public TailFilter() Constructor for "dummy" instances. See Also `BaseFilterReader#BaseFilterReader()`

public TailFilter()

Constructor for "dummy" instances.

See Also: BaseFilterReader#BaseFilterReader()

TailFilter back to summary

TailFilter	back to summary
public TailFilter(final Reader in) Creates a new filtered reader. Parameters in:Reader A Reader object providing the underlying stream. Must not be `null`.

public TailFilter(final Reader in)

Creates a new filtered reader.

Parameters

in:Reader: A Reader object providing the underlying stream. Must not be null.

Method Detail

chain back to summary

chain	back to summary
public Reader chain(final Reader rdr) Implements org.apache.tools.ant.filters.ChainableReader.chain. Creates a new TailFilter using the passed in Reader for instantiation. Parameters rdr:Reader A Reader object providing the underlying stream. Must not be `null`. Returns:Reader a new filter based on this configuration, but filtering the specified reader

public Reader chain(final Reader rdr)

Implements org.apache.tools.ant.filters.ChainableReader.chain.

Creates a new TailFilter using the passed in Reader for instantiation.

Parameters

rdr:Reader: A Reader object providing the underlying stream. Must not be null.

Returns:Reader

a new filter based on this configuration, but filtering the specified reader

getLines	back to summary
private long getLines() Returns the number of lines to be returned in the filtered stream. Returns:long the number of lines to be returned in the filtered stream

getLines

back to summary

private long getLines()

Returns the number of lines to be returned in the filtered stream.

Returns:long: the number of lines to be returned in the filtered stream

getSkip	back to summary
private long getSkip() Returns the number of lines to be skipped in the filtered stream. Returns:long the number of lines to be skipped in the filtered stream

getSkip

back to summary

private long getSkip()

Returns the number of lines to be skipped in the filtered stream.

Returns:long: the number of lines to be skipped in the filtered stream

initialize	back to summary
private void initialize() Scans the parameters list for the "lines" parameter and uses it to set the number of lines to be returned in the filtered stream. also scan for "skip" parameter.

read	back to summary
public int read() throws IOException Overrides java.io.FilterReader.read. Returns the next character in the filtered stream. If the read-ahead has been completed, the next character in the buffer is returned. Otherwise, the stream is read to the end and buffered (with the buffer growing as necessary), then the appropriate position in the buffer is set to read from. Returns:int the next character in the resulting stream, or -1 if the end of the resulting stream has been reached Exceptions IOException: if the underlying stream throws an IOException during reading

read

back to summary

public int read() throws IOException

Overrides java.io.FilterReader.read.

Returns the next character in the filtered stream. If the read-ahead has been completed, the next character in the buffer is returned. Otherwise, the stream is read to the end and buffered (with the buffer growing as necessary), then the appropriate position in the buffer is set to read from.

Returns:int

the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Exceptions

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

setLines	back to summary
public void setLines(final long lines) Sets the number of lines to be returned in the filtered stream. Parameters lines:long the number of lines to be returned in the filtered stream

setLines

back to summary

public void setLines(final long lines)

Sets the number of lines to be returned in the filtered stream.

Parameters

lines:long: the number of lines to be returned in the filtered stream

setSkip	back to summary
public void setSkip(final long skip) Sets the number of lines to be skipped in the filtered stream. Parameters skip:long the number of lines to be skipped in the filtered stream

setSkip

back to summary

public void setSkip(final long skip)

Sets the number of lines to be skipped in the filtered stream.

Parameters

skip:long: the number of lines to be skipped in the filtered stream

tailFilter	back to summary
private String tailFilter(String line) implement a tail filter on a stream of lines. line = null is the end of the stream. Returns:String "" while reading in the lines, line while outputting the lines null at the end of outputting the lines

tailFilter

back to summary

private String tailFilter(String line)

implement a tail filter on a stream of lines. line = null is the end of the stream.

Returns:String: "" while reading in the lines, line while outputting the lines null at the end of outputting the lines

public final Class TailFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail