Eclipse Plug-in Developer Guide (Galileo) - ILog (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.runtime
Interface ILog

public interface ILog

A log to which status events can be written. Logs appear on individual plug-ins and on the platform itself. Clients can register log listeners which will receive notification of all log events as they come in.

XXX Need to create a new log interface on common plugin. That interface should be a super interface of this ILog. getBundle() would stay here. In the super interface we would have getName()

Restriction:: This interface is not intended to be implemented by clients.

Method Summary

void addLogListener ( ILogListener listener)
          Adds the given log listener to this log.

Bundle getBundle ()
          Returns the plug-in with which this log is associated.

void log ( IStatus status)
          Logs the given status.

void removeLogListener ( ILogListener listener)
          Removes the given log listener to this log.

Method Detail

addLogListener

void addLogListener(
ILogListener listener)

Adds the given log listener to this log. Subsequently the log listener will receive notification of all log events passing through this log. This method has no affect if the identical listener is already registered on this log.

Parameters:: listener - the listener to add to this log
See Also:: Platform.addLogListener(ILogListener)

getBundle


Bundle getBundle()

Returns the plug-in with which this log is associated.

Returns:: the plug-in with which this log is associated
Since:: 3.0

log

void log(
IStatus status)

Logs the given status. The status is distributed to the log listeners installed on this log and then to the log listeners installed on the platform.

Parameters:: status - the status to log

removeLogListener

void removeLogListener(
ILogListener listener)

Removes the given log listener to this log. Subsequently the log listener will no longer receive notification of log events passing through this log. This method has no affect if the identical listener is not registered on this log.