org.osgi.service.packageadmin.ExportedPackage Maven / Gradle / Ivy
/*
* Copyright (c) OSGi Alliance (2001, 2011). 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.packageadmin;
import org.osgi.framework.Bundle;
import org.osgi.framework.Version;
/**
* An exported package.
*
* Objects implementing this interface are created by the Package Admin service.
*
*
* The term exported package refers to a package that has been exported
* from a resolved bundle. This package may or may not be currently wired to
* other bundles.
*
*
* The information about an exported package provided by this object may change.
* An {@code ExportedPackage} object becomes stale if the package it
* references has been updated or removed as a result of calling
* {@code PackageAdmin.refreshPackages()}.
*
* If this object becomes stale, its {@code getName()} and
* {@code getVersion()} methods continue to return their original values,
* {@code isRemovalPending()} returns {@code true}, and
* {@code getExportingBundle()} and {@code getImportingBundles()}
* return {@code null}.
*
* @ThreadSafe
* @noimplement
* @deprecated The PackageAdmin service has been replaced by the
* org.osgi.framework.wiring package.
* @version $Id: 22ce5e8e388107b04edba3aea2f3036b8026798d $
*/
public interface ExportedPackage {
/**
* Returns the name of the package associated with this exported package.
*
* @return The name of this exported package.
*/
public String getName();
/**
* Returns the bundle exporting the package associated with this exported
* package.
*
* @return The exporting bundle, or {@code null} if this
* {@code ExportedPackage} object has become stale.
*/
public Bundle getExportingBundle();
/**
* Returns the resolved bundles that are currently wired to this exported
* package.
*
*
* Bundles which require the exporting bundle associated with this exported
* package are considered to be wired to this exported package are included
* in the returned array. See {@link RequiredBundle#getRequiringBundles()}.
*
* @return The array of resolved bundles currently wired to this exported
* package, or {@code null} if this
* {@code ExportedPackage} object has become stale. The array
* will be empty if no bundles are wired to this exported package.
*/
public Bundle[] getImportingBundles();
/**
* Returns the version of this exported package.
*
* @return The version of this exported package, or {@code null} if no
* version information is available.
* @deprecated As of 1.2, replaced by {@link #getVersion()}.
*/
public String getSpecificationVersion();
/**
* Returns the version of this exported package.
*
* @return The version of this exported package, or
* {@link Version#emptyVersion} if no version information is
* available.
* @since 1.2
*/
public Version getVersion();
/**
* Returns {@code true} if the package associated with this
* {@code ExportedPackage} object has been exported by a bundle that
* has been updated or uninstalled.
*
* @return {@code true} if the associated package is being exported
* by a bundle that has been updated or uninstalled, or if this
* {@code ExportedPackage} object has become stale;
* {@code false} otherwise.
*/
public boolean isRemovalPending();
}