Package com.puppycrawl.tools.checkstyle
Class TreeWalkerAuditEvent
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.TreeWalkerAuditEvent
-
public class TreeWalkerAuditEvent extends Object
RawTreeWalker
event for audit.
-
-
Field Summary
Fields Modifier and Type Field Description private FileContents
fileContents
The file contents.private String
fileName
Filename event associated with.private DetailAST
rootAst
Root ast element.private Violation
violation
Violation associated with the event.
-
Constructor Summary
Constructors Constructor Description TreeWalkerAuditEvent(FileContents fileContents, String fileName, Violation violation, DetailAST rootAst)
Creates a newTreeWalkerAuditEvent
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getColumn()
Gets the column associated with the violation.int
getColumnCharIndex()
Gets the column char index associated with the violation.FileContents
getFileContents()
Returns contents of the file.String
getFileName()
Returns name of file being audited.int
getLine()
Return the line number on the source file where the event occurred.String
getMessage()
Return the violation associated to the event.String
getModuleId()
Returns id of module.DetailAST
getRootAst()
Gets the root element of the AST tree.String
getSourceName()
Gets the name of the source for the violation.int
getTokenType()
Gets the token type of the violation.Violation
getViolation()
Gets the violation.
-
-
-
Field Detail
-
fileContents
private final FileContents fileContents
The file contents.
-
-
Constructor Detail
-
TreeWalkerAuditEvent
public TreeWalkerAuditEvent(FileContents fileContents, String fileName, Violation violation, DetailAST rootAst)
Creates a newTreeWalkerAuditEvent
instance.- Parameters:
fileContents
- contents of the file associated with the eventfileName
- file associated with the eventviolation
- the actual violationrootAst
- root AST elementDetailAST
of the file
-
-
Method Detail
-
getFileName
public String getFileName()
Returns name of file being audited.- Returns:
- the file name currently being audited or null if there is no relation to a file.
-
getFileContents
public FileContents getFileContents()
Returns contents of the file.- Returns:
- contents of the file.
-
getViolation
public Violation getViolation()
Gets the violation.- Returns:
- the violation
-
getLine
public int getLine()
Return the line number on the source file where the event occurred. This may be 0 if there is no relation to a file content.- Returns:
- an integer representing the line number in the file source code.
-
getMessage
public String getMessage()
Return the violation associated to the event.- Returns:
- the violation message
-
getColumn
public int getColumn()
Gets the column associated with the violation.- Returns:
- the column associated with the violation
-
getColumnCharIndex
public int getColumnCharIndex()
Gets the column char index associated with the violation.- Returns:
- the column char index associated with the violation
-
getModuleId
public String getModuleId()
Returns id of module.- Returns:
- the identifier of the module that generated the event. Can return null.
-
getSourceName
public String getSourceName()
Gets the name of the source for the violation.- Returns:
- the name of the source for the violation
-
getTokenType
public int getTokenType()
Gets the token type of the violation.- Returns:
- the token type of the violation
-
getRootAst
public DetailAST getRootAst()
Gets the root element of the AST tree.- Returns:
- the root element of the AST tree
-
-