org.eclipse.equinox.log.ExtendedLogReaderService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotless-ext-greclipse Show documentation

Groovy Eclipse's formatter bundled for Spotless

The newest version!

/*******************************************************************************
 * Copyright (c) 2006, 2011 IBM Corporation and others
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 ******************************************************************************/
package org.eclipse.equinox.log;

import org.osgi.service.log.*;

/**
 * Extends the OSGi Log Service's LogReaderService to allow better control of log listeners.
 * @ThreadSafe
 * @see LogListener
 * @since 3.7
 */
public interface ExtendedLogReaderService extends LogReaderService {
	/**
	 * 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.
	 * 
	 * @param listener A LogListener object to register; the
	 *        LogListener object is used to receive LogEntry
	 *        objects.
	 * @param filter A LogFilter object to register; the
	 *        LogFilter object is used to filter LogEntry
	 *        objects before sending them to the associated LogListener.
	 * @see LogListener
	 * @see LogFilter
	 * @see LogEntry
	 * @see LogReaderService#addLogListener(LogListener)
	 */
	public void addLogListener(LogListener listener, LogFilter filter);
}