Package com.sun.javatest.finder
Class CommentStream
- java.lang.Object
-
- com.sun.javatest.finder.CommentStream
-
- Direct Known Subclasses:
HTMLCommentStream
,JavaCommentStream
,ShScriptCommentStream
public abstract class CommentStream extends java.lang.Object
This class extract all ASCII characters within a block comments. Any leading spaces or comment-like characters are removed.
-
-
Constructor Summary
Constructors Constructor Description CommentStream()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
close()
Close this CommentStream.void
init(java.io.BufferedReader br)
Initialize a CommentStream.abstract java.lang.String
readComment()
Read the next comment from the input reader.void
setFastScan(boolean b)
Set this comment stream into "fast scan" mode.
-
-
-
Method Detail
-
init
public void init(java.io.BufferedReader br)
Initialize a CommentStream.- Parameters:
br
- The reader from which to read.
-
close
public void close() throws java.io.IOException
Close this CommentStream.- Throws:
java.io.IOException
- if there is a problem closing the stream.
-
setFastScan
public void setFastScan(boolean b)
Set this comment stream into "fast scan" mode. Depending on the context, this should be set if there is a constraint that limits the set of comments that might be of interest.- Parameters:
b
- Set to true to enable a fast scan for comments.
-
readComment
public abstract java.lang.String readComment() throws java.io.IOException
Read the next comment from the input reader.- Returns:
- The next comment that is read from the stream.
- Throws:
java.io.IOException
- if there is a problem while reading the next comment.
-
-