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

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

Nested Classes

Modifier and Type	Class	Description
static class	StripLineComments.Comment	The class that holds a comment representation.

Field Summary

Fields inherited from class FilterReader

in

Fields inherited from class Reader

lock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class BaseParamFilterReader

getParameters, setParameters

Modifier and Type	Method	Description
protected final Parameter[]	getParameters()	Returns the parameters to be used by this filter.
final void	setParameters(Parameter... parameters)	Sets the parameters used by this filter, and sets the filter to an uninitialized status.

Methods inherited from class BaseFilterReader

getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip

Modifier and Type	Method	Description
protected final boolean	getInitialized()	Returns the initialized status.
protected final Project	getProject()	Returns the project this filter is part of.
final int	read(char[] cbuf, int off, int len)	Reads characters into a portion of an array.
protected final String	readFully()	Reads to the end of the stream, returning the contents as a String.
protected final String	readLine()	Reads a line of text ending with '\n' (or until the end of the stream).
protected final void	setInitialized(boolean initialized)	Sets the initialized status.
final void	setProject(Project project)	Sets the project to work with.
final long	skip(long n)	Skips characters.

Methods inherited from class FilterReader

close, mark, markSupported, ready, reset

Methods inherited from class Reader

nullReader, of, read, read, readAllAsString, readAllLines, transferTo

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

read

public int read()
         throws IOException

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:

read in class FilterReader

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

public 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 Reader chain(Reader rdr)

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

Specified by:

chain in 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