org.osgi.core 6.0.0 · org.osgi.service.packageadmin.RequiredBundle

A required bundle. Objects implementing this interface are created by the Package Admin service.

The term required bundle refers to a resolved bundle that has a bundle symbolic name and is not a fragment. That is, a bundle that may be required by other bundles. This bundle may or may not be currently required by other bundles.

The information about a required bundle provided by this object may change. A RequiredBundle object becomes stale if an exported package of the bundle it references has been updated or removed as a result of calling PackageAdmin.refreshPackages()). If this object becomes stale, its getSymbolicName() and getVersion() methods continue to return their original values, isRemovalPending() returns true, and getBundle() and getRequiringBundles() return null.

Method Summary

Modifier and Type	Method and Description
public Bundle	Returns: The bundle, or `null` if this `RequiredBundle` object has become stale. getBundle() Returns the bundle associated with this required bundle.
public Bundle[]	Returns: An array of bundles currently requiring this required bundle, or `null` if this `RequiredBundle` object has become stale. The array will be empty if no bundles require this required package. getRequiringBundles() Returns the bundles that currently require this required bundle.
public String	Returns: The symbolic name of this required bundle. getSymbolicName() Returns the symbolic name of this required bundle.
public Version	Returns: The version of this required bundle, or `Version#emptyVersion` if no version information is available. getVersion() Returns the version of this required bundle.
public boolean	Returns: `true` if the required bundle has been updated or uninstalled, or if the `RequiredBundle` object has become stale; `false` otherwise. isRemovalPending() Returns `true` if the bundle associated with this `RequiredBundle` object has been updated or uninstalled.

Method Detail

getBundle back to summary

getBundle	back to summary
public Bundle getBundle() Returns the bundle associated with this required bundle. Returns:Bundle The bundle, or `null` if this `RequiredBundle` object has become stale.

public Bundle getBundle()

Returns the bundle associated with this required bundle.

Returns:Bundle: The bundle, or null if this RequiredBundle object has become stale.

getRequiringBundles back to summary

getRequiringBundles	back to summary
public Bundle[] getRequiringBundles() Returns the bundles that currently require this required bundle. If this required bundle is required and then re-exported by another bundle then all the requiring bundles of the re-exporting bundle are included in the returned array. Returns:Bundle[] An array of bundles currently requiring this required bundle, or `null` if this `RequiredBundle` object has become stale. The array will be empty if no bundles require this required package.

public Bundle[] getRequiringBundles()

Returns the bundles that currently require this required bundle.

If this required bundle is required and then re-exported by another bundle then all the requiring bundles of the re-exporting bundle are included in the returned array.

Returns:Bundle[]: An array of bundles currently requiring this required bundle, or null if this RequiredBundle object has become stale. The array will be empty if no bundles require this required package.

getSymbolicName	back to summary
public String getSymbolicName() Returns the symbolic name of this required bundle. Returns:String The symbolic name of this required bundle.

getSymbolicName

back to summary

public String getSymbolicName()

Returns the symbolic name of this required bundle.

Returns:String: The symbolic name of this required bundle.

getVersion back to summary

getVersion	back to summary
public Version getVersion() Returns the version of this required bundle. Returns:Version The version of this required bundle, or `Version#emptyVersion` if no version information is available.

public Version getVersion()

Returns the version of this required bundle.

Returns:Version: The version of this required bundle, or Version#emptyVersion if no version information is available.

isRemovalPending back to summary

isRemovalPending	back to summary
public boolean isRemovalPending() Returns `true` if the bundle associated with this `RequiredBundle` object has been updated or uninstalled. Returns:boolean `true` if the required bundle has been updated or uninstalled, or if the `RequiredBundle` object has become stale; `false` otherwise.

public boolean isRemovalPending()

Returns true if the bundle associated with this RequiredBundle object has been updated or uninstalled.

Returns:boolean: true if the required bundle has been updated or uninstalled, or if the RequiredBundle object has become stale; false otherwise.

public Interface RequiredBundle

Method Summary

Method Detail