com.puppycrawl.tools.checkstyle.api
public final class AuditEvent extends EventObject
I'm not very satisfied about the design of this event since there are optional methods that will return null in most of the case. This will need some work to clean it up especially if we want to introduce a more sequential reporting action rather than a packet error reporting. This will allow for example to follow the process quickly in an interface or a servlet (yep, that's cool to run a check via a web interface in a source repository ;-)
See Also: AuditListener
Constructor Summary | |
---|---|
AuditEvent(Object aSource)
Creates a new instance. | |
AuditEvent(Object aSrc, String aFileName)
Creates a new AuditEvent instance. | |
AuditEvent(Object aSrc, String aFileName, LocalizedMessage aMessage)
Creates a new AuditEvent instance.
|
Method Summary | |
---|---|
int | getColumn() |
String | getFileName() |
int | getLine()
return the line number on the source file where the event occurred.
|
LocalizedMessage | getLocalizedMessage() |
String | getMessage()
return the message associated to the event. |
SeverityLevel | getSeverityLevel() |
String | getSourceName() |
Parameters: aSource the object that created the event
AuditEvent
instance.Parameters: aSrc source of the event aFileName file associated with the event
AuditEvent
instance.
Parameters: aSrc source of the event aFileName file associated with the event aMessage the actual message
Returns: the column associated with the message *
Returns: the file name currently being audited or null if there is no relation to a file.
Returns: an integer representing the line number in the file source code.
Returns: the localized message *
Returns: the event message
Returns: the audit event severity level *
Returns: the name of the source for the message *