Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.event
Class LogEvent

java.lang.Object
  extended by com.jivesoftware.base.event.LogEvent
All Implemented Interfaces:
JiveEvent

public class LogEvent
extends java.lang.Object
implements JiveEvent

A class for log events. This class will be passed to LogListeners whenever a log event is fired and contains all the pertinent information to the event.


Field Summary
static int DEBUG_EVENT
          Event type for whenever a debug log event occurs.
static int ERROR_EVENT
          Event type for whenever an error log event occurs.
static int FATAL_EVENT
          Event type for whenever a fatal log event occurs.
static int INFO_EVENT
          Event type for whenever a info log event occurs.
static int WARN_EVENT
          Event type for whenever a warn log event occurs.
 
Constructor Summary
LogEvent(int eventType, java.util.Map params)
           
LogEvent(int eventType, java.util.Map params, java.lang.Throwable e, java.lang.String message)
           
 
Method Summary
 java.util.Date getDate()
          Returns the date (as a Date object) that the event was created.
 int getEventType()
          Returns the event type corresponding to the event.
 java.lang.String getMessage()
           
 java.util.Map getParams()
          Returns a map of parameters which can be used to pass data to a listener.
 java.lang.Throwable getThrowable()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FATAL_EVENT

public static final int FATAL_EVENT
Event type for whenever a fatal log event occurs.

See Also:
Constant Field Values

ERROR_EVENT

public static final int ERROR_EVENT
Event type for whenever an error log event occurs.

See Also:
Constant Field Values

WARN_EVENT

public static final int WARN_EVENT
Event type for whenever a warn log event occurs.

See Also:
Constant Field Values

INFO_EVENT

public static final int INFO_EVENT
Event type for whenever a info log event occurs.

See Also:
Constant Field Values

DEBUG_EVENT

public static final int DEBUG_EVENT
Event type for whenever a debug log event occurs.

See Also:
Constant Field Values
Constructor Detail

LogEvent

public LogEvent(int eventType,
                java.util.Map params)

LogEvent

public LogEvent(int eventType,
                java.util.Map params,
                java.lang.Throwable e,
                java.lang.String message)
Method Detail

getEventType

public int getEventType()
Description copied from interface: JiveEvent
Returns the event type corresponding to the event.

Specified by:
getEventType in interface JiveEvent
Returns:
the event type corresponding to the event.

getParams

public java.util.Map getParams()
Description copied from interface: JiveEvent
Returns a map of parameters which can be used to pass data to a listener.

Specified by:
getParams in interface JiveEvent
Returns:
map of parameters which can be used to pass data to a listener.

getThrowable

public java.lang.Throwable getThrowable()

getMessage

public java.lang.String getMessage()

getDate

public java.util.Date getDate()
Description copied from interface: JiveEvent
Returns the date (as a Date object) that the event was created.

Specified by:
getDate in interface JiveEvent
Returns:
the date (as a Date object) that the event was created.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.