org.apache.oodt.commons.io

Class LogEvent

java.lang.Object

java.util.EventObject

org.apache.oodt.commons.io.LogEvent

All Implemented Interfaces:

Serializable

public class LogEvent
extends EventObject

Logging event. A logging event is generated and delivered to all registered log listeners when a message was logged, a logging stream was started, or when a logging stream was stopped.

Use the various query methods to determine the details of the event. The event source (from EventObject.getSource()) is always a String.

Author:

Kelly

See Also:

Log, LogListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
LogEvent(Date timestamp, String source, Object category, String message) Create a "message logged" event.
LogEvent(String stream) Create a "stream stopped" event.
LogEvent(String stream, Date timestamp, String source) Create a "stream started" event.

Method Summary

Modifier and Type	Method and Description
Object	getCategory() Get the category.
String	getMessage() Get the message.
String	getStream() Get the stream.
Date	getTimestamp() Get the timestamp.
String	toString() Return a string representation of this event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

LogEvent

public LogEvent(Date timestamp,
                String source,
                Object category,
                String message)

Create a "message logged" event.

Parameters:

timestamp - The message's timestamp.

source - The source label of the message.

category - The message's category.

message - The message.

LogEvent

public LogEvent(String stream,
                Date timestamp,
                String source)

Create a "stream started" event.

Parameters:

stream - The name of the stream.

timestamp - The time the stream started.

source - A string identifying who or what started the stream.

LogEvent

public LogEvent(String stream)

Create a "stream stopped" event.

Parameters:

stream - The name of the stream.

Method Detail

getCategory

public Object getCategory()

Get the category. For message logged events, this is the category for the message. For all other events, this returns null.

Returns:

The category, or null.

getMessage

public String getMessage()

Get the message. For message logged events, this is the actual message text. For all other events, this returns null.

Returns:

The message, or null.

getStream

public String getStream()

Get the stream. For stream started and stopped events, this is the name of the stream that was started or stopped. For message logged events, this is null.

Returns:

The stream, or null.

getTimestamp

public Date getTimestamp()

Get the timestamp. For message logged and stream started events, this is the timestamp of the event. For stream stopped events, this is null.

Returns:

The timestamp, or null.

toString

public String toString()

Return a string representation of this event.

Overrides:

toString in class EventObject

Returns:

A string identifying the type of the event.