org.eclipse.equinox.log.internal

Class ExtendedLogReaderServiceImpl

java.lang.Object

org.eclipse.equinox.log.internal.ExtendedLogReaderServiceImpl

All Implemented Interfaces:

ExtendedLogReaderService, LogReaderService

public class ExtendedLogReaderServiceImpl
extends Object
implements ExtendedLogReaderService

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogListener(LogListener listener) Subscribes to LogEntry objects.
void	addLogListener(LogListener listener, LogFilter filter) Subscribes to LogEntry objects.
Enumeration	getLog() Returns an Enumeration of all LogEntry objects in the log.
void	removeLogListener(LogListener listener) Unsubscribes to LogEntry objects.

Methods inherited from class java.lang.Object

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

Method Detail

addLogListener

public void addLogListener(LogListener listener,
                  LogFilter filter)

Description copied from interface: ExtendedLogReaderService

Subscribes to LogEntry objects.

This method registers a LogListener object with the Log Reader Service with a LogFilter to allow pre-filtering of interesting log entries. The LogListener.logged(LogEntry) method will be called for each LogEntry object placed into the log that matches the filter.

Specified by:

addLogListener in interface ExtendedLogReaderService

Parameters:

listener - A LogListener object to register; the LogListener object is used to receive LogEntry objects.

filter - A LogFilter object to register; the LogFilter object is used to filter LogEntry objects before sending them to the associated LogListener.

See Also:

LogListener, LogFilter, LogEntry, LogReaderService.addLogListener(LogListener)

addLogListener

public void addLogListener(LogListener listener)

Description copied from interface: LogReaderService

Subscribes to LogEntry objects.

This method registers a LogListener object with the Log Reader Service. The LogListener.logged(LogEntry) method will be called for each LogEntry object placed into the log.

When a bundle which registers a LogListener object is stopped or otherwise releases the Log Reader Service, the Log Reader Service must remove all of the bundle's listeners.

If this Log Reader Service's list of listeners already contains a listener l such that (l==listener), this method does nothing.

Specified by:

addLogListener in interface LogReaderService

Parameters:

listener - A LogListener object to register; the LogListener object is used to receive LogEntry objects.

See Also:

LogListener, LogEntry, LogListener.logged(LogEntry)

getLog

public Enumeration getLog()

Description copied from interface: LogReaderService

Returns an Enumeration of all LogEntry objects in the log.

Each element of the enumeration is a LogEntry object, ordered with the most recent entry first. Whether the enumeration is of all LogEntry objects since the Log Service was started or some recent past is implementation-specific. Also implementation-specific is whether informational and debug LogEntry objects are included in the enumeration.

Specified by:

getLog in interface LogReaderService

Returns:

An Enumeration of all LogEntry objects in the log.

removeLogListener

public void removeLogListener(LogListener listener)

Description copied from interface: LogReaderService

Unsubscribes to LogEntry objects.

This method unregisters a LogListener object from the Log Reader Service.

If listener is not contained in this Log Reader Service's list of listeners, this method does nothing.

Specified by:

removeLogListener in interface LogReaderService

Parameters:

listener - A LogListener object to unregister.

See Also:

LogListener