Class Analyzer

java.lang.Object

aQute.bnd.osgi.Domain

aQute.bnd.osgi.Processor

aQute.bnd.osgi.Analyzer

All Implemented Interfaces:

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

Direct Known Subclasses:

Builder

public class Analyzer
extends Processor

This class can calculate the required headers for a (potential) JAR file. It analyzes a directory or JAR for the packages that are contained and that are referred to by the bytecodes. The user can the use regular expressions to define the attributes and directives. The matching is not fully regex for convenience. A * and ? get a . prefixed and dots are escaped.

*;auto=true             any
org.acme.*;auto=true    org.acme.xyz
org.[abc]*;auto=true    org.acme.xyz

Additional, the package instruction can start with a '=' or a '!'. The '!' indicates negation. Any matching package is removed. The '=' is literal, the expression will be copied verbatim and no matching will take place. Any headers in the given properties are used in the output properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Analyzer.Check

Nested classes/interfaces inherited from class 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

Modifier and Type	Field	Description
protected final AnalyzerMessages	msgs

Fields inherited from class Processor

LIST_SPLITTER, log

Fields inherited from interface Constants

ACCESS_ATTRIBUTE, AUGMENT, AUGMENT_CAPABILITY_DIRECTIVE, AUGMENT_RANGE_ATTRIBUTE, AUGMENT_REQUIREMENT_DIRECTIVE, AUTOMATIC_MODULE_NAME, BASELINE, BASELINEREPO, BLUEPRINT_TIMEOUT_ATTRIBUTE, BLUEPRINT_WAIT_FOR_DEPENDENCIES_ATTRIBUTE, BND_ADDXMLTOTEST, BND_LASTMODIFIED, BND_USE_ATTRIBUTES, BNDDRIVER, BNDDRIVER_ANT, BNDDRIVER_BND, BNDDRIVER_ECLIPSE, BNDDRIVER_GRADLE, BNDDRIVER_GRADLE_NATIVE, BNDDRIVER_INTELLIJ, BNDDRIVER_MAVEN, BNDDRIVER_OSMORC, BNDDRIVER_SBT, BSN_SOURCE_SUFFIX, BUILDERIGNORE, BUILDFILES, 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, BUNDLEANNOTATIONS, CARDINALITY_DIRECTIVE, CDIANNOTATIONS, CHECK, CLASS_ATTRIBUTE, CLASSPATH, COMMAND_DIRECTIVE, COMPONENT_ACTIVATE, COMPONENT_CONFIGURATION_POLICY, COMPONENT_DEACTIVATE, COMPONENT_DESCRIPTORS, COMPONENT_DESIGNATE, COMPONENT_DESIGNATEFACTORY, COMPONENT_DIRECTIVES, COMPONENT_DIRECTIVES_1_1, COMPONENT_DIRECTIVES_1_2, 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, COMPRESSION, CONDITIONAL_PACKAGE, CONDITIONALPACKAGE, CONDUIT, CONNECTION_LOG, CONNECTION_SETTINGS, CONSUMER_POLICY, CONTRACT, CREATED_BY, CURRENT_BUNDLESYMBOLICNAME, CURRENT_BUNDLEVERSION, CURRENT_PACKAGE, CURRENT_USES, CURRENT_VERSION, 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, DEFINE_CONTRACT, DEPENDSON, DEPLOY, DEPLOYREPO, DESCRIPTION_ATTRIBUTE, DIFFIGNORE, DIFFPACKAGES, DIGESTS, directives, DISTRO, DONOTCOPY, DSANNOTATIONS, DSANNOTATIONS_OPTIONS, DUPLICATE_MARKER, DYNAMICIMPORT_PACKAGE, EE_ATTRIBUTE, EEPROFILE, EEPROFILE_AUTO_ATTRIBUTE, EFFECTIVE_DIRECTIVE, EMBEDDED_REPO, EMPTY_HEADER, EXCLUDE_DIRECTIVE, EXECUTABLE, EXPORT, EXPORT_APIGUARDIAN, EXPORT_BSN, EXPORT_CONTENTS, EXPORT_NAME, EXPORT_PACKAGE, EXPORT_SERVICE, EXPORT_TYPE, EXPORT_VERSION, EXPORTS_ATTRIBUTE, 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, GENERATE, GESTALT, GESTALT_BATCH, GESTALT_CI, GESTALT_INTERACTIVE, GESTALT_OFFLINE, GESTALT_SHELL, GROUPID, headers, IDENTITY_INITIAL_RESOURCE, IDENTITY_SYSTEM_RESOURCE, IGNORE_ATTRIBUTE, IGNORE_PACKAGE, IGNORE_STANDALONE, IMPORT_DIRECTIVE, IMPORT_PACKAGE, IMPORT_PRIVATE, IMPORT_REFERENCE, IMPORT_SERVICE, importDirectives, INCLUDE, INCLUDE_DIRECTIVE, INCLUDE_RESOURCE, INCLUDEPACKAGE, INCLUDERESOURCE, INIT, INTERNAL_BUNDLESYMBOLICNAME_DIRECTIVE, INTERNAL_BUNDLEVERSION_DIRECTIVE, INTERNAL_EXPORT_TO_MODULES_DIRECTIVE, INTERNAL_EXPORTED_DIRECTIVE, INTERNAL_MODULE_DIRECTIVE, INTERNAL_MODULE_VERSION_DIRECTIVE, INTERNAL_OPEN_TO_MODULES_DIRECTIVE, INTERNAL_PREFIX, INTERNAL_SOURCE_DIRECTIVE, INVALIDFILENAMES, JAVA, JAVA_DEBUG, JAVAAGENT, JAVAC, JAVAC_ENCODING, JAVAC_PROFILE, JAVAC_SOURCE, JAVAC_TARGET, JIDENTIFIER, JPMS_MODULE_INFO, JPMS_MODULE_INFO_OPTIONS, KEYSTORE_LOCATION_DIRECTIVE, KEYSTORE_PASSWORD_DIRECTIVE, KEYSTORE_PROVIDER_DIRECTIVE, LANGUAGE_ATTRIBUTE, LAUNCH_ACTIVATION_EAGER, LAUNCH_ACTIVATORS, LAUNCH_RUNBUNDLES_ATTRS, LAUNCH_STARTLEVEL_DEFAULT, LAUNCH_TRACE, LAUNCHER_PLUGIN, LIB_DIRECTIVE, LIBRARY, LINK_ATTRIBUTE, LITERAL_ATTRIBUTE, MAIN_CLASS, MAKE, MANDATORY_DIRECTIVE, MANIFEST, MANIFEST_NAME, MAVEN_DEPENDENCIES, MAVEN_RELEASE, MAVEN_SCOPE, META_PERSISTENCE, METAPACKAGES, METATYPE, METATYPE_ANNOTATIONS, METATYPE_ANNOTATIONS_OPTIONS, MIME_TYPE_BUNDLE, MIME_TYPE_JAR, MODULE_INFO_CLASS, MODULES_ATTRIBUTE, NAME_ATTRIBUTE, NAMESECTION, NAMESPACE_STEM, NO_IMPORT_DIRECTIVE, NOANNOTATIONS, NOBUILDINCACHE, NOBUNDLES, NOCLASSFORNAME, NODEFAULTVERSION, NOEE, NOEXTRAHEADERS, NOIMPORTJAVA, NOJUNIT, NOJUNITOSGI, NOMANIFEST, NONE, NOT_A_BUNDLE_S, NOUSES, OPTIONAL, options, OSGI_SYNTAX_HEADERS, OSNAME_ATTRIBUTE, OSVERSION_ATTRIBUTE, OUTPUT, OUTPUTMASK, 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, REMOTEWORKSPACE, REMOVE_ATTRIBUTE_DIRECTIVE, REMOVEHEADERS, REPORTNEWER, REPOSITORIES, REPRODUCIBLE, REQUIRE_BND, REQUIRE_BUNDLE, REQUIRE_CAPABILITY, RESOLUTION, RESOLUTION_DIRECTIVE, RESOLUTION_DYNAMIC, RESOLVE, RESOLVE_EFFECTIVE, RESOLVE_EXCLUDESYSTEM, RESOLVE_PREFERENCES, RESOLVEDEBUG, RESOURCEONLY, RUNBLACKLIST, RUNBUILDS, RUNBUNDLES, RUNBUNDLES_STARTLEVEL_ATTRIBUTE, RUNEE, RUNENV, RUNFRAMEWORK, RUNFRAMEWORK_NONE, RUNFRAMEWORK_SERVICES, RUNFRAMEWORKRESTART, RUNFW, RUNJDB, RUNKEEP, RUNNOREFERENCES, RUNOPTIONS, RUNOPTIONS_EAGER, RUNPATH, RUNPROGRAMARGS, RUNPROPERTIES, RUNPROVIDEDCAPABILITIES, RUNREMOTE, RUNREPOS, RUNREQUIRES, RUNSTARTLEVEL, RUNSTARTLEVEL_BEGIN, RUNSTARTLEVEL_ORDER, RUNSTARTLEVEL_STEP, RUNSTORAGE, RUNSYSTEMCAPABILITIES, RUNSYSTEMPACKAGES, RUNTIMEOUT, RUNTRACE, RUNVM, SAVEMANIFEST, SELECTION_FILTER_ATTRIBUTE, SERVICE_COMPONENT, SERVICELOADER_NAMESPACE, SERVICELOADER_REGISTER_DIRECTIVE, SIGN, SIGN_PASSWORD_DIRECTIVE, SIGNATURE_TEST, SINGLETON_DIRECTIVE, SIZE_ATTRIBUTE, SNAPSHOT, SOURCEPATH, SOURCES, SPECIFICATION_VERSION, SPLIT_PACKAGE_DIRECTIVE, STALECHECK, STANDALONE, STATIC_ATTRIBUTE, STRICT, SUB, SUBSTITUTE_ATTRIBUTE, SYSTEMPROPERTIES, TESTCASES, TESTCONTINUOUS, TESTER, TESTER_PLUGIN, TESTPACKAGES, TESTPATH, TESTSOURCES, TESTTERMINATE, TESTUNRESOLVED, TOOL, TRANSITIVE_ATTRIBUTE, TSTAMP, UNDERTEST, UPTO, USES_DIRECTIVE, USES_USES, VALID_PROPERTY_TYPES, VERSION_ATTR_HASH, VERSION_ATTR_LATEST, VERSION_ATTR_PROJECT, VERSION_ATTR_SNAPSHOT, VERSION_ATTRIBUTE, VERSION_FILTER, VERSIONDEFAULTS, VISIBILITY_DIRECTIVE, WAB, WABLIB, WORKINGSET, WORKINGSET_MEMBER

Constructor Summary

Constructors

Constructor	Description
Analyzer()
Analyzer(Jar jar)
Analyzer(Processor parent)

Method Summary

Modifier and Type	Method	Description
String	_bsn(String[] args)
String	_classes(String... args)
String	_ee(String[] args)
String	_exporters(String[] args)	Get the exporter of a package ...
String	_exports(String[] args)
String	_findname(String[] args)
String	_findpath(String[] args)	Findpath looks through the contents of the JAR and finds paths that end with the given regular expression ${findpath (; reg-expr (; replacement)? )? }
String	_imports(String[] args)
String	_md5(String[] args)
String	_packageattribute(String[] args)	Return an attribute of a package
String	_packages(String... args)
String	_sha1(String[] args)
void	addClasspath(Jar jar)
void	addClasspath(File cp)
void	addClasspath(Collection<?> jars)
void	analyze()	Calculates the data structures for generating a manifest.
boolean	assignable(Clazz annoServiceClazz, Clazz inferredServiceClazz)
boolean	assignable(Clazz annoServiceClazz, Clazz inferredServiceClazz, boolean unknownResult)
boolean	assignable(String annoService, String inferredService)
boolean	assignable(String annoService, String inferredService, boolean unknownResult)
protected void	begin()
Manifest	calcManifest()	One of the main workhorses of this class.
String	calculateExportsFromContents(Jar bundle)	Calculate an export header solely based on the contents of a JAR file
boolean	check(Analyzer.Check key)	Check if we have an a check option
Map<Descriptors.PackageRef, List<Descriptors.PackageRef>>	cleanupUses(Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> apiUses, boolean removeJava)	Remove the own references and optional java references from the uses lib
static String	cleanupVersion(String version)
void	clear()
void	close()
protected void	doRequireBnd()	Ensure that we are running on the correct bnd.
protected void	doUses(Descriptors.PackageRef packageRef, Packages exports, Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> uses, Packages imports)
Clazz	findClass(Descriptors.TypeRef typeRef)	Find a clazz on the class path.
Jar	findClasspathEntry(String bsn, String r)	Find a class path entry based on bsn and versionrange
Resource	findResource(String path)	Locate a resource on the class path.
Stream<Resource>	findResources(Predicate<String> matches)
void	forceRefresh()
Map<Descriptors.PackageRef, List<Descriptors.PackageRef>>	getAPIUses()
String	getBndInfo(String key, String defaultValue)
long	getBndLastModified()
String	getBndVersion()	Get the version for this bnd
String	getBsn()	Clear the key part of a header.
Optional<String>	getBundleClassPathEntry(Clazz clazz)
Map<Descriptors.TypeRef, String>	getBundleClassPathTypes()
Collection<Clazz>	getClasses(String... args)
List<Jar>	getClasspath()
Packages	getClasspathExports()
aQute.bnd.signatures.ClassSignature	getClassSignature(String signature)
Map<Descriptors.TypeRef, Clazz>	getClassspace()
Set<Clazz>	getClassspace(Descriptors.PackageRef source)	Return the classes for a given source package.
Packages	getContained()
Descriptors.Descriptor	getDescriptor(String descriptor)
SortedSet<Clazz.JAVA>	getEEs()	Return the EEs
Packages	getExports()
protected Jar	getExtra()
aQute.bnd.signatures.FieldSignature	getFieldSignature(String signature)
Clazz.JAVA	getHighestEE()
Optional<Set<Descriptors.PackageRef>>	getHostPackages()	Get the packages from the host if this is a fragment bundle
Packages	getImports()
Jar	getJar()
Jar	getJarFromName(String name, String from)	Try to get a Jar from a file name/path or a url, or in last resort from the classpath name part of their files.
List<Jar>	getJarsFromName(String name, String from)
Clazz.JAVA	getLowestEE()
static Properties	getManifest(File dirOrJar)	Specifically for Maven
aQute.bnd.signatures.MethodSignature	getMethodSignature(String signature)
protected String	getName(Jar jar)
File	getOutputFile(String output)	Calculate the output file for the given target.
Clazz	getPackageInfo(Descriptors.PackageRef packageRef)
Descriptors.PackageRef	getPackageRef(String binaryName)
Collection<Descriptors.PackageRef>	getPackages(Packages scope, String... args)
Set<Descriptors.PackageRef>	getPrivates()
Packages	getReferred()
Optional<Set<Descriptors.PackageRef>>	getRequireBundlePackages()	Find the packages belonging to the required bundles
String	getSourceFileFor(Descriptors.TypeRef type)	Find the source file for this type
String	getSourceFileFor(Descriptors.TypeRef type, Collection<File> sourcePath)
Jar	getTarget()
Descriptors.TypeRef	getTypeRef(String binaryClassName)
Descriptors.TypeRef	getTypeRefFromFQN(String fqn)
Descriptors.TypeRef	getTypeRefFromPath(String path)
Set<Descriptors.PackageRef>	getUnreachable()	Return the set of unreachable code depending on exports and the bundle activator.
Map<Descriptors.PackageRef, List<Descriptors.PackageRef>>	getUses()
String	getVersion()	Answer the bundle version.
String	getVersionPolicy(boolean implemented)
Map<Clazz.Def, List<Descriptors.TypeRef>>	getXRef(Descriptors.PackageRef source, Collection<Descriptors.PackageRef> dest, int sourceModifiers)	Create a cross reference from package source, to packages in dest
boolean	isImported(Descriptors.PackageRef packageRef)
boolean	isNoBundle()
void	mergeManifest(Manifest manifest)	Merge the existing manifest with the instructions but do not override existing properties.
void	nonClassReferTo(Descriptors.TypeRef ref)
void	putAll(Map<String,String> additional, boolean force)
boolean	referred(Descriptors.PackageRef packageName)
void	referTo(Descriptors.TypeRef ref)
void	referToByBinaryName(String binaryClassName)
void	report(Map<String,Object> table)	Report the details of this analyzer
boolean	save(File output, boolean force)	Utility function to carefully save the file.
void	setBase(File file)
void	setClasspath(Jar[] classpath)
void	setClasspath(File[] classpath)
void	setClasspath(String[] classpath)
void	setClasspath(Collection<?> classpath)	Set the classpath for this analyzer by file.
void	setDefaults(String bsn, Version version)	Set default import and export instructions if none are set
void	setDiagnostics(boolean b)
Jar	setJar(Jar jar)	Set the JAR directly we are going to work on.
Jar	setJar(File file)	Set the JAR file we are going to work in.
void	setTypeLocation(aQute.service.reporter.Reporter.SetLocation location, Descriptors.TypeRef type)	Set location information for a type.
protected void	setTypeSpecificPlugins(PluginsContainer pluginsContainer)
String	validResourcePath(String name, String reportIfWrong)

Methods inherited from class Processor

_basedir, _fileuri, _findfile, _frange, _native_capability, _propertiesdir, _propertiesname, _random, _thisfile, _uri, addBasicPlugin, addClose, addExtensions, addIncluded, addProperties, addProperties, append, appendPath, beginHandleErrors, check, concat, customize, decorated, decorated, doAttrbutes, doIncludeFile, doIncludeFile, endHandleErrors, error, error, exception, exists, findHeader, findHeader, findHeader, formatArrays, get, get, getBase, getBaseURI, getChecksum, getClass, getDuration, getErrors, getExecutor, getFile, getFile, getFlattenedProperties, getFlattenedProperties, getHeader, getHeader, getHeader, getHeader, getIncluded, getInfo, getInfo, getInstructions, getJavaExecutable, getLine, getLoader, getLocation, getLogger, getMacroDomains, getManifestAsProperties, getMergedParameters, getParameters, getParent, getPlugin, getPlugins, getPlugins, getProfile, getPromiseFactory, getProperties, getPropertiesFile, getProperty, getProperty, getProperty, getPropertyKeys, getReplacer, getScheduledExecutor, getSelfAndAncestors, getSettings, getTop, getUnexpandedProperty, getUnprocessedProperty, getWarnings, is, isDuplicate, isExceptions, isFailOk, isInteractive, isMissingPlugin, isOk, isPedantic, isPerfect, isTrace, isTrue, iterator, join, join, join, join, join, join, keySet, lastModified, 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, setLocation, setParent, setPedantic, setProperties, setProperties, setProperties, setProperties, setPropertiesFile, setProperty, setTrace, signal, since, split, split, split, spliterator, system, system, toFullHeaderPattern, toString, trace, unsetProperty, updateModified, use, warning

Methods inherited from class Domain

copyFrom, domain, domain, 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, normalizeKey, setAugment, setBundleActivator, setBundleClasspath, setBundleRequiredExecutionEnvironment, setBundleSymbolicName, setBundleVersion, setBundleVersion, setConditionalPackage, setExportContents, setExportPackage, setFailOk, setImportPackage, setIncludePackage, setIncludeResource, setPrivatePackage, setRunblacklist, setRunee, setRunfw, setRunRequires, setSources, setTranslation, translate, translate

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach

Field Details

msgs

protected final AnalyzerMessages msgs

Constructor Details

Analyzer

public Analyzer(Jar jar)
         throws Exception

Throws:

Exception

Analyzer

public Analyzer(Processor parent)

Analyzer

public Analyzer()

Method Details

setTypeSpecificPlugins

protected void setTypeSpecificPlugins(PluginsContainer pluginsContainer)

Overrides:

setTypeSpecificPlugins in class Processor

getManifest

public static Properties getManifest(File dirOrJar)
                              throws Exception

Specifically for Maven

Throws:

Exception

analyze

public void analyze()
             throws Exception

Calculates the data structures for generating a manifest.

Throws:

IOException

Exception

getHostPackages

public Optional<Set<Descriptors.PackageRef>> getHostPackages()

Get the packages from the host if this is a fragment bundle

Returns:

the host packages or an empty set if not a fragment

getRequireBundlePackages

public Optional<Set<Descriptors.PackageRef>> getRequireBundlePackages()

Find the packages belonging to the required bundles

Returns:

the packages from the required bundles, with no Require-Bundle return an empty Optional

getPackageInfo

public Clazz getPackageInfo(Descriptors.PackageRef packageRef)

getName

protected String getName(Jar jar)
                  throws Exception

Throws:

Exception

getExtra

protected Jar getExtra()
                throws Exception

Throws:

Exception

calcManifest

public Manifest calcManifest()
                      throws Exception

One of the main workhorses of this class. This will analyze the current setup and calculate a new manifest according to this setup.

Throws:

IOException

Exception

findClasspathEntry

public Jar findClasspathEntry(String bsn,
 String r)

Find a class path entry based on bsn and versionrange

Parameters:

bsn - The bundle symbolic name

r - The version range specified like in OSGi (version => [version,infinite))

Returns:

first JAR that matches bsn invalid input: '&r' or null if not found

getBsn

public String getBsn()

Clear the key part of a header. I.e. remove everything from the first ';'

_bsn

public String _bsn(String[] args)

calculateExportsFromContents

public String calculateExportsFromContents(Jar bundle)

Calculate an export header solely based on the contents of a JAR file

Parameters:

bundle - The jar file to analyze

getContained

public Packages getContained()

getExports

public Packages getExports()

getImports

public Packages getImports()

getPrivates

public Set<Descriptors.PackageRef> getPrivates()

getJar

public Jar getJar()

getReferred

public Packages getReferred()

getUnreachable

public Set<Descriptors.PackageRef> getUnreachable()

Return the set of unreachable code depending on exports and the bundle activator.

getUses

public Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> getUses()

getAPIUses

public Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> getAPIUses()

getClasspathExports

public Packages getClasspathExports()

getBndVersion

public String getBndVersion()

Get the version for this bnd

Returns:

version or unknown.

getBndLastModified

public long getBndLastModified()

getBndInfo

public String getBndInfo(String key,
 String defaultValue)

mergeManifest

public void mergeManifest(Manifest manifest)
                   throws IOException

Merge the existing manifest with the instructions but do not override existing properties.

Parameters:

manifest - The manifest to merge with

Throws:

IOException

setBase

public void setBase(File file)

Overrides:

setBase in class Processor

setClasspath

public void setClasspath(Collection<?> classpath)
                  throws IOException

Set the classpath for this analyzer by file.

Parameters:

classpath -

Throws:

IOException

setClasspath

public void setClasspath(File[] classpath)
                  throws IOException

Throws:

IOException

setClasspath

public void setClasspath(Jar[] classpath)

setClasspath

public void setClasspath(String[] classpath)

setJar

public Jar setJar(File file)
           throws IOException

Set the JAR file we are going to work in. This will read the JAR in memory.

Parameters:

file -

Throws:

IOException

setJar

public Jar setJar(Jar jar)

Set the JAR directly we are going to work on.

Parameters:

jar -

begin

protected void begin()

Overrides:

begin in class Processor

getJarFromName

public Jar getJarFromName(String name,
 String from)

Try to get a Jar from a file name/path or a url, or in last resort from the classpath name part of their files.

Overrides:

getJarFromName in class Processor

Parameters:

name - URL or filename relative to the base

from - Message identifying the caller for errors

Returns:

null or a Jar with the contents for the name

getJarsFromName

public List<Jar> getJarsFromName(String name,
 String from)

referred

public boolean referred(Descriptors.PackageRef packageName)

doUses

protected void doUses(Descriptors.PackageRef packageRef,
 Packages exports,
 Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> uses,
 Packages imports)

Parameters:

packageRef -

exports -

uses -

imports -

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class Processor

Throws:

IOException

_findpath

public String _findpath(String[] args)

Findpath looks through the contents of the JAR and finds paths that end with the given regular expression ${findpath (; reg-expr (; replacement)? )? }

Parameters:

args -

_findname

public String _findname(String[] args)

putAll

public void putAll(Map<String,String> additional,
 boolean force)

getClasspath

public List<Jar> getClasspath()

addClasspath

public void addClasspath(Jar jar)

addClasspath

public void addClasspath(Collection<?> jars)
                  throws IOException

Throws:

IOException

addClasspath

public void addClasspath(File cp)
                  throws IOException

Throws:

IOException

clear

public void clear()

Overrides:

clear in class Processor

forceRefresh

public void forceRefresh()

Overrides:

forceRefresh in class Processor

getTarget

public Jar getTarget()

cleanupVersion

public static String cleanupVersion(String version)

getVersionPolicy

public String getVersionPolicy(boolean implemented)

_classes

public String _classes(String... args)
                throws Exception

Throws:

Exception

getClasses

public Collection<Clazz> getClasses(String... args)
                             throws Exception

Throws:

Exception

_packages

public String _packages(String... args)
                 throws Exception

Throws:

Exception

getPackages

public Collection<Descriptors.PackageRef> getPackages(Packages scope,
 String... args)
                                               throws Exception

Throws:

Exception

_exporters

public String _exporters(String[] args)
                  throws Exception

Get the exporter of a package ...

Throws:

Exception

getClassspace

public Map<Descriptors.TypeRef, Clazz> getClassspace()

_packageattribute

public String _packageattribute(String[] args)

Return an attribute of a package

findResource

public Resource findResource(String path)

Locate a resource on the class path.

Parameters:

path - Path of the reosurce

Returns:

A resource or null

findResources

public Stream<Resource> findResources(Predicate<String> matches)

findClass

public Clazz findClass(Descriptors.TypeRef typeRef)
                throws Exception

Find a clazz on the class path. This class has been parsed.

Throws:

Exception

getVersion

public String getVersion()

Answer the bundle version.

isNoBundle

public boolean isNoBundle()

referTo

public void referTo(Descriptors.TypeRef ref)

nonClassReferTo

public void nonClassReferTo(Descriptors.TypeRef ref)

referToByBinaryName

public void referToByBinaryName(String binaryClassName)

doRequireBnd

protected void doRequireBnd()

Ensure that we are running on the correct bnd.

_md5

public String _md5(String[] args)
            throws Exception

Throws:

Exception

_sha1

public String _sha1(String[] args)
             throws Exception

Throws:

Exception

getDescriptor

public Descriptors.Descriptor getDescriptor(String descriptor)

getTypeRef

public Descriptors.TypeRef getTypeRef(String binaryClassName)

getPackageRef

public Descriptors.PackageRef getPackageRef(String binaryName)

getTypeRefFromFQN

public Descriptors.TypeRef getTypeRefFromFQN(String fqn)

getTypeRefFromPath

public Descriptors.TypeRef getTypeRefFromPath(String path)

getClassSignature

public aQute.bnd.signatures.ClassSignature getClassSignature(String signature)

getMethodSignature

public aQute.bnd.signatures.MethodSignature getMethodSignature(String signature)

getFieldSignature

public aQute.bnd.signatures.FieldSignature getFieldSignature(String signature)

isImported

public boolean isImported(Descriptors.PackageRef packageRef)

setDiagnostics

public void setDiagnostics(boolean b)

getLowestEE

public Clazz.JAVA getLowestEE()

getHighestEE

public Clazz.JAVA getHighestEE()

_ee

public String _ee(String[] args)

getOutputFile

public File getOutputFile(String output)

Calculate the output file for the given target. The strategy is:

parameter given if not null and not directory if directory, this will be
the output directory based on bsn-version.jar name of the source file if
exists Untitled-[n]

Parameters:

output - may be null, otherwise a file path relative to base

save

public boolean save(File output,
 boolean force)
             throws Exception

Utility function to carefully save the file. Will create a backup if the source file has the same path as the output. It will also only save if the file was modified or the force flag is true

Parameters:

output - the output file, if null getOutputFile(String) is used.

force - if it needs to be overwritten

Throws:

Exception

setDefaults

public void setDefaults(String bsn,
 Version version)

Set default import and export instructions if none are set

cleanupUses

public Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> cleanupUses(Map<Descriptors.PackageRef, List<Descriptors.PackageRef>> apiUses,
 boolean removeJava)

Remove the own references and optional java references from the uses lib

Parameters:

apiUses -

removeJava -

getClassspace

public Set<Clazz> getClassspace(Descriptors.PackageRef source)

Return the classes for a given source package.

Parameters:

source - the source package

Returns:

a set of classes for the requested package.

getXRef

public Map<Clazz.Def, List<Descriptors.TypeRef>> getXRef(Descriptors.PackageRef source,
 Collection<Descriptors.PackageRef> dest,
 int sourceModifiers)
                                                  throws Exception

Create a cross reference from package source, to packages in dest

Parameters:

source -

dest -

sourceModifiers -

Throws:

Exception

_exports

public String _exports(String[] args)

_imports

public String _imports(String[] args)

report

public void report(Map<String,Object> table)
            throws Exception

Report the details of this analyzer

Overrides:

report in class Processor

Parameters:

table -

Throws:

Exception

getEEs

public SortedSet<Clazz.JAVA> getEEs()

Return the EEs

validResourcePath

public String validResourcePath(String name,
 String reportIfWrong)

Parameters:

name -

check

public boolean check(Analyzer.Check key)

Check if we have an a check option

getSourceFileFor

public String getSourceFileFor(Descriptors.TypeRef type)
                        throws Exception

Find the source file for this type

Parameters:

type -

Throws:

Exception

getSourceFileFor

public String getSourceFileFor(Descriptors.TypeRef type,
 Collection<File> sourcePath)
                        throws Exception

Throws:

Exception

setTypeLocation

public void setTypeLocation(aQute.service.reporter.Reporter.SetLocation location,
 Descriptors.TypeRef type)
                     throws Exception

Set location information for a type.

Throws:

Exception

assignable

public boolean assignable(String annoService,
 String inferredService)

assignable

public boolean assignable(String annoService,
 String inferredService,
 boolean unknownResult)

assignable

public boolean assignable(Clazz annoServiceClazz,
 Clazz inferredServiceClazz)

assignable

public boolean assignable(Clazz annoServiceClazz,
 Clazz inferredServiceClazz,
 boolean unknownResult)

getBundleClassPathTypes

public Map<Descriptors.TypeRef, String> getBundleClassPathTypes()

getBundleClassPathEntry

public Optional<String> getBundleClassPathEntry(Clazz clazz)