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:
- java.io.Closeable,- java.lang.AutoCloseable,- java.lang.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 SummaryNested Classes Modifier and Type Class Description static classStripLineComments.CommentThe class that holds a comment representation.
 - 
Constructor SummaryConstructors Constructor Description StripLineComments()Constructor for "dummy" instances.StripLineComments(java.io.Reader in)Creates a new filtered reader.
 - 
Method SummaryModifier and Type Method Description voidaddConfiguredComment(StripLineComments.Comment comment)Adds acommentelement to the list of prefixes.java.io.Readerchain(java.io.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.- 
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- 
StripLineCommentspublic StripLineComments() Constructor for "dummy" instances.- See Also:
- BaseFilterReader()
 
 - 
StripLineCommentspublic StripLineComments(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 don't start with any of the specified comment prefixes.- 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
 
 - 
addConfiguredCommentpublic void addConfiguredComment(StripLineComments.Comment comment) Adds acommentelement to the list of prefixes.- Parameters:
- comment- The- commentelement to add to the list of comment prefixes to strip. Must not be- null.
 
 - 
chainpublic java.io.Reader chain(java.io.Reader rdr) Creates a new StripLineComments 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
 
 
- 
 
-