|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.FileContents
public final class FileContents
Represents the contents of a file.
| Constructor Summary | |
|---|---|
FileContents(String aFilename,
String[] aLines)
Creates a new FileContents instance. |
|
| Method Summary | |
|---|---|
com.google.common.collect.ImmutableMap<Integer,List<TextBlock>> |
getCComments()
Returns a map of all C style comments. |
com.google.common.collect.ImmutableMap<Integer,TextBlock> |
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 |
inPackageInfo()
Checks if the current file is a package-info.java file. |
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FileContents(String aFilename,
String[] aLines)
FileContents instance.
aFilename - name of the fileaLines - the contents of the file| Method Detail |
|---|
public void reportSingleLineComment(String aType,
int aStartLineNo,
int aStartColNo)
reportSingleLineComment in interface CommentListeneraType - an identifier for what type of comment it is.aStartLineNo - the starting line numberaStartColNo - the starting column number
public void reportBlockComment(String aType,
int aStartLineNo,
int aStartColNo,
int aEndLineNo,
int aEndColNo)
reportBlockComment in interface CommentListeneraType - 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 number
public void reportCppComment(int aStartLineNo,
int aStartColNo)
aStartLineNo - the starting line numberaStartColNo - the starting column numberpublic com.google.common.collect.ImmutableMap<Integer,TextBlock> 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 com.google.common.collect.ImmutableMap<Integer,List<TextBlock>> getCComments()
List of C style comment TextBlocks
that start at that line.
public TextBlock getJavadocBefore(int aLineNo)
null means there is no such comment.
aLineNo - the line number to check before
null if nonepublic String[] getLines()
public String getFilename()
public boolean lineIsBlank(int aLineNo)
aLineNo - the line number to check
public boolean lineIsComment(int aLineNo)
aLineNo - the line number to check
public 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
public boolean inPackageInfo()
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||