aQute.bnd.build.model

Class BndEditModel

java.lang.Object

aQute.bnd.build.model.BndEditModel

public class BndEditModel
extends Object

A model for a Bnd file. In the first iteration, use a simple Properties object; this will need to be enhanced to additionally record formatting, e.g. line breaks and empty lines, and comments.

Author:

Neil Bartlett

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUNDLE_VERSION_MACRO
static String	LIST_SEPARATOR
static String	NEWLINE_LINE_SEPARATOR
static String	PROP_WORKSPACE

Constructor Summary

Constructors

Constructor and Description
BndEditModel()
BndEditModel(BndEditModel model)
BndEditModel(IDocument document)
BndEditModel(Project project)
BndEditModel(Workspace workspace)

Method Summary

Modifier and Type	Method and Description
void	addBundleBlueprint(String location)
void	addExportedPackage(ExportedPackage export)
void	addIncludeResource(String resource)
void	addPrivatePackage(String packageName)
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Object	genericGet(String propertyName)
void	genericSet(String propertyName, Object value)
List<String>	getAllPropertyNames()
File	getBndResource()
String	getBndResourceName()
List<VersionedClause>	getBuildPackages() Deprecated.
List<VersionedClause>	getBuildPath()
String	getBundleActivator()
List<HeaderClause>	getBundleBlueprint()
String	getBundleCategory()
String	getBundleContactAddress()
String	getBundleCopyright()
String	getBundleDescription()
String	getBundleDocUrl()
String	getBundleLicense()
String	getBundleName()
String	getBundleSymbolicName()
String	getBundleUpdateLocation()
String	getBundleVendor()
String	getBundleVersionString()
List<String>	getClassPath()
List<String>	getDistro()
Map<String,String>	getDocumentChanges() Return the saved changes in document format.
List<String>	getDSAnnotationPatterns()
EE	getEE()
List<ExportedPackage>	getExportedPackages()
String	getGenericString(String name)
List<HeaderClause>	getIgnoreStandalone()
List<ImportPattern>	getImportPatterns()
List<String>	getIncludeResource()
String	getOutputFile()
List<String>	getPluginPath()
List<HeaderClause>	getPlugins()
List<String>	getPrivatePackages()
Project	getProject()
Processor	getProperties() Return a processor for this model.
List<org.osgi.resource.Requirement>	getRunBlacklist()
List<VersionedClause>	getRunBundles()
String	getRunFramework()
String	getRunFw()
String	getRunProgramArgs()
Map<String,String>	getRunProperties()
List<String>	getRunRepos()
List<org.osgi.resource.Requirement>	getRunRequires()
String	getRunVMArgs()
List<ServiceComponent>	getServiceComponents()
List<HeaderClause>	getStandaloneLinks()
List<String>	getSubBndFiles()
List<ExportedPackage>	getSystemPackages()
List<VersionedClause>	getTestPath()
List<String>	getTestSuites()
Workspace	getWorkspace()
boolean	isBndrun()
boolean	isIncludedPackage(String packageName)
boolean	isIncludeSources()
boolean	isProjectFile()
void	loadFrom(File file)
void	loadFrom(IDocument document)
void	loadFrom(InputStream inputStream)
Converter<Object,String>	lookupConverter(String propertyName)
Converter<String,Object>	lookupFormatter(String propertyName)
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	saveChanges() If this BndEditModel was created with a project then this method will save the changes in the document and will store them in the associated file.
void	saveChangesTo(IDocument document)
void	setBndResource(File bndResource)
void	setBndResourceName(String bndResourceName)
void	setBuildPackages(List<? extends VersionedClause> paths) Deprecated.
void	setBuildPath(List<? extends VersionedClause> paths)
void	setBundleActivator(String bundleActivator)
void	setBundleBlueprint(List<HeaderClause> bundleBlueprint)
void	setBundleCategory(String bundleCategory)
void	setBundleContactAddress(String bundleContactAddress)
void	setBundleCopyright(String bundleCopyright)
void	setBundleDescription(String bundleDescription)
void	setBundleDocUrl(String bundleDocUrl)
void	setBundleLicense(String bundleLicense)
void	setBundleName(String bundleName)
void	setBundleSymbolicName(String bundleSymbolicName)
void	setBundleUpdateLocation(String bundleUpdateLocation)
void	setBundleVendor(String bundleVendor)
void	setBundleVersion(String bundleVersion)
void	setClassPath(List<? extends String> classPath)
void	setDistro(List<String> distros)
void	setDSAnnotationPatterns(List<? extends String> patterns)
void	setEE(EE ee)
void	setExportedPackages(List<? extends ExportedPackage> exports)
void	setGenericString(String name, String value)
void	setIgnoreStandalone(List<HeaderClause> headers)
void	setImportPatterns(List<? extends ImportPattern> patterns)
void	setIncludeResource(List<String> newEntries)
void	setIncludeSources(boolean includeSources)
void	setOutputFile(String name)
void	setPluginPath(List<String> pluginPath)
void	setPlugins(List<HeaderClause> plugins)
void	setPrivatePackages(List<String> newPackages)
void	setProject(Project project)
void	setRunBlacklist(List<org.osgi.resource.Requirement> requires)
void	setRunBundles(List<? extends VersionedClause> paths)
void	setRunFramework(String clause)
void	setRunFw(String clause)
void	setRunProgramArgs(String args)
void	setRunProperties(Map<String,String> props)
void	setRunRepos(List<String> repos)
void	setRunRequires(List<org.osgi.resource.Requirement> requires)
void	setRunVMArgs(String args)
void	setServiceComponents(List<? extends ServiceComponent> components)
void	setStandaloneLinks(List<HeaderClause> headers)
void	setSubBndFiles(List<String> subBndFiles)
void	setSystemPackages(List<? extends ExportedPackage> packages)
void	setTestPath(List<? extends VersionedClause> paths)
void	setTestSuites(List<String> suites)
void	setWorkspace(Workspace workspace)
static void	store(IDocument document, File file)
InputStream	toAsciiStream(IDocument doc)
InputStream	toEscaped(String text)

Methods inherited from class java.lang.Object

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

Field Detail

NEWLINE_LINE_SEPARATOR

public static final String NEWLINE_LINE_SEPARATOR

See Also:

Constant Field Values

LIST_SEPARATOR

public static final String LIST_SEPARATOR

See Also:

Constant Field Values

PROP_WORKSPACE

public static final String PROP_WORKSPACE

See Also:

Constant Field Values

BUNDLE_VERSION_MACRO

public static final String BUNDLE_VERSION_MACRO

See Also:

Constant Field Values

Constructor Detail

BndEditModel

public BndEditModel()

BndEditModel

public BndEditModel(BndEditModel model)

BndEditModel

public BndEditModel(Workspace workspace)

BndEditModel

public BndEditModel(IDocument document)
             throws IOException

Throws:

IOException

BndEditModel

public BndEditModel(Project project)
             throws IOException

Throws:

IOException

Method Detail

loadFrom

public void loadFrom(IDocument document)
              throws IOException

Throws:

IOException

toEscaped

public InputStream toEscaped(String text)
                      throws IOException

Throws:

IOException

toAsciiStream

public InputStream toAsciiStream(IDocument doc)
                          throws IOException

Throws:

IOException

loadFrom

public void loadFrom(File file)
              throws IOException

Throws:

IOException

loadFrom

public void loadFrom(InputStream inputStream)
              throws IOException

Throws:

IOException

saveChangesTo

public void saveChangesTo(IDocument document)

getAllPropertyNames

public List<String> getAllPropertyNames()

lookupConverter

public Converter<Object,String> lookupConverter(String propertyName)

lookupFormatter

public Converter<String,Object> lookupFormatter(String propertyName)

genericGet

public Object genericGet(String propertyName)

genericSet

public void genericSet(String propertyName,
                       Object value)

getBundleLicense

public String getBundleLicense()

setBundleLicense

public void setBundleLicense(String bundleLicense)

getBundleCategory

public String getBundleCategory()

setBundleCategory

public void setBundleCategory(String bundleCategory)

getBundleName

public String getBundleName()

setBundleName

public void setBundleName(String bundleName)

getBundleDescription

public String getBundleDescription()

setBundleDescription

public void setBundleDescription(String bundleDescription)

getBundleCopyright

public String getBundleCopyright()

setBundleCopyright

public void setBundleCopyright(String bundleCopyright)

getBundleUpdateLocation

public String getBundleUpdateLocation()

setBundleUpdateLocation

public void setBundleUpdateLocation(String bundleUpdateLocation)

getBundleVendor

public String getBundleVendor()

setBundleVendor

public void setBundleVendor(String bundleVendor)

getBundleContactAddress

public String getBundleContactAddress()

setBundleContactAddress

public void setBundleContactAddress(String bundleContactAddress)

getBundleDocUrl

public String getBundleDocUrl()

setBundleDocUrl

public void setBundleDocUrl(String bundleDocUrl)

getBundleSymbolicName

public String getBundleSymbolicName()

setBundleSymbolicName

public void setBundleSymbolicName(String bundleSymbolicName)

getBundleVersionString

public String getBundleVersionString()

setBundleVersion

public void setBundleVersion(String bundleVersion)

getBundleActivator

public String getBundleActivator()

setBundleActivator

public void setBundleActivator(String bundleActivator)

getOutputFile

public String getOutputFile()

setOutputFile

public void setOutputFile(String name)

isIncludeSources

public boolean isIncludeSources()

setIncludeSources

public void setIncludeSources(boolean includeSources)

getPrivatePackages

public List<String> getPrivatePackages()

setPrivatePackages

public void setPrivatePackages(List<String> newPackages)

addPrivatePackage

public void addPrivatePackage(String packageName)

getSystemPackages

public List<ExportedPackage> getSystemPackages()

setSystemPackages

public void setSystemPackages(List<? extends ExportedPackage> packages)

getClassPath

public List<String> getClassPath()

setClassPath

public void setClassPath(List<? extends String> classPath)

getExportedPackages

public List<ExportedPackage> getExportedPackages()

setExportedPackages

public void setExportedPackages(List<? extends ExportedPackage> exports)

addExportedPackage

public void addExportedPackage(ExportedPackage export)

getDSAnnotationPatterns

public List<String> getDSAnnotationPatterns()

setDSAnnotationPatterns

public void setDSAnnotationPatterns(List<? extends String> patterns)

getServiceComponents

public List<ServiceComponent> getServiceComponents()

setServiceComponents

public void setServiceComponents(List<? extends ServiceComponent> components)

getImportPatterns

public List<ImportPattern> getImportPatterns()

setImportPatterns

public void setImportPatterns(List<? extends ImportPattern> patterns)

getBuildPath

public List<VersionedClause> getBuildPath()

getTestPath

public List<VersionedClause> getTestPath()

setBuildPath

public void setBuildPath(List<? extends VersionedClause> paths)

setTestPath

public void setTestPath(List<? extends VersionedClause> paths)

getBuildPackages

@Deprecated
public List<VersionedClause> getBuildPackages()

Deprecated.

setBuildPackages

@Deprecated
public void setBuildPackages(List<? extends VersionedClause> paths)

Deprecated.

getRunBundles

public List<VersionedClause> getRunBundles()

setRunBundles

public void setRunBundles(List<? extends VersionedClause> paths)

isIncludedPackage

public boolean isIncludedPackage(String packageName)

getSubBndFiles

public List<String> getSubBndFiles()

setSubBndFiles

public void setSubBndFiles(List<String> subBndFiles)

getRunProperties

public Map<String,String> getRunProperties()

setRunProperties

public void setRunProperties(Map<String,String> props)

getRunVMArgs

public String getRunVMArgs()

setRunVMArgs

public void setRunVMArgs(String args)

getRunProgramArgs

public String getRunProgramArgs()

setRunProgramArgs

public void setRunProgramArgs(String args)

getTestSuites

public List<String> getTestSuites()

setTestSuites

public void setTestSuites(List<String> suites)

getPlugins

public List<HeaderClause> getPlugins()

setPlugins

public void setPlugins(List<HeaderClause> plugins)

getPluginPath

public List<String> getPluginPath()

setPluginPath

public void setPluginPath(List<String> pluginPath)

getDistro

public List<String> getDistro()

setDistro

public void setDistro(List<String> distros)

getRunRepos

public List<String> getRunRepos()

setRunRepos

public void setRunRepos(List<String> repos)

getRunFramework

public String getRunFramework()

getRunFw

public String getRunFw()

getEE

public EE getEE()

setEE

public void setEE(EE ee)

setRunFramework

public void setRunFramework(String clause)

setRunFw

public void setRunFw(String clause)

getRunRequires

public List<org.osgi.resource.Requirement> getRunRequires()

setRunRequires

public void setRunRequires(List<org.osgi.resource.Requirement> requires)

getRunBlacklist

public List<org.osgi.resource.Requirement> getRunBlacklist()

setRunBlacklist

public void setRunBlacklist(List<org.osgi.resource.Requirement> requires)

getStandaloneLinks

public List<HeaderClause> getStandaloneLinks()

setStandaloneLinks

public void setStandaloneLinks(List<HeaderClause> headers)

getIgnoreStandalone

public List<HeaderClause> getIgnoreStandalone()

setIgnoreStandalone

public void setIgnoreStandalone(List<HeaderClause> headers)

isProjectFile

public boolean isProjectFile()

isBndrun

public boolean isBndrun()

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)

setBndResource

public void setBndResource(File bndResource)

getBndResource

public File getBndResource()

getBndResourceName

public String getBndResourceName()

setBndResourceName

public void setBndResourceName(String bndResourceName)

getBundleBlueprint

public List<HeaderClause> getBundleBlueprint()

setBundleBlueprint

public void setBundleBlueprint(List<HeaderClause> bundleBlueprint)

addBundleBlueprint

public void addBundleBlueprint(String location)

getIncludeResource

public List<String> getIncludeResource()

setIncludeResource

public void setIncludeResource(List<String> newEntries)

addIncludeResource

public void addIncludeResource(String resource)

setProject

public void setProject(Project project)

getProject

public Project getProject()

getWorkspace

public Workspace getWorkspace()

setWorkspace

public void setWorkspace(Workspace workspace)

getGenericString

public String getGenericString(String name)

setGenericString

public void setGenericString(String name,
                             String value)

getProperties

public Processor getProperties()
                        throws Exception

Return a processor for this model. This processor is based on the parent project or the bndrun file. It will contain the properties of the project file and the changes from the model.

Returns:

a processor that reflects the actual project or bndrun file setup

Throws:

Exception

getDocumentChanges

public Map<String,String> getDocumentChanges()

Return the saved changes in document format.

saveChanges

public void saveChanges()
                 throws IOException

If this BndEditModel was created with a project then this method will save the changes in the document and will store them in the associated file.

Throws:

IOException

store

public static void store(IDocument document,
                         File file)
                  throws IOException

Throws:

IOException