Class ShScriptCommentStream

java.lang.Object

com.sun.javatest.finder.CommentStream

com.sun.javatest.finder.ShScriptCommentStream

public class ShScriptCommentStream
extends CommentStream

This class extracts all ASCII characters within standard shell script comments. A shell comment begins with a "#" and ends at the end of a line. A single comment is regarded as a continuous set of lines that begin with "#". All leading "#: characters and any preceding blanks or tabs are ignored.

See Also:

• CommentStream

Field Summary

Fields inherited from class CommentStream

cs, fastScan

Constructor Summary

Constructors

Constructor	Description
ShScriptCommentStream()

Method Summary

Modifier and Type	Method	Description
String	readComment()	Read the next comment from the input reader.

Methods inherited from class CommentStream

close, init, setFastScan

Methods inherited from class Object

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

Constructor Details

ShScriptCommentStream

public ShScriptCommentStream()

Method Details

readComment

public String readComment()
                   throws IOException

Description copied from class: CommentStream

Read the next comment from the input reader.

Specified by:

readComment in class CommentStream

Returns:

The next comment that is read from the stream.

Throws:

IOException - if there is a problem while reading the next comment.