Package org.apache.tools.ant.filters
Class LineContains
- java.lang.Object
- 
- java.io.Reader
- 
- java.io.FilterReader
- 
- org.apache.tools.ant.filters.BaseFilterReader
- 
- org.apache.tools.ant.filters.BaseParamFilterReader
- 
- org.apache.tools.ant.filters.LineContains
 
 
 
 
 
- 
- All Implemented Interfaces:
- java.io.Closeable,- java.lang.AutoCloseable,- java.lang.Readable,- ChainableReader,- Parameterizable
 
 public final class LineContains extends BaseParamFilterReader implements ChainableReader 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 containfooandbar. Starting Ant 1.10.4, thematchAnyattribute 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 eitherfooorbar.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classLineContains.ContainsHolds a contains element
 - 
Constructor SummaryConstructors Constructor Description LineContains()Constructor for "dummy" instances.LineContains(java.io.Reader in)Creates a new filtered reader.
 - 
Method SummaryModifier and Type Method Description voidaddConfiguredContains(LineContains.Contains contains)Adds acontainselement.java.io.Readerchain(java.io.Reader rdr)Creates a new LineContains using the passed in Reader for instantiation.booleanisMatchAny()booleanisNegated()Find out whether we have been negated.intread()Returns the next character in the filtered stream, only including lines from the original stream which contain all of the specified words.voidsetMatchAny(boolean matchAny)voidsetNegate(boolean b)Set the negation mode.- 
Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReadergetParameters, setParameters
 - 
Methods inherited from class org.apache.tools.ant.filters.BaseFilterReadergetInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
 
- 
 
- 
- 
- 
Constructor Detail- 
LineContainspublic LineContains() Constructor for "dummy" instances.- See Also:
- BaseFilterReader()
 
 - 
LineContainspublic LineContains(java.io.Reader in) Creates a new filtered reader.- Parameters:
- in- A Reader object providing the underlying stream. Must not be- null.
 
 
- 
 - 
Method Detail- 
readpublic int read() throws java.io.IOExceptionReturns the next character in the filtered stream, only including lines from the original stream which contain all of the specified words.- Overrides:
- readin class- java.io.FilterReader
- Returns:
- the next character in the resulting stream, or -1 if the end of the resulting stream has been reached
- Throws:
- java.io.IOException- if the underlying stream throws an IOException during reading
 
 - 
addConfiguredContainspublic void addConfiguredContains(LineContains.Contains contains) Adds acontainselement.- Parameters:
- contains- The- containselement to add. Must not be- null.
 
 - 
setNegatepublic void setNegate(boolean b) Set the negation mode. Default false (no negation).- Parameters:
- b- the boolean negation mode to set.
 
 - 
isNegatedpublic boolean isNegated() Find out whether we have been negated.- Returns:
- boolean negation flag.
 
 - 
setMatchAnypublic void setMatchAny(boolean matchAny) - Parameters:
- matchAny- True if this- LineContainsis considered a match, if- anyof the- containsvalue match. False if- allof the- containsvalue are expected to match
- Since:
- Ant 1.10.4
 
 - 
isMatchAnypublic boolean isMatchAny() - Returns:
- Returns true if this LineContainsis considered a match, ifanyof thecontainsvalue match. False ifallof thecontainsvalue are expected to match
- Since:
- Ant 1.10.4
 
 - 
chainpublic java.io.Reader chain(java.io.Reader rdr) Creates a new LineContains using the passed in Reader for instantiation.- Specified by:
- chainin 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
 
 
- 
 
-