Filter which includes only those lines that contain 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. Starting Ant 1.10.4, the matchAny attribute can be used to control whether any one of the user-specified strings is expected to be contained in the line or all of them are expected to be contained. For example:

<linecontains matchAny="true">
 *   <contains value="foo">
 *   <contains value="bar">
 * </linecontains>

This will include only those lines that contain either foo or bar.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	LineContains.Contains Holds a contains element

Field Summary

Modifier and Type	Field and Description
private Vector<String>	contains Vector that holds the strings that input lines must contain.
private static final String	CONTAINS_KEY Parameter name for the words to filter on.
private String	line Remaining line to be read from this filter, or `null` if the next call to `read()` should read the original stream to find the next matching line.
private boolean	matchAny
private boolean	negate
private static final String	NEGATE_KEY Parameter name for the words to filter on.

Constructor Summary

Access	Constructor and Description
public	LineContains() Constructor for "dummy" instances.
public	LineContains(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 void	addConfiguredContains(final LineContains.Contains The `contains` element to add. Must not be `null`. contains) Adds a `contains` element.
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 LineContains using the passed in Reader for instantiation.
private Vector<String>	Returns: the vector of words which must be contained within a line read from the original stream in order for it to match this filter. The returned object is "live" - in other words, changes made to the returned object are mirrored in the filter. getContains() Returns the vector of words which must be contained within a line read from the original stream in order for it to match this filter.
private void	initialize() Parses the parameters to add user-defined contains strings.
public boolean	Returns: Returns true if this `LineContains` is considered a match, if `any` of the `contains` value match. False if `all` of the `contains` value are expected to match isMatchAny()
public boolean	Returns: boolean negation flag. isNegated() Find out whether we have been negated.
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, only including lines from the original stream which contain all of the specified words.
private void	setContains(final Vector<String> A vector of words which must be contained within a line in order for it to match in this filter. Must not be `null`. contains) Sets the vector of words which must be contained within a line read from the original stream in order for it to match this filter.
public void	setMatchAny(final boolean True if this `LineContains` is considered a match, if `any` of the `contains` value match. False if `all` of the `contains` value are expected to match matchAny)
public void	setNegate(boolean the boolean negation mode to set. b) Set the negation mode.

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

Field Detail

contains	back to summary
private Vector<String> contains Vector that holds the strings that input lines must contain.

CONTAINS_KEY	back to summary
private static final String CONTAINS_KEY Parameter name for the words to filter on.

line	back to summary
private String line Remaining line to be read from this filter, or `null` if the next call to `read()` should read the original stream to find the next matching line.

matchAny	back to summary
private boolean matchAny

negate	back to summary
private boolean negate

NEGATE_KEY	back to summary
private static final String NEGATE_KEY Parameter name for the words to filter on.

Constructor Detail

LineContains back to summary

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

public LineContains()

Constructor for "dummy" instances.

See Also: BaseFilterReader#BaseFilterReader()

LineContains back to summary

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

public LineContains(final Reader in)

Creates a new filtered reader.

Parameters

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

Method Detail

addConfiguredContains back to summary

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

public void addConfiguredContains(final LineContains.Contains contains)

Adds a contains element.

Parameters

contains:LineContains.Contains: The contains element to add. Must not be null.

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 LineContains 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 LineContains 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

getContains	back to summary
private Vector<String> getContains() Returns the vector of words which must be contained within a line read from the original stream in order for it to match this filter. Returns:Vector<String> the vector of words which must be contained within a line read from the original stream in order for it to match this filter. The returned object is "live" - in other words, changes made to the returned object are mirrored in the filter.

getContains

back to summary

private Vector<String> getContains()

Returns the vector of words which must be contained within a line read from the original stream in order for it to match this filter.

Returns:Vector<String>: the vector of words which must be contained within a line read from the original stream in order for it to match this filter. The returned object is "live" - in other words, changes made to the returned object are mirrored in the filter.

initialize	back to summary
private void initialize() Parses the parameters to add user-defined contains strings.

isMatchAny	back to summary
public boolean isMatchAny() Returns:boolean Returns true if this `LineContains` is considered a match, if `any` of the `contains` value match. False if `all` of the `contains` value are expected to match Since Ant 1.10.4

isNegated	back to summary
public boolean isNegated() Find out whether we have been negated. Returns:boolean boolean negation flag.

isNegated

back to summary

public boolean isNegated()

Find out whether we have been negated.

Returns:boolean: boolean negation flag.

read	back to summary
public int read() throws IOException Overrides java.io.FilterReader.read. Returns the next character in the filtered stream, only including lines from the original stream which contain all of the specified words. 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, only including lines from the original stream which contain all of the specified words.

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

setContains back to summary

setContains	back to summary
private void setContains(final Vector<String> contains) Sets the vector of words which must be contained within a line read from the original stream in order for it to match this filter. Parameters contains:Vector<String> A vector of words which must be contained within a line in order for it to match in this filter. Must not be `null`.

private void setContains(final Vector<String> contains)

Sets the vector of words which must be contained within a line read from the original stream in order for it to match this filter.

Parameters

contains:Vector<String>: A vector of words which must be contained within a line in order for it to match in this filter. Must not be null.

setMatchAny	back to summary
public void setMatchAny(final boolean matchAny) Parameters matchAny:boolean True if this `LineContains` is considered a match, if `any` of the `contains` value match. False if `all` of the `contains` value are expected to match Since Ant 1.10.4

setNegate	back to summary
public void setNegate(boolean b) Set the negation mode. Default false (no negation). Parameters b:boolean the boolean negation mode to set.

setNegate

back to summary

public void setNegate(boolean b)

Set the negation mode. Default false (no negation).

Parameters

b:boolean: the boolean negation mode to set.

org.apache.tools.ant.filters back to summary

public Class LineContains.Contains

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.filters.LineContains.Contains

Holds a contains element

Field Summary

Modifier and Type	Field and Description
private String	value User defined contains string

Constructor Summary

Access	Constructor and Description
public	Contains()

Method Summary

Modifier and Type	Method and Description
public final String	Returns: the contains string for this element getValue() Returns the contains string.
public final void	setValue(String The contains string to set. Must not be `null`. contains) Sets the contains string

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

value	back to summary
private String value User defined contains string

Constructor Detail

Contains	back to summary
public Contains()

Method Detail

getValue	back to summary
public final String getValue() Returns the contains string. Returns:String the contains string for this element

getValue

back to summary

public final String getValue()

Returns the contains string.

Returns:String: the contains string for this element

setValue back to summary

setValue	back to summary
public final void setValue(String contains) Sets the contains string Parameters contains:String The contains string to set. Must not be `null`.

public final void setValue(String contains)

Sets the contains string

Parameters

contains:String: The contains string to set. Must not be null.

public final Class LineContains

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class LineContains.Contains

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail