Eclipse Platform
Release 4.2

org.eclipse.equinox.frameworkadmin
Class BundleInfo

java.lang.Object
  extended by org.eclipse.equinox.frameworkadmin.BundleInfo

public class BundleInfo
extends Object

This object represents information of a bundle.

Since:
2.0

Field Summary
static String EMPTY_VERSION
           
static int NO_BUNDLEID
           
static int NO_LEVEL
           
 
Constructor Summary
BundleInfo()
          Create a new BundleInfo object
BundleInfo(String symbolic, String version, URI location, int startLevel, boolean started)
          Create a new BundleInfo object
BundleInfo(URI location)
          Create a new BundleInfo object
BundleInfo(URI location, int startLevel, boolean started)
          Create a new BundleInfo object
 
Method Summary
 boolean equals(Object obj)
           
 URI getBaseLocation()
          The base location An absolute URI which may be used to resolve relative getLocation() URIs
 long getBundleId()
          Get the bundle id
 String getFragmentHost()
          Return the host if this bundle is a fragment
 URI getLocation()
          The location of this bundle.
 String getManifest()
          The manifest for this bundle
 int getStartLevel()
          The start level for this bundle
 String getSymbolicName()
          The Bundle-SymbolicName for this bundle.
 String getVersion()
          Return the version
 int hashCode()
           
 boolean isMarkedAsStarted()
          Whether or not this bundle is marked to be started Default is false
 boolean isResolved()
          Whether or not this bundle is resolved Default is false
 void setBaseLocation(URI baseLocation)
          Set a base location against which relative getLocation() URIs may be resolved
 void setBundleId(long bundleId)
          Set the bundle id
 void setFragmentHost(String fragmentHost)
          Set the host if this bundle is a fragment
 void setLocation(URI location)
          Set the location for this bundle.
 void setManifest(String manifest)
          Set the manifest for this bundle
 void setMarkedAsStarted(boolean markedAsStarted)
          Set whether or not this bundle should be started
 void setResolved(boolean resolved)
          Set whether or not the bundle is resolved
 void setStartLevel(int level)
          Set the start level.
 void setSymbolicName(String symbolicName)
          Set the Bundle-SymbolicName
 void setVersion(String value)
          Set the version, should be a valid Version string
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY_VERSION

public static final String EMPTY_VERSION
See Also:
Constant Field Values

NO_LEVEL

public static final int NO_LEVEL
See Also:
Constant Field Values

NO_BUNDLEID

public static final int NO_BUNDLEID
See Also:
Constant Field Values
Constructor Detail

BundleInfo

public BundleInfo()
Create a new BundleInfo object


BundleInfo

public BundleInfo(URI location)
Create a new BundleInfo object

Parameters:
location - - the location of the bundle

BundleInfo

public BundleInfo(URI location,
                  int startLevel,
                  boolean started)
Create a new BundleInfo object

Parameters:
location - - the location of the bundle
startLevel - - the start to be used or NO_LEVEL
started - - whether or not the bundle should be started

BundleInfo

public BundleInfo(String symbolic,
                  String version,
                  URI location,
                  int startLevel,
                  boolean started)
Create a new BundleInfo object

Parameters:
symbolic - The Bundle-SymbolicName name for this bundle
version - - The version for this bundle, this must be a valid Version string, if null is passed EMPTY_VERSION will be used instead
location - - the location of the bundle
startLevel - - the start level of the bundle or NO_LEVEL
started - - whether or not the bundle should be started
Method Detail

getBundleId

public long getBundleId()
Get the bundle id

Returns:
the bundle id or NO_BUNDLEID

getBaseLocation

public URI getBaseLocation()
The base location An absolute URI which may be used to resolve relative getLocation() URIs

Returns:
absolute URI or null if not set

getLocation

public URI getLocation()
The location of this bundle. A location is required if this bundle will be persisted into a configuration file

Returns:
URI location or null if not set

getManifest

public String getManifest()
The manifest for this bundle

Returns:
the manifest or null if not set

getStartLevel

public int getStartLevel()
The start level for this bundle

Returns:
the start level or NO_LEVEL

getSymbolicName

public String getSymbolicName()
The Bundle-SymbolicName for this bundle. A symbolic name is required if this bundle will be persisted into a configuration file

Returns:
the symbolic name or null if not set

getVersion

public String getVersion()
Return the version

Returns:
an Version string, or "0.0.0" if not set

getFragmentHost

public String getFragmentHost()
Return the host if this bundle is a fragment

Returns:
the host, or null if this is not a fragment

isMarkedAsStarted

public boolean isMarkedAsStarted()
Whether or not this bundle is marked to be started Default is false

Returns:
boolean

isResolved

public boolean isResolved()
Whether or not this bundle is resolved Default is false

Returns:
boolean

setBundleId

public void setBundleId(long bundleId)
Set the bundle id

Parameters:
bundleId -

setBaseLocation

public void setBaseLocation(URI baseLocation)
Set a base location against which relative getLocation() URIs may be resolved

Parameters:
baseLocation - - an absolute URI

setLocation

public void setLocation(URI location)
Set the location for this bundle.

Parameters:
location -

setManifest

public void setManifest(String manifest)
Set the manifest for this bundle

Parameters:
manifest -

setMarkedAsStarted

public void setMarkedAsStarted(boolean markedAsStarted)
Set whether or not this bundle should be started

Parameters:
markedAsStarted -

setResolved

public void setResolved(boolean resolved)
Set whether or not the bundle is resolved

Parameters:
resolved -

setStartLevel

public void setStartLevel(int level)
Set the start level.

Parameters:
level - if a value < 0 is passed, the start level will be set to NO_LEVEL

setSymbolicName

public void setSymbolicName(String symbolicName)
Set the Bundle-SymbolicName

Parameters:
symbolicName -

setVersion

public void setVersion(String value)
Set the version, should be a valid Version string

Parameters:
value -

setFragmentHost

public void setFragmentHost(String fragmentHost)
Set the host if this bundle is a fragment

Parameters:
fragmentHost -

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

Eclipse Platform
Release 4.2

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2013. All rights reserved.