public final class FileContents extends Object implements CommentListener
Constructor and Description |
---|
FileContents(String aFilename,
String[] aLines)
Creates a new
FileContents instance. |
Modifier and Type | Method and Description |
---|---|
Map |
getCComments()
Returns a map of all C style comments.
|
Map |
getCppComments()
Returns a map of all the C++ style comments.
|
String |
getFilename() |
TextBlock |
getJavadocBefore(int aLineNo)
Returns the Javadoc comment before the specified line.
|
String[] |
getLines() |
boolean |
hasIntersectionWithComment(int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo)
Checks if the specified position intersects with a comment.
|
boolean |
lineIsBlank(int aLineNo)
Checks if the specified line is blank.
|
boolean |
lineIsComment(int aLineNo)
Checks if the specified line is a single-line comment without code.
|
void |
reportBlockComment(String aType,
int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo)
Report the location of a block comment that can span multiple lines.
|
void |
reportCComment(int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo)
Report the location of a C-style comment.
|
void |
reportCppComment(int aStartLineNo,
int aStartColNo)
Report the location of a C++ style comment.
|
void |
reportSingleLineComment(String aType,
int aStartLineNo,
int aStartColNo)
Report the location of a single line comment that extends from the
given point to the end of the line.
|
public void reportSingleLineComment(String aType, int aStartLineNo, int aStartColNo)
reportSingleLineComment
in interface CommentListener
aType
- an identifier for what type of comment it is.aStartLineNo
- the starting line numberaStartColNo
- the starting column numberpublic void reportBlockComment(String aType, int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
reportBlockComment
in interface CommentListener
aType
- an identifier for what type of comment it is.aStartLineNo
- the starting line numberaStartColNo
- the starting column numberaEndLineNo
- the ending line numberaEndColNo
- the ending column numberpublic void reportCppComment(int aStartLineNo, int aStartColNo)
aStartLineNo
- the starting line numberaStartColNo
- the starting column numberpublic Map getCppComments()
TextBlock
at the line.public void reportCComment(int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
aStartLineNo
- the starting line numberaStartColNo
- the starting column numberaEndLineNo
- the ending line numberaEndColNo
- the ending column numberpublic Map getCComments()
List
of C style comment TextBlock
s
that start at that line.public TextBlock getJavadocBefore(int aLineNo)
null
means there is no such comment.aLineNo
- the line number to check beforenull
if nonepublic String[] getLines()
public String getFilename()
public boolean lineIsBlank(int aLineNo)
aLineNo
- the line number to checkpublic boolean lineIsComment(int aLineNo)
aLineNo
- the line number to checkpublic boolean hasIntersectionWithComment(int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
aStartLineNo
- the starting line numberaStartColNo
- the starting column numberaEndLineNo
- the ending line numberaEndColNo
- the ending column number