aQute.bnd.osgi
Class Domain

java.lang.Object
  aQute.bnd.osgi.Domain

All Implemented Interfaces:

Iterable<String>

Direct Known Subclasses:

Processor

public abstract class Domain
extends Object
implements Iterable<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

Domain()

Method Summary

static Domain	domain(Attributes attrs)
static Domain	domain(Manifest manifest)
static Domain	domain(Map<String,String> map)
static Domain	domain(Processor processor)
abstract String	get(String key)
String	get(String key, String deflt)
String	getBundleActivator()
Parameters	getBundleClasspath()
Parameters	getBundleClassPath()
Parameters	getBundleRequiredExecutionEnvironment()
Map.Entry<String,Attrs>	getBundleSymbolicName()
String	getBundleVersion()
Parameters	getDynamicImportPackage()
Parameters	getExportContents()
Parameters	getExportPackage()
Map.Entry<String,Attrs>	getFragmentHost()
String	getIcon(int requestedSize) Find an icon with the requested size in the list of icons.
Parameters	getImportPackage()
Parameters	getIncludeResource()
Parameters	getParameters(String key)
Parameters	getParameters(String key, Reporter reporter)
Parameters	getParameters(String key, String deflt)
Parameters	getParameters(String key, String deflt, Reporter reporter)
Parameters	getPrivatePackage()
Parameters	getProvideCapability()
Parameters	getRequireBundle()
Parameters	getRequireCapability()
boolean	isFailOk() Indicates that this run should ignore errors and succeed anyway
boolean	isSources()
abstract Iterator<String>	iterator()
abstract void	set(String key, String value)
void	setBundleActivator(String s)
void	setBundleClasspath(String s)
void	setBundleRequiredExecutionEnvironment(String s)
void	setBundleSymbolicName(String s)
void	setBundleVersion(String version)
void	setBundleVersion(Version version)
void	setConditionalPackage(String string)
void	setExportPackage(String s)
void	setFailOk(boolean b)
void	setImportPackage(String s)
void	setIncludeResource(String s)
void	setPrivatePackage(String s)
void	setSources(boolean b)
void	setTranslation(Jar jar)
String	translate(String key)
String	translate(String key, String deflt)

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 String get(String key)

get

public String get(String key,
                  String deflt)

translate

public String translate(String key)

translate

public String translate(String key,
                        String deflt)

set

public abstract void set(String key,
                         String value)

iterator

public abstract Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

domain

public static Domain domain(Manifest manifest)

domain

public static Domain domain(Attributes attrs)

domain

public static Domain domain(Processor processor)

domain

public static Domain domain(Map<String,String> map)

getParameters

public Parameters getParameters(String key,
                                Reporter reporter)

getParameters

public Parameters getParameters(String key)

getParameters

public Parameters getParameters(String key,
                                String deflt)

getParameters

public Parameters getParameters(String key,
                                String deflt,
                                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 String getBundleActivator()

setPrivatePackage

public void setPrivatePackage(String s)

setIncludeResource

public void setIncludeResource(String s)

setBundleActivator

public void setBundleActivator(String s)

setExportPackage

public void setExportPackage(String s)

setImportPackage

public void setImportPackage(String s)

setBundleClasspath

public void setBundleClasspath(String s)

getBundleClasspath

public Parameters getBundleClasspath()

setBundleRequiredExecutionEnvironment

public void setBundleRequiredExecutionEnvironment(String s)

getBundleRequiredExecutionEnvironment

public Parameters getBundleRequiredExecutionEnvironment()

setSources

public void setSources(boolean b)

isSources

public boolean isSources()

getBundleSymbolicName

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

getFragmentHost

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

setBundleSymbolicName

public void setBundleSymbolicName(String s)

getBundleVersion

public String getBundleVersion()

setBundleVersion

public void setBundleVersion(String version)

setBundleVersion

public void setBundleVersion(Version version)

setFailOk

public void setFailOk(boolean b)

isFailOk

public boolean isFailOk()

Indicates that this run should ignore errors and succeed anyway

Returns:

true if this processor should return errors

getIcon

public String getIcon(int requestedSize)
               throws 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:

Exception

setConditionalPackage

public void setConditionalPackage(String string)

setTranslation

public void setTranslation(Jar jar)
                    throws Exception

Throws:

Exception

getRequireCapability

public Parameters getRequireCapability()

getProvideCapability

public Parameters getProvideCapability()