Package aQute.bnd.osgi

Class Domain

java.lang.Object

aQute.bnd.osgi.Domain

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

Direct Known Subclasses:

Processor

public abstract class Domain
extends java.lang.Object
implements java.lang.Iterable<java.lang.String>

This class abstracts domains that have properties holding OSGi meta data. It provides access to the keys, the set method and the get method. It then provides convenient methods to access these properties via semantic methods.

Constructor Summary

Constructors

Constructor	Description
Domain()

Method Summary

Modifier and Type	Method	Description
void	copyFrom(Domain domain)
static Domain	domain(Processor processor)
static Domain	domain(java.io.File file)
static Domain	domain(java.util.jar.Attributes attrs)
static Domain	domain(java.util.jar.Manifest manifest)
static Domain	domain(java.util.Map<java.lang.String,java.lang.String> map)
abstract java.lang.String	get(java.lang.String key)
java.lang.String	get(java.lang.String key, java.lang.String deflt)
java.lang.String	getBundleActivator()
java.lang.String	getBundleCategory()
Parameters	getBundleClasspath()
Parameters	getBundleClassPath()
java.lang.String	getBundleContactAddress()
java.lang.String	getBundleCopyright()
java.lang.String	getBundleDescription()
java.lang.String	getBundleDocURL()
java.lang.String	getBundleName()
java.lang.String	getBundleNative()
Parameters	getBundleRequiredExecutionEnvironment()
java.util.Map.Entry<java.lang.String,Attrs>	getBundleSymbolicName()
java.lang.String	getBundleVendor()
java.lang.String	getBundleVersion()
Parameters	getDynamicImportPackage()
Parameters	getExportContents()
Parameters	getExportPackage()
java.util.Map.Entry<java.lang.String,Attrs>	getFragmentHost()
java.lang.String	getIcon(int requestedSize)	Find an icon with the requested size in the list of icons.
Parameters	getImportPackage()
Parameters	getIncludeResource()
Parameters	getParameters(java.lang.String key)
Parameters	getParameters(java.lang.String key, aQute.service.reporter.Reporter reporter)
Parameters	getParameters(java.lang.String key, java.lang.String deflt)
Parameters	getParameters(java.lang.String key, java.lang.String deflt, aQute.service.reporter.Reporter reporter)
Parameters	getPrivatePackage()
Parameters	getProvideCapability()
Parameters	getRequireBundle()
Parameters	getRequireCapability()
java.lang.String	getRunblacklist()
java.lang.String	getRunee()
boolean	isFailOk()	Indicates that this run should ignore errors and succeed anyway
boolean	isSources()
abstract java.util.Iterator<java.lang.String>	iterator()
abstract void	set(java.lang.String key, java.lang.String value)
void	setAugment(java.lang.String augments)
void	setBundleActivator(java.lang.String s)
void	setBundleClasspath(java.lang.String s)
void	setBundleRequiredExecutionEnvironment(java.lang.String s)
void	setBundleSymbolicName(java.lang.String s)
void	setBundleVersion(Version version)
void	setBundleVersion(java.lang.String version)
void	setConditionalPackage(java.lang.String string)
void	setExportPackage(java.lang.String s)
void	setFailOk(boolean b)
void	setImportPackage(java.lang.String s)
void	setIncludeResource(java.lang.String s)
void	setPrivatePackage(java.lang.String s)
void	setRunblacklist(java.lang.String blacklist)
void	setRunee(java.lang.String string)
void	setRunfw(java.lang.String runfw)
void	setRunRequires(java.lang.String runRq)
void	setSources(boolean b)
void	setTranslation(Jar jar)
java.lang.String	translate(java.lang.String key)
java.lang.String	translate(java.lang.String key, java.lang.String deflt)

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

Domain

public Domain()

Method Detail

get

public abstract java.lang.String get(java.lang.String key)

get

public java.lang.String get(java.lang.String key,
                            java.lang.String deflt)

translate

public java.lang.String translate(java.lang.String key)

translate

public java.lang.String translate(java.lang.String key,
                                  java.lang.String deflt)

set

public abstract void set(java.lang.String key,
                         java.lang.String value)

iterator

public abstract java.util.Iterator<java.lang.String> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

domain

public static Domain domain(java.util.jar.Manifest manifest)

domain

public static Domain domain(java.util.jar.Attributes attrs)

domain

public static Domain domain(Processor processor)

domain

public static Domain domain(java.util.Map<java.lang.String,java.lang.String> map)

getParameters

public Parameters getParameters(java.lang.String key,
                                aQute.service.reporter.Reporter reporter)

getParameters

public Parameters getParameters(java.lang.String key)

getParameters

public Parameters getParameters(java.lang.String key,
                                java.lang.String deflt)

getParameters

public Parameters getParameters(java.lang.String key,
                                java.lang.String deflt,
                                aQute.service.reporter.Reporter reporter)

getRequireBundle

public Parameters getRequireBundle()

getImportPackage

public Parameters getImportPackage()

getExportPackage

public Parameters getExportPackage()

getBundleClassPath

public Parameters getBundleClassPath()

getPrivatePackage

public Parameters getPrivatePackage()

getIncludeResource

public Parameters getIncludeResource()

getDynamicImportPackage

public Parameters getDynamicImportPackage()

getExportContents

public Parameters getExportContents()

getBundleActivator

public java.lang.String getBundleActivator()

setPrivatePackage

public void setPrivatePackage(java.lang.String s)

setIncludeResource

public void setIncludeResource(java.lang.String s)

setBundleActivator

public void setBundleActivator(java.lang.String s)

setExportPackage

public void setExportPackage(java.lang.String s)

setImportPackage

public void setImportPackage(java.lang.String s)

setBundleClasspath

public void setBundleClasspath(java.lang.String s)

getBundleClasspath

public Parameters getBundleClasspath()

setBundleRequiredExecutionEnvironment

public void setBundleRequiredExecutionEnvironment(java.lang.String s)

getBundleRequiredExecutionEnvironment

public Parameters getBundleRequiredExecutionEnvironment()

setSources

public void setSources(boolean b)

isSources

public boolean isSources()

getBundleSymbolicName

public java.util.Map.Entry<java.lang.String,Attrs> getBundleSymbolicName()

getFragmentHost

public java.util.Map.Entry<java.lang.String,Attrs> getFragmentHost()

setBundleSymbolicName

public void setBundleSymbolicName(java.lang.String s)

getBundleVersion

public java.lang.String getBundleVersion()

setBundleVersion

public void setBundleVersion(java.lang.String version)

setBundleVersion

public void setBundleVersion(Version version)

setFailOk

public void setFailOk(boolean b)

setRunfw

public void setRunfw(java.lang.String runfw)

setRunRequires

public void setRunRequires(java.lang.String runRq)

setAugment

public void setAugment(java.lang.String augments)

isFailOk

public boolean isFailOk()

Indicates that this run should ignore errors and succeed anyway

Returns:

true if this processor should return errors

getIcon

public java.lang.String getIcon(int requestedSize)
                         throws java.lang.Exception

Find an icon with the requested size in the list of icons.

Parameters:

requestedSize - the number of pixels desired

Returns:

null or a the selected URI (which may be relative)

Throws:

java.lang.Exception

setConditionalPackage

public void setConditionalPackage(java.lang.String string)

setRunblacklist

public void setRunblacklist(java.lang.String blacklist)

getRunblacklist

public java.lang.String getRunblacklist()

setRunee

public void setRunee(java.lang.String string)

getRunee

public java.lang.String getRunee()

setTranslation

public void setTranslation(Jar jar)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getRequireCapability

public Parameters getRequireCapability()

getProvideCapability

public Parameters getProvideCapability()

domain

public static Domain domain(java.io.File file)
                     throws java.io.IOException

Throws:

java.io.IOException

getBundleName

public java.lang.String getBundleName()

getBundleDescription

public java.lang.String getBundleDescription()

getBundleCopyright

public java.lang.String getBundleCopyright()

getBundleDocURL

public java.lang.String getBundleDocURL()

getBundleVendor

public java.lang.String getBundleVendor()

getBundleContactAddress

public java.lang.String getBundleContactAddress()

getBundleCategory

public java.lang.String getBundleCategory()

getBundleNative

public java.lang.String getBundleNative()

copyFrom

public void copyFrom(Domain domain)