org.jboss.osgi.metadata

Class OSGiMetaDataBuilder

java.lang.Object

org.jboss.osgi.metadata.OSGiMetaDataBuilder

public final class OSGiMetaDataBuilder
extends Object

A builder for OSGiMetaData.

Since:

04-Jun-2010

Author:

Thomas.Diesler@jboss.com

Method Summary

Modifier and Type	Method and Description
OSGiMetaDataBuilder	addDynamicImportPackages(Class<?>... packages)
OSGiMetaDataBuilder	addDynamicImportPackages(String... packages)
OSGiMetaDataBuilder	addExportPackages(Class<?>... packages)
OSGiMetaDataBuilder	addExportPackages(String... packages)
OSGiMetaDataBuilder	addImportPackages(Class<?>... packages)
OSGiMetaDataBuilder	addImportPackages(String... packages)
OSGiMetaDataBuilder	addMainAttribute(String key, String value)
OSGiMetaDataBuilder	addProvidedCapabilities(String... capabilities)
OSGiMetaDataBuilder	addRequiredBundles(String... required)
OSGiMetaDataBuilder	addRequiredCapabilities(String... capabilities)
OSGiMetaDataBuilder	addRequiredExecutionEnvironments(String... envspecs)
static org.osgi.framework.Filter	convertExecutionEnvironmentHeader(List<String> envspecs) Convert the deprecated Bundle-RequiredExecutionEnvironment header to the R5 osgi.ee format
static void	convertExecutionEnvironmentHeader(String envspec, StringBuffer namepart, StringBuffer versionpart) Convert the deprecated Bundle-RequiredExecutionEnvironment header to the R5 osgi.ee format
static OSGiMetaDataBuilder	createBuilder(Dictionary<String,String> headers)
static OSGiMetaDataBuilder	createBuilder(String symbolicName)
static OSGiMetaDataBuilder	createBuilder(String symbolicName, org.osgi.framework.Version version)
OSGiMetaData	getAndValidateMetaData()
OSGiMetaData	getOSGiMetaData()
static boolean	isValidMetadata(OSGiMetaData metadata) Validate a given OSGi metadata.
static OSGiMetaData	load(Manifest manifest)
static OSGiMetaData	load(Properties props)
OSGiMetaDataBuilder	setBundleActivator(String value)
OSGiMetaDataBuilder	setBundleManifestVersion(int version)
static void	validateMetadata(OSGiMetaData metadata) Validate a given OSGi metadata.

Methods inherited from class java.lang.Object

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

Method Detail

createBuilder

public static OSGiMetaDataBuilder createBuilder(String symbolicName)

createBuilder

public static OSGiMetaDataBuilder createBuilder(String symbolicName,
                                                org.osgi.framework.Version version)

createBuilder

public static OSGiMetaDataBuilder createBuilder(Dictionary<String,String> headers)

load

public static OSGiMetaData load(Properties props)

load

public static OSGiMetaData load(Manifest manifest)

isValidMetadata

public static boolean isValidMetadata(OSGiMetaData metadata)

Validate a given OSGi metadata.

Parameters:

metadata - The given metadata

Returns:

True if the metadata is valid

validateMetadata

public static void validateMetadata(OSGiMetaData metadata)
                             throws org.osgi.framework.BundleException

Validate a given OSGi metadata.

Parameters:

metadata - The given metadata

Throws:

org.osgi.framework.BundleException - if the given metadata is not a valid

setBundleManifestVersion

public OSGiMetaDataBuilder setBundleManifestVersion(int version)

setBundleActivator

public OSGiMetaDataBuilder setBundleActivator(String value)

addImportPackages

public OSGiMetaDataBuilder addImportPackages(Class<?>... packages)

addImportPackages

public OSGiMetaDataBuilder addImportPackages(String... packages)

addExportPackages

public OSGiMetaDataBuilder addExportPackages(Class<?>... packages)

addExportPackages

public OSGiMetaDataBuilder addExportPackages(String... packages)

addRequiredExecutionEnvironments

public OSGiMetaDataBuilder addRequiredExecutionEnvironments(String... envspecs)

addDynamicImportPackages

public OSGiMetaDataBuilder addDynamicImportPackages(Class<?>... packages)

addDynamicImportPackages

public OSGiMetaDataBuilder addDynamicImportPackages(String... packages)

addRequiredBundles

public OSGiMetaDataBuilder addRequiredBundles(String... required)

addProvidedCapabilities

public OSGiMetaDataBuilder addProvidedCapabilities(String... capabilities)

addRequiredCapabilities

public OSGiMetaDataBuilder addRequiredCapabilities(String... capabilities)

addMainAttribute

public OSGiMetaDataBuilder addMainAttribute(String key,
                                            String value)

getAndValidateMetaData

public OSGiMetaData getAndValidateMetaData()
                                    throws org.osgi.framework.BundleException

Throws:

org.osgi.framework.BundleException

convertExecutionEnvironmentHeader

public static org.osgi.framework.Filter convertExecutionEnvironmentHeader(List<String> envspecs)

Convert the deprecated Bundle-RequiredExecutionEnvironment header to the R5 osgi.ee format

convertExecutionEnvironmentHeader

public static void convertExecutionEnvironmentHeader(String envspec,
                                                     StringBuffer namepart,
                                                     StringBuffer versionpart)

Convert the deprecated Bundle-RequiredExecutionEnvironment header to the R5 osgi.ee format

getOSGiMetaData

public OSGiMetaData getOSGiMetaData()