org.apache.tools.ant.filters

Class LineContains

Implemented Interfaces:
ChainableReader, Parameterizable

public final class LineContains
extends BaseParamFilterReader
implements ChainableReader

Filter which includes only those lines that contain all the user-specified strings. Example:
<linecontains>
   <contains value="foo">
   <contains value="bar">
 </linecontains>
Or:
<filterreader classname="org.apache.tools.ant.filters.LineContains">
    <param type="contains" value="foo"/>
    <param type="contains" value="bar"/>
 </filterreader>
This will include only those lines that contain foo and bar.

Nested Class Summary

static class
LineContains.Contains
Holds a contains element

Constructor Summary

LineContains()
Constructor for "dummy" instances.
LineContains(Reader in)
Creates a new filtered reader.

Method Summary

void
addConfiguredContains(LineContains.Contains contains)
Adds a contains element.
Reader
chain(Reader rdr)
Creates a new LineContains using the passed in Reader for instantiation.
int
read()
Returns the next character in the filtered stream, only including lines from the original stream which contain all of the specified words.

Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader

getParameters, setParameters

Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader

getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip

Constructor Details

LineContains

public LineContains()
Constructor for "dummy" instances.

LineContains

public LineContains(Reader in)
Creates a new filtered reader.
Parameters:
in - A Reader object providing the underlying stream. Must not be null.

Method Details

addConfiguredContains

public final void addConfiguredContains(LineContains.Contains contains)
Adds a contains element.
Parameters:
contains - The contains element to add. Must not be null.

chain

public final Reader chain(Reader rdr)
Creates a new LineContains using the passed in Reader for instantiation.
Specified by:
chain in interface ChainableReader
Parameters:
rdr - A Reader object providing the underlying stream. Must not be null.
Returns:
a new filter based on this configuration, but filtering the specified reader

read

public final int read()
            throws IOException
Returns the next character in the filtered stream, only including lines from the original stream which contain all of the specified words.
Returns:
the next character in the resulting stream, or -1 if the end of the resulting stream has been reached

Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.