org.apache.tools.ant.filters

Class LineContainsRegExp

public final class LineContainsRegExp extends BaseParamFilterReader implements ChainableReader

Filter which includes only those lines that contain the user-specified regular expression matching strings. Example:
<linecontainsregexp>
   <regexp pattern="foo*">
 </linecontainsregexp>
Or:
<filterreader classname="org.apache.tools.ant.filters.LineContainsRegExp">
    <param type="regexp" value="foo*"/>
 </filterreader>
This will fetch all those lines that contain the pattern foo
Constructor Summary
LineContainsRegExp()
Constructor for "dummy" instances.
LineContainsRegExp(Reader in)
Creates a new filtered reader.
Method Summary
voidaddConfiguredRegexp(RegularExpression regExp)
Adds a regexp element.
Readerchain(Reader rdr)
Creates a new LineContainsRegExp using the passed in Reader for instantiation.
intread()
Returns the next character in the filtered stream, only including lines from the original stream which match all of the specified regular expressions.

Constructor Detail

LineContainsRegExp

public LineContainsRegExp()
Constructor for "dummy" instances.

See Also: BaseFilterReader

LineContainsRegExp

public LineContainsRegExp(Reader in)
Creates a new filtered reader.

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

Method Detail

addConfiguredRegexp

public final void addConfiguredRegexp(RegularExpression regExp)
Adds a regexp element.

Parameters: regExp The regexp element to add. Must not be null.

chain

public final Reader chain(Reader rdr)
Creates a new LineContainsRegExp using the passed in Reader for instantiation.

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()
Returns the next character in the filtered stream, only including lines from the original stream which match all of the specified regular expressions.

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

Copyright