http://www.eclipse.org/platform: Core Runtime (Eclipse Foundation) 
Copyright (c) 2000, 2019 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation
    Christoph Läubrich - add methods for logging without a IStatus object

/*******************************************************************************
 * Copyright (c) 2000, 2019 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Christoph Läubrich - add methods for logging without a IStatus object
 *******************************************************************************/
package org.eclipse.core.runtime;

import org.osgi.framework.Bundle;


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



@noimplementThis interface is not intended to be implemented by clients.
/**
 * 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.
 * <p>
 * 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()
 * </p>
 *
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface ILog {
	
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 effect if the identical listener is already registered on this log.

Params:
  • listener – the listener to add to this log
See Also:
/**
	 * 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 effect if the identical listener is already registered on this log.
	 *
	 * @param listener the listener to add to this log
	 * @see Platform#addLogListener(ILogListener)
	 */
	public void addLogListener(ILogListener listener);

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

Returns:the plug-in with which this log is associated
Since:3.0
/**
	 * Returns the plug-in with which this log is associated.
	 *
	 * @return the plug-in with which this log is associated
	 * @since 3.0
	 */
	public Bundle getBundle();

	
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.

Params:
  • status – the status to log
/**
	 * 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.
	 *
	 * @param status the status to log
	 */
	public void log(IStatus status);

	
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 effect if the identical listener is not registered on this log.

Params:
  • listener – the listener to remove
See Also:
/**
	 * 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 effect if the identical listener is not registered on this log.
	 *
	 * @param listener the listener to remove
	 * @see Platform#removeLogListener(ILogListener)
	 */
	public void removeLogListener(ILogListener listener);

	
Logs a status with IStatus.INFO using this logger Bundle.getSymbolicName() as pluginId 
Params:
  • message – the message to log
Since:3.17
/**
	 * Logs a status with {@link IStatus#INFO} using this logger
	 * {@link Bundle#getSymbolicName()} as pluginId
	 *
	 * @param message the message to log
	 * @since 3.17
	 */
	default void info(String message) {
		log(new Status(IStatus.INFO, getBundle().getSymbolicName(), message));
	}

	
Logs a status with IStatus.INFO using this logger Bundle.getSymbolicName() as pluginId 
Params:
  • message –   the message to log
  • throwable – an optional throwable to associate with this status
Since:3.17
/**
	 * Logs a status with {@link IStatus#INFO} using this logger
	 * {@link Bundle#getSymbolicName()} as pluginId
	 *
	 * @param message   the message to log
	 * @param throwable an optional throwable to associate with this status
	 * @since 3.17
	 */
	default void info(String message, Throwable throwable) {
		log(new Status(IStatus.INFO, getBundle().getSymbolicName(), message, throwable));
	}

	
Logs a status with IStatus.WARNING using this logger Bundle.getSymbolicName() as pluginId 
Params:
  • message – the message to log
Since:3.17
/**
	 * Logs a status with {@link IStatus#WARNING} using this logger
	 * {@link Bundle#getSymbolicName()} as pluginId
	 *
	 * @param message the message to log
	 * @since 3.17
	 */
	default void warn(String message) {
		log(new Status(IStatus.WARNING, getBundle().getSymbolicName(), message));
	}

	
Logs a status with IStatus.WARNING using this logger Bundle.getSymbolicName() as pluginId 
Params:
  • message –   the message to log
  • throwable – an optional throwable to associate with this status
Since:3.17
/**
	 * Logs a status with {@link IStatus#WARNING} using this logger
	 * {@link Bundle#getSymbolicName()} as pluginId
	 *
	 * @param message   the message to log
	 * @param throwable an optional throwable to associate with this status
	 * @since 3.17
	 */
	default void warn(String message, Throwable throwable) {
		log(new Status(IStatus.WARNING, getBundle().getSymbolicName(), message, throwable));
	}

	
Logs a status with IStatus.ERROR using this logger Bundle.getSymbolicName() as pluginId 
Params:
  • message – the message to log
Since:3.17
/**
	 * Logs a status with {@link IStatus#ERROR} using this logger
	 * {@link Bundle#getSymbolicName()} as pluginId
	 *
	 * @param message the message to log
	 * @since 3.17
	 */
	default void error(String message) {
		log(new Status(IStatus.ERROR, getBundle().getSymbolicName(), message));
	}

	
Logs a status with IStatus.ERROR using this logger Bundle.getSymbolicName() as pluginId 
Params:
  • message –   the message to log
  • throwable – an optional throwable to associate with this status
Since:3.17
/**
	 * Logs a status with {@link IStatus#ERROR} using this logger
	 * {@link Bundle#getSymbolicName()} as pluginId
	 *
	 * @param message   the message to log
	 * @param throwable an optional throwable to associate with this status
	 * @since 3.17
	 */
	default void error(String message, Throwable throwable) {
		log(new Status(IStatus.ERROR, getBundle().getSymbolicName(), message, throwable));
	}
}