Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ api overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.api
Class AuditEvent  

java.lang.Object
  java.util.EventObject
      com.puppycrawl.tools.checkstyle.api.AuditEvent

All Implemented Interfaces:

java.io.Serializable

---

public final class AuditEvent

extends java.util.EventObject

Raw event for audit.

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 ;-)

---

Field Summary
private  java.lang.String	mFileName           filename event associated with
private  LocalizedMessage	mMessage           message associated with the event

 

Fields inherited from class java.util.EventObject

source

 

Constructor Summary

AuditEvent(java.lang.Object aSource)           Creates a new instance.

AuditEvent(java.lang.Object aSrc, java.lang.String aFileName)           Creates a new AuditEvent instance.

AuditEvent(java.lang.Object aSrc, java.lang.String aFileName, LocalizedMessage aMessage)           Creates a new AuditEvent instance.

 

Method Summary
int	getColumn()
java.lang.String	getFileName()
int	getLine()           return the line number on the source file where the event occurred.
LocalizedMessage	getLocalizedMessage()
java.lang.String	getMessage()           return the message associated to the event.
SeverityLevel	getSeverityLevel()
java.lang.String	getSourceName()

 

Methods inherited from class java.util.EventObject

getSource, toString

 

Methods inherited from class java.lang.Object

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

 

Field Detail

mFileName

private final java.lang.String mFileName

filename event associated with

---

mMessage

private final LocalizedMessage mMessage

message associated with the event

Constructor Detail

AuditEvent

public AuditEvent(java.lang.Object aSource)

Creates a new instance.

---

AuditEvent

public AuditEvent(java.lang.Object aSrc,
                  java.lang.String aFileName)

Creates a new AuditEvent instance.

---

AuditEvent

public AuditEvent(java.lang.Object aSrc,
                  java.lang.String aFileName,
                  LocalizedMessage aMessage)

Creates a new AuditEvent instance.

Method Detail

getFileName

public java.lang.String getFileName()

---

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.

---

getMessage

public java.lang.String getMessage()

return the message associated to the event.

---

getColumn

public int getColumn()

---

getSeverityLevel

public SeverityLevel getSeverityLevel()

---

getSourceName

public java.lang.String getSourceName()

---

getLocalizedMessage

public LocalizedMessage getLocalizedMessage()

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ api overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---