org.apache.tools.ant.filters

Class StripLineComments

public final class StripLineComments extends BaseParamFilterReader implements ChainableReader

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
static classStripLineComments.Comment
The class that holds a comment representation.
Constructor Summary
StripLineComments()
Constructor for "dummy" instances.
StripLineComments(Reader in)
Creates a new filtered reader.
Method Summary
voidaddConfiguredComment(StripLineComments.Comment comment)
Adds a comment element to the list of prefixes.
Readerchain(Reader rdr)
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.

Constructor Detail

StripLineComments

public StripLineComments()
Constructor for "dummy" instances.

See Also: BaseFilterReader

StripLineComments

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

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

Method Detail

addConfiguredComment

public final void addConfiguredComment(StripLineComments.Comment comment)
Adds a comment element to the list of prefixes.

Parameters: comment The comment element to add to the list of comment prefixes to strip. Must not be null.

chain

public final Reader chain(Reader rdr)
Creates a new StripLineComments 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 don't start with any of the specified comment prefixes.

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 B) 2000-2007 Apache Software Foundation. All Rights Reserved.