Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright (c) 2003, 2008 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html Contributors: IBM Corporation - initial API and implementation /
 
 package org.eclipse.osgi.service.resolver;

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.

Since:
3.1
Noimplement:
This interface is not intended to be implemented by clients.
 
 public interface BundleDescription extends BaseDescription {

Gets the Bundle-SymbolicName of this BundleDescription. Same as calling BaseDescription.getName().

Returns:
The bundle symbolic name or null if the bundle does not have a symbolic name.
 
 	public String getSymbolicName();

The location string for this bundle.

Returns:
The bundle location or null if the bundle description does not have a location
 
 	public String getLocation();

Returns an array of bundle specifications defined by the Require-Bundle clause in this bundle.

Returns:
an array of bundle specifications
 
Returns an array of export package descriptions defined by the Export-Package clauses. All export package descriptions are returned even if they have not been selected by the resolver as an exporter of the package.

Returns:
an array of export package descriptions
 
Returns an array of import package specifications defined by the Import-Package clause.

Returns:
an array of import package specifications
 
Returns an array of generic specifications constraints required by this bundle.

Returns:
an array of generic specifications
Since:
3.2
 
Returns an array of generic descriptions for the capabilities of this bundle.

Returns:
an array of generic descriptions
Since:
3.2
 
Returns true if this bundle has one or more dynamically imported packages.

Returns:
true if this bundle has one or more dynamically imported packages.
 
 	public boolean hasDynamicImports();

Returns all the exported packages from this bundle that have been selected by the resolver. The returned list will include the ExportPackageDescriptions returned by getExportPackages() that have been selected by the resolver and packages which are propagated by this bundle.

Returns:
the selected list of packages that this bundle exports. If the bundle is unresolved or has no shared packages then an empty array is returned.
 
Returns all the bundle descriptions that satisfy all the require bundles for this bundle. If the bundle is not resolved or the bundle does not require any bundles then an empty array is returned.

Returns:
the bundles descriptions that satisfy all the require bundles for this bundle.
 
Returns all the export packages that satisfy all the imported packages for this bundle. If the bundle is not resolved or the bundle does not import any packages then an empty array is returned.

Returns:
the exported packages that satisfy all the imported packages for this bundle.
Returns true if this bundle is resolved in its host state.

Returns:
true if this bundle is resolved in its host state.
	public boolean isResolved();

Returns the state object which hosts this bundle. null is returned if this bundle is not currently in a state.

Returns:
the state object which hosts this bundle.
Returns the string representation of this bundle.

Returns:
String representation of this bundle.
	public String toString();

Returns the host for this bundle. null is returned if this bundle is not a fragment.

Returns:
the host for this bundle.
Returns the numeric id of this bundle. Typically a bundle description will only have a numeric id if it represents a bundle that is installed in a framework as the framework assigns the ids. -1 is returned if the id is not known.

Returns:
the numeric id of this bundle description
	public long getBundleId();

Returns all fragments known to this bundle (regardless resolution status).

Returns:
an array of BundleDescriptions containing all known fragments
Returns whether this bundle is a singleton. Singleton bundles require that at most one single version of the bundle can be resolved at a time.

The existence of a single bundle marked as singleton causes all bundles with the same symbolic name to be treated as singletons as well.

Returns:
true, if this bundle is a singleton, false otherwise
	public boolean isSingleton();

Returns whether this bundle is pending a removal. A bundle is pending removal if it has been removed from the state but other bundles in the state currently depend on it.

Returns:
true, if this bundle is pending a removal, false otherwise
	public boolean isRemovalPending();

Returns all bundles which depend on this bundle. A bundle depends on another bundle if it requires the bundle, imports a package which is exported by the bundle, is a fragment to the bundle or is the host of the bundle.

Returns:
all bundles which depend on this bundle.
Returns the user object associated to this bundle description, or null if none exists.

Returns:
the user object associated to this bundle description, or null
	public Object getUserObject();

Associates a user-provided object to this bundle description, or removes an existing association, if null is provided. The provided object is not interpreted in any ways by this bundle description.

Parameters:
userObject an arbitrary object provided by the user, or null
	public void setUserObject(Object userObject);

Returns the platform filter in the form of an LDAP filter

Returns:
the platfomr filter in the form of an LDAP filter
Returns true if this bundle allows fragments to attach

Returns:
true if this bundle allows fragments to attach
	public boolean attachFragments();

Returns true if this bundle allows fragments to attach dynamically after it has been resolved.

Returns:
true if this bundle allows fragments to attach dynamically
	public boolean dynamicFragments();

Returns the list of execution environments that are required by this bundle. Any one of the listed execution environments will allow this bundle to be resolved.

Returns:
the list of execution environments that are required.
Since:
3.2
Returns the native code specification for this bundle. A value of null is returned if there is no native code specification.

Returns:
the native code specification.
Since:
3.4
Returns the export packages that satisfy imported packages for this bundle description and substitute one of the exports for this bundle description. If the bundle is not resolved or the bundle does not have substituted exports then an empty array is returned.

Returns:
all substituted exports for this bundle description
Since:
3.4
New to GrepCode? Check out our FAQ X