Package aQute.bnd.build

Class ProjectBuilder

java.lang.Object

aQute.bnd.osgi.Domain

aQute.bnd.osgi.Processor

aQute.bnd.osgi.Analyzer

aQute.bnd.osgi.Builder

aQute.bnd.build.ProjectBuilder

All Implemented Interfaces:

Constants, Registry, aQute.service.reporter.Report, aQute.service.reporter.Reporter, java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.lang.String>

public class ProjectBuilder
extends Builder

Nested Class Summary

Nested classes/interfaces inherited from class aQute.bnd.osgi.Analyzer

Analyzer.Check

Nested classes/interfaces inherited from class aQute.bnd.osgi.Processor

Processor.CL, Processor.FileLine

Nested classes/interfaces inherited from interface aQute.service.reporter.Report

aQute.service.reporter.Report.Location

Nested classes/interfaces inherited from interface aQute.service.reporter.Reporter

aQute.service.reporter.Reporter.SetLocation

Field Summary

Fields inherited from class aQute.bnd.osgi.Analyzer

msgs

Fields inherited from interface aQute.bnd.osgi.Constants

AUGMENT, AUGMENT_CAPABILITY_DIRECTIVE, AUGMENT_RANGE_ATTRIBUTE, AUGMENT_REQUIREMENT_DIRECTIVE, BASELINE, BASELINEREPO, BLUEPRINT_TIMEOUT_ATTRIBUTE, BLUEPRINT_WAIT_FOR_DEPENDENCIES_ATTRIBUTE, BND_ADDXMLTOTEST, BND_LASTMODIFIED, BNDDRIVER, BNDDRIVER_ANT, BNDDRIVER_BND, BNDDRIVER_ECLIPSE, BNDDRIVER_GRADLE, BNDDRIVER_GRADLE_NATIVE, BNDDRIVER_INTELLIJ, BNDDRIVER_MAVEN, BNDDRIVER_OSMORC, BNDDRIVER_SBT, BUILDFILES, BUILDPACKAGES, BUILDPATH, BUILDREPO, BUMPPOLICY, BUNDLE_ACTIVATIONPOLICY, BUNDLE_ACTIVATOR, BUNDLE_BLUEPRINT, BUNDLE_CATEGORY, BUNDLE_CLASSPATH, BUNDLE_CONTACTADDRESS, BUNDLE_CONTRIBUTORS, BUNDLE_COPYRIGHT, BUNDLE_DESCRIPTION, BUNDLE_DEVELOPERS, BUNDLE_DOCURL, BUNDLE_ICON, BUNDLE_LICENSE, BUNDLE_LOCALIZATION, BUNDLE_MANIFESTVERSION, BUNDLE_NAME, BUNDLE_NATIVECODE, BUNDLE_REQUIREDEXECUTIONENVIRONMENT, BUNDLE_SCM, BUNDLE_SPECIFIC_HEADERS, BUNDLE_SYMBOLIC_NAME_ATTRIBUTE, BUNDLE_SYMBOLICNAME, BUNDLE_UPDATELOCATION, BUNDLE_VENDOR, BUNDLE_VERSION, BUNDLE_VERSION_ATTRIBUTE, CACHEDIR, CARDINALITY_DIRECTIVE, CHECK, CLASSPATH, COMMAND_DIRECTIVE, COMPILER_SOURCE, COMPILER_TARGET, COMPONENT_ACTIVATE, COMPONENT_CONFIGURATION_POLICY, COMPONENT_DEACTIVATE, COMPONENT_DESCRIPTORS, COMPONENT_DESIGNATE, COMPONENT_DESIGNATEFACTORY, COMPONENT_DYNAMIC, COMPONENT_ENABLED, COMPONENT_FACTORY, COMPONENT_GREEDY, COMPONENT_IMMEDIATE, COMPONENT_IMPLEMENTATION, COMPONENT_MODIFIED, COMPONENT_MULTIPLE, COMPONENT_NAME, COMPONENT_NAMESPACE, COMPONENT_OPTIONAL, COMPONENT_PROPERTIES, COMPONENT_PROVIDE, COMPONENT_SERVICEFACTORY, COMPONENT_VERSION, componentDirectives, CONDITIONAL_PACKAGE, CONDITIONALPACKAGE, CONDUIT, CONNECTION_SETTINGS, CONSUMER_POLICY, CONTRACT, CREATED_BY, CURRENT_PACKAGE, CURRENT_USES, CURRENT_VERSION, DEBUG, DEFAULT_BAR_EXTENSION, DEFAULT_BND_EXTENSION, DEFAULT_BNDRUN_EXTENSION, DEFAULT_CHARSET, DEFAULT_DO_NOT_COPY, DEFAULT_JAR_EXTENSION, DEFAULT_LAUNCHER_BSN, DEFAULT_PREPROCESSS_MATCHERS, DEFAULT_PROP_BIN_DIR, DEFAULT_PROP_SRC_DIR, DEFAULT_PROP_TARGET_DIR, DEFAULT_PROP_TESTBIN_DIR, DEFAULT_PROP_TESTSRC_DIR, DEFAULT_TESTER_BSN, DEPENDSON, DEPLOY, DEPLOYREPO, DESCRIPTION_ATTRIBUTE, DIFFIGNORE, DIFFPACKAGES, DIGESTS, directives, DISTRO, DONOTCOPY, DSANNOTATIONS, DSANNOTATIONS_OPTIONS, DUPLICATE_MARKER, DYNAMICIMPORT_PACKAGE, EEPROFILE, EEPROFILE_AUTO_ATTRIBUTE, EFFECTIVE_DIRECTIVE, EMBEDDED_REPO, EMPTY, EMPTY_HEADER, EXCLUDE_DIRECTIVE, EXPERIMENTS, EXPORT, EXPORT_CONTENTS, EXPORT_PACKAGE, EXPORT_SERVICE, EXPORTTYPE, EXTENSION, EXTENSION_DIRECTIVE, FAIL_OK, FILTER_DIRECTIVE, FIXUPMESSAGES, FIXUPMESSAGES_IS_DIRECTIVE, FIXUPMESSAGES_IS_ERROR, FIXUPMESSAGES_IS_IGNORE, FIXUPMESSAGES_IS_WARNING, FIXUPMESSAGES_REPLACE_DIRECTIVE, FIXUPMESSAGES_RESTRICT_DIRECTIVE, FRAGMENT_ATTACHMENT_DIRECTIVE, FRAGMENT_HOST, FROM_DIRECTIVE, GESTALT, GESTALT_BATCH, GESTALT_CI, GESTALT_INTERACTIVE, GESTALT_OFFLINE, GESTALT_SHELL, GROUPID, headers, IGNORE_PACKAGE, IGNORE_STANDALONE, IMPORT_DIRECTIVE, IMPORT_PACKAGE, IMPORT_PRIVATE, IMPORT_REFERENCE, IMPORT_SERVICE, importDirectives, INCLUDE, INCLUDE_DIRECTIVE, INCLUDE_RESOURCE, INCLUDERESOURCE, INIT, INTERNAL_EXPORTED_DIRECTIVE, INTERNAL_SOURCE_DIRECTIVE, INVALIDFILENAMES, JAVA, JAVA_DEBUG, JAVAAGENT, JAVAC, JAVAC_PROFILE, JAVAC_SOURCE, JAVAC_TARGET, JIDENTIFIER, KEYSTORE_LOCATION_DIRECTIVE, KEYSTORE_PASSWORD_DIRECTIVE, KEYSTORE_PROVIDER_DIRECTIVE, LANGUAGE_ATTRIBUTE, LAUNCHER_PLUGIN, LIB_DIRECTIVE, LINK_ATTRIBUTE, LITERAL_ATTRIBUTE, MAKE, MANDATORY_DIRECTIVE, MANIFEST, MANIFEST_NAME, MAVEN_RELEASE, META_PERSISTENCE, METAPACKAGES, METATYPE, METATYPE_ANNOTATIONS, METATYPE_ANNOTATIONS_OPTIONS, NAME_ATTRIBUTE, NAMESECTION, NAMESPACE_STEM, NO_IMPORT_DIRECTIVE, NOANNOTATIONS, NOBUILDINCACHE, NOBUNDLES, NODEFAULTVERSION, NOEE, NOEXTRAHEADERS, NOJUNIT, NOJUNITOSGI, NOMANIFEST, NONE, NOUSES, OPTIONAL, options, OSNAME_ATTRIBUTE, OSVERSION_ATTRIBUTE, OUTPUT, OUTPUTMASK, PACKAGE, PACKAGE_JPM, PACKAGEINFOTYPE, PATH_DIRECTIVE, PEDANTIC, PLUGIN, PLUGINPATH, PLUGINPATH_SHA1_ATTR, PLUGINPATH_URL_ATTR, POM, PREPROCESSMATCHERS, PRESENCE_DIRECTIVE, PRIVATE_DIRECTIVE, PRIVATE_PACKAGE, PRIVATEPACKAGE, PROCESSOR_ATTRIBUTE, PROFILE, PROVIDE_CAPABILITY, PROVIDE_DIRECTIVE, PROVIDER_POLICY, PROVIDER_TYPE_DIRECTIVE, RELEASEREPO, REMOVE_ATTRIBUTE_DIRECTIVE, REMOVEHEADERS, REPORTNEWER, REPOSITORIES, REQUIRE_BND, REQUIRE_BUNDLE, REQUIRE_CAPABILITY, RESOLUTION, RESOLUTION_DIRECTIVE, RESOLUTION_DYNAMIC, RESOLVE, RESOURCEONLY, RUNBLACKLIST, RUNBUILDS, RUNBUNDLES, RUNEE, RUNENV, RUNFRAMEWORK, RUNFRAMEWORK_NONE, RUNFRAMEWORK_SERVICES, RUNFW, RUNJDB, RUNKEEP, RUNNOREFERENCES, RUNPATH, RUNPATH_LAUNCHER_DIRECTIVE, RUNPATH_MAIN_DIRECTIVE, RUNPROGRAMARGS, RUNPROPERTIES, RUNPROVIDEDCAPABILITIES, RUNREMOTE, RUNREPOS, RUNREQUIRE, RUNREQUIRES, RUNSTORAGE, RUNSYSTEMCAPABILITIES, RUNSYSTEMPACKAGES, RUNTIMEOUT, RUNTRACE, RUNVM, SAVEMANIFEST, SELECTION_FILTER_ATTRIBUTE, SERVICE_COMPONENT, SET_COMPONENT_DIRECTIVES, SET_COMPONENT_DIRECTIVES_1_1, SET_COMPONENT_DIRECTIVES_1_2, SIGN, SIGN_PASSWORD_DIRECTIVE, SIGNATURE_TEST, SINGLETON_DIRECTIVE, SIZE_ATTRIBUTE, SNAPSHOT, SOURCEPATH, SOURCES, SPECIFICATION_VERSION, SPLIT_PACKAGE_DIRECTIVE, STANDALONE, STRICT, SUB, SYSTEMPROPERTIES, TESTCASES, TESTCONTINUOUS, TESTER, TESTER_PLUGIN, TESTPACKAGES, TESTPATH, TESTREPORT, TESTSOURCES, TESTSUITES, TESTUNRESOLVED, TOOL, TSTAMP, UNDERTEST, UPTO, USES_DIRECTIVE, USES_USES, VALID_PROPERTY_TYPES, VERBOSE, VERSION_ATTR_HASH, VERSION_ATTR_LATEST, VERSION_ATTR_PROJECT, VERSION_ATTR_SNAPSHOT, VERSION_ATTRIBUTE, VERSION_FILTER, VISIBILITY_DIRECTIVE, WAB, WABLIB, WORKINGSET, WORKINGSET_MEMBER

Fields inherited from class aQute.bnd.osgi.Processor

LIST_SPLITTER, log

Constructor Summary

Constructors

Constructor	Description
ProjectBuilder(Project project)
ProjectBuilder(ProjectBuilder builder)

Method Summary

Modifier and Type	Method	Description
void	addClasspath(Container c)
Jar[]	builds()	Add some extra stuff to the builds() method like exporting.
protected void	changedFile(java.io.File f)
void	doBaseline(Jar dot)	Compare this builder's JAR with a baseline
protected void	doneBuild(Builder builder)	Called when we're done with a builder.
void	fillInLocationForPackageInfo(aQute.service.reporter.Report.Location location, java.lang.String packageName)
Jar	getBaselineJar()	This method attempts to find the baseline jar for the current project.
java.util.List<Jar>	getClasspath()
java.util.List<Run>	getExportedRuns()	Return the bndrun files that need to be exported
Jar	getLastRevision()
protected java.lang.Object[]	getMacroDomains()	We put our project and our workspace on the macro path.
Project	getProject()
java.lang.String	getSourceFileFor(Descriptors.TypeRef type)	Find the source file for this type
Builder	getSubBuilder()
void	init()	Allow any local initialization by subclasses before we build.
long	lastModified()
void	report(java.util.Map<java.lang.String,java.lang.Object> table)	Create a report of the settings
protected void	startBuild(Builder builder)	Called when we start to build a builder.
java.lang.String	toString()	Printout of the status of this processor for toString()

Methods inherited from class aQute.bnd.osgi.Analyzer

_bsn, _classes, _ee, _exporters, _exports, _findname, _findpath, _imports, _md5, _packageattribute, _packages, _sha1, addClasspath, addClasspath, addClasspath, assignable, assignable, begin, calcManifest, calculateExportsFromContents, check, cleanupUses, cleanupVersion, clear, close, doRequireBnd, doUses, findClass, findResource, forceRefresh, getAPIUses, getBndInfo, getBndLastModified, getBndVersion, getBsn, getClasses, getClasspathExports, getClassspace, getClassspace, getContained, getDescriptor, getEEs, getExports, getHighestEE, getImports, getJar, getJarFromName, getJarsFromName, getLowestEE, getManifest, getName, getOutputFile, getPackageRef, getPackages, getPrivates, getReferred, getSourceFileFor, getTarget, getTypeRef, getTypeRefFromFQN, getTypeRefFromPath, getUnreachable, getUses, getVersion, getVersionPolicy, getXRef, isImported, isNoBundle, mergeManifest, putAll, referred, referTo, referToByBinaryName, save, setBase, setClasspath, setClasspath, setClasspath, setClasspath, setDefaults, setDiagnostics, setJar, setJar, setTypeLocation, validResourcePath

Methods inherited from class aQute.bnd.osgi.Builder

_githead, _maven_version, _permissions, addAll, addAll, addSourcepath, addSourcepath, analyze, build, cleanupVersion, doDiff, doNotCopy, doNotCopy, getClasspathEntrySuffix, getDoNotCopy, getExtra, getSourcePath, getSubBuilder, getSubBuilders, hasSources, isInScope, removeBundleSpecificHeaders, setSourcepath, setTypeSpecificPlugins

Methods inherited from class aQute.bnd.osgi.Domain

copyFrom, domain, domain, domain, domain, domain, getBundleActivator, getBundleCategory, getBundleClasspath, getBundleClassPath, getBundleContactAddress, getBundleCopyright, getBundleDescription, getBundleDocURL, getBundleName, getBundleNative, getBundleRequiredExecutionEnvironment, getBundleSymbolicName, getBundleVendor, getBundleVersion, getDynamicImportPackage, getExportContents, getExportPackage, getFragmentHost, getIcon, getImportPackage, getIncludeResource, getParameters, getParameters, getParameters, getParameters, getPrivatePackage, getProvideCapability, getRequireBundle, getRequireCapability, getRunblacklist, getRunee, isSources, setAugment, setBundleActivator, setBundleClasspath, setBundleRequiredExecutionEnvironment, setBundleSymbolicName, setBundleVersion, setBundleVersion, setConditionalPackage, setExportPackage, setFailOk, setImportPackage, setIncludeResource, setPrivatePackage, setRunblacklist, setRunee, setRunfw, setRunRequires, setSources, setTranslation, translate, translate

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from class aQute.bnd.osgi.Processor

_basedir, _fileuri, _findfile, _frange, _native_capability, _propertiesdir, _propertiesname, _random, _thisfile, _uri, addBasicPlugin, addClose, addExtensions, addIncluded, addProperties, addProperties, append, appendPath, beginHandleErrors, check, concat, customize, doAttrbutes, doIncludeFile, doIncludeFile, endHandleErrors, error, error, exception, exists, findHeader, findHeader, findHeader, formatArrays, get, get, getBase, getBaseURI, getClass, getDuration, getErrors, getExecutor, getFile, getFile, getFlattenedProperties, getFlattenedProperties, getHeader, getHeader, getHeader, getHeader, getIncluded, getInfo, getInfo, getLine, getLoader, getLocation, getLogger, getManifestAsProperties, getMergedParameters, getParent, getPlugin, getPlugins, getPlugins, getProperties, getPropertiesFile, getProperty, getProperty, getProperty, getPropertyKeys, getReplacer, getScheduledExecutor, getSettings, getTop, getUnprocessedProperty, getWarnings, is, isDuplicate, isExceptions, isFailOk, isMissingPlugin, isOk, isPedantic, isPerfect, isTrace, isTrue, iterator, join, join, join, join, join, keySet, loadPlugins, loadProperties, makePrintable, merge, mergeLocalProperties, mergeProperties, mergeProperties, mergeProperties, mergeProperties, newHashMap, newList, newList, newMap, newMap, newSet, newSet, normalize, normalize, parseHeader, parseHeader, printClause, printClauses, printClauses, printExceptionSummary, printStackTrace, progress, progress, propertiesChanged, quote, read, refresh, removeBasicPlugin, removeClose, removeDuplicateMarker, replaceAll, replaceExtension, report, set, setExceptions, setFileMustExist, setForceLocal, setParent, setPedantic, setProperties, setProperties, setProperties, setProperties, setProperty, setTrace, signal, since, split, split, split, toFullHeaderPattern, trace, unsetProperty, updateModified, use, warning

Constructor Detail

ProjectBuilder

public ProjectBuilder(Project project)

ProjectBuilder

public ProjectBuilder(ProjectBuilder builder)

Method Detail

lastModified

public long lastModified()

Overrides:

lastModified in class Processor

getMacroDomains

protected java.lang.Object[] getMacroDomains()

We put our project and our workspace on the macro path.

Overrides:

getMacroDomains in class Processor

getSubBuilder

public Builder getSubBuilder()
                      throws java.lang.Exception

Overrides:

getSubBuilder in class Builder

Throws:

java.lang.Exception

getProject

public Project getProject()

init

public void init()

Description copied from class: Builder

Allow any local initialization by subclasses before we build.

Overrides:

init in class Builder

addClasspath

public void addClasspath(Container c)
                  throws java.io.IOException

Throws:

java.io.IOException

getClasspath

public java.util.List<Jar> getClasspath()

Overrides:

getClasspath in class Analyzer

changedFile

protected void changedFile(java.io.File f)

Overrides:

changedFile in class Builder

doBaseline

public void doBaseline(Jar dot)
                throws java.lang.Exception

Compare this builder's JAR with a baseline

Overrides:

doBaseline in class Builder

Throws:

java.lang.Exception

fillInLocationForPackageInfo

public void fillInLocationForPackageInfo(aQute.service.reporter.Report.Location location,
                                         java.lang.String packageName)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getLastRevision

public Jar getLastRevision()
                    throws java.lang.Exception

Throws:

java.lang.Exception

getBaselineJar

public Jar getBaselineJar()
                   throws java.lang.Exception

This method attempts to find the baseline jar for the current project. It reads the -baseline property and treats it as instructions. These instructions are matched against the bsns of the jars (think sub builders!). If they match, the sub builder is selected.

The instruction can then specify the following options:

  version :
 baseline version from repository file : a file path
 

If neither is specified, the current version is used to find the highest version (without qualifier) that is below the current version. If a version is specified, we take the highest version with the same base version.

Since baselining is expensive and easily generates errors you must enable it. The easiest solution is to -baseline: *. This will match all sub builders and will calculate the version.

Returns:

a Jar or null

Throws:

java.lang.Exception

report

public void report(java.util.Map<java.lang.String,java.lang.Object> table)
            throws java.lang.Exception

Create a report of the settings

Overrides:

report in class Builder

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Description copied from class: Processor

Printout of the status of this processor for toString()

Overrides:

toString in class Processor

getExportedRuns

public java.util.List<Run> getExportedRuns()
                                    throws java.lang.Exception

Return the bndrun files that need to be exported

Throws:

java.lang.Exception

builds

public Jar[] builds()
             throws java.lang.Exception

Add some extra stuff to the builds() method like exporting.

Overrides:

builds in class Builder

Throws:

java.lang.Exception

startBuild

protected void startBuild(Builder builder)
                   throws java.lang.Exception

Called when we start to build a builder. We reset our map of bsn -> version and set the default contents of the bundle.

Overrides:

startBuild in class Builder

Throws:

java.lang.Exception

doneBuild

protected void doneBuild(Builder builder)
                  throws java.lang.Exception

Called when we're done with a builder. In this case we retrieve package information from builder.

Overrides:

doneBuild in class Builder

Throws:

java.lang.Exception

getSourceFileFor

public java.lang.String getSourceFileFor(Descriptors.TypeRef type)
                                  throws java.lang.Exception

Find the source file for this type

Overrides:

getSourceFileFor in class Analyzer

Parameters:

type -

Throws:

java.lang.Exception