org.osgi.framework.FrameworkListener Maven / Gradle / Ivy

/*
 * Copyright (c) OSGi Alliance (2000, 2015). 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.framework;

import java.util.EventListener;
import org.osgi.annotation.versioning.ConsumerType;

/**
 * A {@code FrameworkEvent} listener. {@code FrameworkListener} is a listener
 * interface that may be implemented by a bundle developer. When a
 * {@code FrameworkEvent} is fired, it is asynchronously delivered to a
 * {@code FrameworkListener}. The Framework delivers {@code FrameworkEvent}
 * objects to a {@code FrameworkListener} in order and must not concurrently
 * call a {@code FrameworkListener}.
 * 
 * 
 * A {@code FrameworkListener} object is registered with the Framework using the
 * {@link BundleContext#addFrameworkListener(FrameworkListener)} method.
 * {@code FrameworkListener} objects are called with a {@code FrameworkEvent}
 * objects when the Framework starts and when asynchronous errors occur.
 * 
 * @see FrameworkEvent
 * @NotThreadSafe
 * @author $Id: a8e5255b2b18c9ba60cf82d6e16a296667017399 $
 */
@ConsumerType
@FunctionalInterface
public interface FrameworkListener extends EventListener {

	/**
	 * Receives notification of a general {@code FrameworkEvent} object.
	 * 
	 * @param event The {@code FrameworkEvent} object.
	 */
	public void frameworkEvent(FrameworkEvent event);
}