ch.jm.osgi.util.bundle
Class BundleManifestBuilder

java.lang.Object
  ch.jm.osgi.util.bundle.BundleManifestBuilder

All Implemented Interfaces:

BundleConstants

public class BundleManifestBuilder
extends java.lang.Object
implements BundleConstants

This class builds manifests for OSGi bundles.

Field Summary

Fields inherited from interface ch.jm.osgi.util.bundle.BundleConstants

BUNDLE_ACTIVATOR, BUNDLE_CATEGORY, BUNDLE_CLASSPATH, BUNDLE_DESCRIPTION, BUNDLE_MANIFEST_VERSION, BUNDLE_NAME, BUNDLE_SYMBOLIC_NAME, BUNDLE_VERSION, EXPORT_PACKAGE, IMPORT_PACKAGE

Constructor Summary

BundleManifestBuilder()

Method Summary

void	addExportedPackage(java.lang.String packageName, java.lang.String version) Adds an exported package.
void	addExportedPackages(java.util.regex.Pattern pattern, java.lang.String version) Adds exported packages.
void	addNeededImports(java.util.Collection<java.lang.String> packages) Adds needed import packages.
void	addPrivatePackages(java.util.Set<java.lang.String> own) Adds private packages.
void	addVersionsToExports() Adds the bundle version to all export packages.
static void	checkAttributeName(java.lang.String name) Checks an attribute for validity.
java.lang.String	getBundleActivator() Returns the bundle's activator class.
java.util.Collection<java.lang.String>	getBundleClassPath() Returns the bundle classpath.
java.util.Map<java.lang.String,java.lang.String>	getEntries() Retrieves all manifest entries.
java.lang.String	getEntry(java.lang.String name) Gets a single manifest entry.
java.util.Collection<Clause>	getExportPackage() Retrieves all exported packages.
Clause	getExportPackage(java.lang.String packageName) Retrieves the clause representing the exported package.
java.util.Collection<Clause>	getImportPackage() Retrieves all imported packages.
java.lang.String	getName() Returns the bundle name.
java.lang.String	getSymbolicName() Gets the bundle's symbolic name
java.lang.String	getVersion() Returns the bundle version.
void	mergeNeededImport(Clause c) Merges a needed import into the existing ones.
void	putEntry(java.lang.String name, java.lang.String value) Puts an arbitrary manifest entry.
void	setBundleActivator(java.lang.String className) Sets the bundle's activator class.
void	setBundleClassPath(java.util.Collection<java.io.File> classPath) Sets the bundle classpath.
void	setName(java.lang.String name) Sets the bundle name.
void	setSymbolicName(java.lang.String symbolicName) Sets the bundle's symbolic name
void	setVersion(java.lang.String version) Sets the bundle version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BundleManifestBuilder

public BundleManifestBuilder()

Method Detail

mergeNeededImport

public void mergeNeededImport(Clause c)

Merges a needed import into the existing ones.

Parameters:

c - the import clause

addNeededImports

public void addNeededImports(java.util.Collection<java.lang.String> packages)

Adds needed import packages.

Parameters:

packages - the collection of package names

addPrivatePackages

public void addPrivatePackages(java.util.Set<java.lang.String> own)

Adds private packages.

Parameters:

own - the set of private package names

addExportedPackages

public void addExportedPackages(java.util.regex.Pattern pattern,
                                java.lang.String version)

Adds exported packages.

Parameters:

pattern - a regular expression identifying the packages to export

version - the version under which the packages are exported (may be null)

addExportedPackage

public void addExportedPackage(java.lang.String packageName,
                               java.lang.String version)

Adds an exported package.

Parameters:

packageName - the package name

version - the package version (may be null)

getExportPackage

public Clause getExportPackage(java.lang.String packageName)

Retrieves the clause representing the exported package.

Parameters:

packageName - the package name

Returns:

the export clause or null if the clause was not found

addVersionsToExports

public void addVersionsToExports()

Adds the bundle version to all export packages.

getImportPackage

public java.util.Collection<Clause> getImportPackage()

Retrieves all imported packages.

Returns:

the imported packages

getExportPackage

public java.util.Collection<Clause> getExportPackage()

Retrieves all exported packages.

Returns:

the exported packages

setBundleClassPath

public void setBundleClassPath(java.util.Collection<java.io.File> classPath)

Sets the bundle classpath.

Parameters:

classPath - a set of JAR files

getBundleClassPath

public java.util.Collection<java.lang.String> getBundleClassPath()

Returns the bundle classpath.

Returns:

the bundle classpath

checkAttributeName

public static void checkAttributeName(java.lang.String name)

Checks an attribute for validity.

Parameters:

name - the attribute name

Throws:

java.lang.IllegalArgumentException - if the attribute name is invalid

putEntry

public void putEntry(java.lang.String name,
                     java.lang.String value)

Puts an arbitrary manifest entry.

Parameters:

name - the name of the entry

value - the entry's value

getEntries

public java.util.Map<java.lang.String,java.lang.String> getEntries()

Retrieves all manifest entries.

Returns:

the manifest entries

getEntry

public java.lang.String getEntry(java.lang.String name)

Gets a single manifest entry.

Parameters:

name - the entry name

Returns:

the value (or null if not present)

setName

public void setName(java.lang.String name)

Sets the bundle name.

Parameters:

name - the bundle name

getName

public java.lang.String getName()

Returns the bundle name.

Returns:

the bundle name

setSymbolicName

public void setSymbolicName(java.lang.String symbolicName)

Sets the bundle's symbolic name

Parameters:

symbolicName - the symbolic name

getSymbolicName

public java.lang.String getSymbolicName()

Gets the bundle's symbolic name

Returns:

the symbolic name

setVersion

public void setVersion(java.lang.String version)

Sets the bundle version.

Parameters:

version - the bundle version

getVersion

public java.lang.String getVersion()

Returns the bundle version.

Returns:

the bundle version

setBundleActivator

public void setBundleActivator(java.lang.String className)

Sets the bundle's activator class.

Parameters:

className - the activator class name

getBundleActivator

public java.lang.String getBundleActivator()

Returns the bundle's activator class.

Returns:

the activator class name