Package org.apache.tools.ant.filters
Class StripLineComments
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.StripLineComments
- All Implemented Interfaces:
Closeable,AutoCloseable,Readable,ChainableReader,Parameterizable
This filter strips line comments.
Example:
<striplinecomments> <comment value="#"/> <comment value="--"/> <comment value="REM "/> <comment value="rem "/> <comment value="//"/> </striplinecomments>Or:
<filterreader
classname="org.apache.tools.ant.filters.StripLineComments">
<param type="comment" value="#"/>
<param type="comment" value="--"/>
<param type="comment" value="REM "/>
<param type="comment" value="rem "/>
<param type="comment" value="//"/>
</filterreader>-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classThe class that holds a comment representation. -
Field Summary
Fields inherited from class java.io.FilterReader
in -
Constructor Summary
ConstructorsConstructorDescriptionConstructor for "dummy" instances.Creates a new filtered reader. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds acommentelement to the list of prefixes.Creates a new StripLineComments using the passed in Reader for instantiation.intread()Returns the next character in the filtered stream, only including lines from the original stream which don't start with any of the specified comment prefixes.Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
getParameters, setParametersMethods inherited from class org.apache.tools.ant.filters.BaseFilterReader
getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skipMethods inherited from class java.io.FilterReader
close, mark, markSupported, ready, resetMethods inherited from class java.io.Reader
nullReader, read, read, transferTo
-
Constructor Details
-
StripLineComments
public StripLineComments()Constructor for "dummy" instances.- See Also:
-
StripLineComments
Creates a new filtered reader.- Parameters:
in- A Reader object providing the underlying stream. Must not benull.
-
-
Method Details
-
read
Returns the next character in the filtered stream, only including lines from the original stream which don't start with any of the specified comment prefixes.- Overrides:
readin classFilterReader- 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
-
addConfiguredComment
Adds acommentelement to the list of prefixes.- Parameters:
comment- Thecommentelement to add to the list of comment prefixes to strip. Must not benull.
-
chain
Creates a new StripLineComments using the passed in Reader for instantiation.- Specified by:
chainin interfaceChainableReader- Parameters:
rdr- A Reader object providing the underlying stream. Must not benull.- Returns:
- a new filter based on this configuration, but filtering the specified reader
-