ipojo/src/main/java/org/osgi/service/log/LogListener.java

/*
 * $Header:
 * /cvshome/build/org.osgi.service.log/src/org/osgi/service/log/LogListener.java,v
 * 1.9 2006/06/16 16:31:49 hargrave Exp $
 * 
 * Copyright (c) OSGi Alliance (2000, 2006). All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.osgi.service.log;

import java.util.EventListener;

/**
 * Subscribes to <code>LogEntry</code> objects from the
 * <code>LogReaderService</code>.
 * 
 * <p>
 * A <code>LogListener</code> object may be registered with the Log Reader
 * Service using the <code>LogReaderService.addLogListener</code> method.
 * After the listener is registered, the <code>logged</code> method will be
 * called for each <code>LogEntry</code> object created. The
 * <code>LogListener</code> object may be unregistered by calling the
 * <code>LogReaderService.removeLogListener</code> method.
 * 
 * @version $Revision: 1.9 $
 * @see LogReaderService
 * @see LogEntry
 * @see LogReaderService#addLogListener(LogListener)
 * @see LogReaderService#removeLogListener(LogListener)
 */
public interface LogListener extends EventListener {
    /**
     * Listener method called for each LogEntry object created.
     * 
     * <p>
     * As with all event listeners, this method should return to its caller as
     * soon as possible.
     * 
     * @param entry A <code>LogEntry</code> object containing log information.
     * @see LogEntry
     */
    public void logged(LogEntry entry);
}