Module org.tentackle.model

Package org.tentackle.model.parse

Class CommentLine

java.lang.Object

org.tentackle.model.parse.Line

org.tentackle.model.parse.SingleLine

org.tentackle.model.parse.CommentLine

public class CommentLine
extends SingleLine

A comment line.

Author:

harald

Constructor Summary

Constructors

Constructor	Description
CommentLine(Document document, int offset, LineType lineType)	Creates a comment line. This line always spans only one line.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getComment()	Gets the comment. The leading hash and whitespaces and trailing whitespaces are removed.
void	parse()	Parses a line.

Methods inherited from class org.tentackle.model.parse.Line

assertParsed, createModelException, createModelException, getDocument, getLength, getLineNumber, getLineType, getOffset, getSourceInfo, getText, setLength, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentLine

public CommentLine(Document document,
                   int offset,
                   LineType lineType)

Creates a comment line.
This line always spans only one line.

Parameters:

document - the whole document

offset - offset to first character within document

lineType - the line type

Method Detail

parse

public void parse()
           throws ModelException

Description copied from class: Line

Parses a line.

Overrides:

parse in class SingleLine

Throws:

ModelException - if parsing failed

getComment

public java.lang.String getComment()
                            throws ModelException

Gets the comment.
The leading hash and whitespaces and trailing whitespaces are removed.

Returns:

the comment

Throws:

ModelException - if not parsed