StripLineComments (Apache Ant API)

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 class	StripLineComments.Comment The class that holds a comment representation.

Nested Class Summary

static class

StripLineComments.Comment

The class that holds a comment representation.

Constructor Summary
	StripLineComments() Constructor for "dummy" instances.
	StripLineComments(Reader in) Creates a new filtered reader.

Constructor Summary

StripLineComments()

Constructor for "dummy" instances.

StripLineComments(Reader in)

Creates a new filtered reader.

Method Summary
void	addConfiguredComment(StripLineComments.Comment comment) Adds a `comment` element to the list of prefixes.
Reader	chain(Reader rdr) Creates a new StripLineComments using the passed in Reader for instantiation.
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.

Method Summary

void

addConfiguredComment(StripLineComments.Comment comment)

Adds a comment element to the list of prefixes.

Reader

chain(Reader rdr)

Creates a new StripLineComments using the passed in Reader for instantiation.

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.

Constructor Detail

StripLineComments

Creates a new filtered reader.

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

Method Detail

addConfiguredComment

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

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

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