|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BundleDescription
This class represents a specific version of a bundle in the system.
This interface is not intended to be implemented by clients. The
StateObjectFactory
should be used to construct instances.
Method Summary | |
---|---|
boolean |
attachFragments()
Returns true if this bundle allows fragments to attach |
boolean |
dynamicFragments()
Returns true if this bundle allows fragments to attach dynamically after it has been resolved. |
long |
getBundleId()
Returns the numeric id of this bundle. |
State |
getContainingState()
Returns the state object which hosts this bundle. null is returned if this bundle is not currently in a state. |
BundleDescription[] |
getDependents()
Returns all bundles which depend on this bundle. |
java.lang.String[] |
getExecutionEnvironments()
Returns the list of execution environments that are required by this bundle. |
ExportPackageDescription[] |
getExportPackages()
Returns an array of export package descriptions defined by the Export-Package clauses. |
BundleDescription[] |
getFragments()
Returns all fragments known to this bundle (regardless resolution status). |
GenericDescription[] |
getGenericCapabilities()
Returns an array of generic descriptions for the capabilities of this bundle. |
GenericSpecification[] |
getGenericRequires()
Returns an array of generic specifications constraints required by this bundle. |
HostSpecification |
getHost()
Returns the host for this bundle. null is returned if this bundle is not a fragment. |
ImportPackageSpecification[] |
getImportPackages()
Returns an array of import package specifications defined by the Import-Package clause. |
java.lang.String |
getLocation()
The location string for this bundle. |
NativeCodeSpecification |
getNativeCodeSpecification()
Returns the native code specification for this bundle. |
java.lang.String |
getPlatformFilter()
Returns the platform filter in the form of an LDAP filter |
BundleSpecification[] |
getRequiredBundles()
Returns an array of bundle specifications defined by the Require-Bundle clause in this bundle. |
ExportPackageDescription[] |
getResolvedImports()
Returns all the export packages that satisfy all the imported packages for this bundle. |
BundleDescription[] |
getResolvedRequires()
Returns all the bundle descriptions that satisfy all the require bundles for this bundle. |
ExportPackageDescription[] |
getSelectedExports()
Returns all the exported packages from this bundle that have been selected by the resolver. |
ExportPackageDescription[] |
getSubstitutedExports()
Returns the export packages that satisfy imported packages for this bundle description and substitute one of the exports for this bundle description. |
java.lang.String |
getSymbolicName()
Gets the Bundle-SymbolicName of this BundleDescription. |
java.lang.Object |
getUserObject()
Returns the user object associated to this bundle description, or null if none exists. |
boolean |
hasDynamicImports()
Returns true if this bundle has one or more dynamically imported packages. |
boolean |
isRemovalPending()
Returns whether this bundle is pending a removal. |
boolean |
isResolved()
Returns true if this bundle is resolved in its host state. |
boolean |
isSingleton()
Returns whether this bundle is a singleton. |
void |
setUserObject(java.lang.Object userObject)
Associates a user-provided object to this bundle description, or removes an existing association, if null is provided. |
java.lang.String |
toString()
Returns the string representation of this bundle. |
Methods inherited from interface org.eclipse.osgi.service.resolver.BaseDescription |
---|
getName, getSupplier, getVersion |
Method Detail |
---|
java.lang.String getSymbolicName()
BaseDescription.getName()
.
java.lang.String getLocation()
BundleSpecification[] getRequiredBundles()
ExportPackageDescription[] getExportPackages()
ImportPackageSpecification[] getImportPackages()
GenericSpecification[] getGenericRequires()
GenericDescription[] getGenericCapabilities()
boolean hasDynamicImports()
ExportPackageDescription[] getSelectedExports()
getExportPackages()
that have been selected by the resolver and
packages which are propagated by this bundle.
BundleDescription[] getResolvedRequires()
ExportPackageDescription[] getResolvedImports()
boolean isResolved()
State getContainingState()
java.lang.String toString()
toString
in class java.lang.Object
HostSpecification getHost()
long getBundleId()
BundleDescription[] getFragments()
boolean isSingleton()
The existence of a single bundle marked as singleton causes all bundles with the same symbolic name to be treated as singletons as well.
true
, if this bundle is a singleton,
false
otherwiseboolean isRemovalPending()
true
, if this bundle is pending a removal,
false
otherwiseBundleDescription[] getDependents()
java.lang.Object getUserObject()
null
if none exists.
null
void setUserObject(java.lang.Object userObject)
null
is provided. The
provided object is not interpreted in any ways by this bundle
description.
userObject
- an arbitrary object provided by the user, or
null
java.lang.String getPlatformFilter()
boolean attachFragments()
boolean dynamicFragments()
java.lang.String[] getExecutionEnvironments()
NativeCodeSpecification getNativeCodeSpecification()
null
is returned if there is no native code
specification.
ExportPackageDescription[] getSubstitutedExports()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |