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 SummaryNested ClassesModifier and TypeClassDescriptionstatic classThe class that holds a comment representation.
- 
Field SummaryFields inherited from class java.io.FilterReaderin
- 
Constructor SummaryConstructorsConstructorDescriptionConstructor for "dummy" instances.Creates a new filtered reader.
- 
Method SummaryModifier 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.BaseParamFilterReadergetParameters, setParametersMethods inherited from class org.apache.tools.ant.filters.BaseFilterReadergetInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skipMethods inherited from class java.io.FilterReaderclose, mark, markSupported, ready, resetMethods inherited from class java.io.ReadernullReader, read, read, transferTo
- 
Constructor Details- 
StripLineCommentspublic StripLineComments()Constructor for "dummy" instances.- See Also:
 
- 
StripLineCommentsCreates a new filtered reader.- Parameters:
- in- A Reader object providing the underlying stream. Must not be- null.
 
 
- 
- 
Method Details- 
readReturns 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- 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
 
- 
addConfiguredCommentAdds acommentelement to the list of prefixes.- Parameters:
- comment- The- commentelement to add to the list of comment prefixes to strip. Must not be- null.
 
- 
chainCreates 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
 
 
-