biz.aQute.resolve

Class RunResolution

java.lang.Object

biz.aQute.resolve.RunResolution

public class RunResolution
extends java.lang.Object

Provides a simple way to resolve a project or bndrun file with support for the BndEditModel. Static methods are used to resolve and then this class holds the different aspects of the result. Either with an exception or the required and optional wiring.

The resolution also then provides convenience methods to link it to the projects

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunResolution.CacheDTO

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Exception	exception
java.lang.String	log
java.util.Map<Resource,java.util.List<Wire>>	optional
Project	project
Processor	properties
java.util.Map<Resource,java.util.List<Wire>>	required
RunStartLevel	runstartlevel

Method Summary

Modifier and Type	Method and Description
<any>	asResult() Return a result based on the isOk status.
void	cache() Cache this resolution for the given project.
static void	clearCache(Workspace ws)
java.lang.String	dot(java.lang.String name)
java.util.List<Container>	getContainers() Get a list of runbundles as containers
java.util.Map<Resource,java.util.List<Resource>>	getGraph(java.util.Map<Resource,java.util.List<Wire>> resolution) Turn the wiring into a a->b map.
java.util.List<Resource>	getOrderedResources()
java.util.List<Resource>	getOrderedResources(java.util.Map<Resource,java.util.List<Wire>> resolution, Runorder runorder)
java.util.Map<Resource,java.util.List<Wire>>	getRequired()
java.util.List<VersionedClause>	getRunBundles() Get a list of ordered run bundles.
static <any>	getRunBundles(Project project, boolean resolveIfNecessary) Get the run bundles from the cache and resolve if necessary.
java.lang.String	getRunBundlesAsString() Return the current -runbundles.
boolean	isOK() Check if the resolution is ok, that is, there was no exception.
java.lang.String	report(boolean optionals)
RunResolution	reportException()
static RunResolution	resolve(Project project, java.util.Collection<ResolutionCallback> callbacks) The secondary workhorse to resolve.
static RunResolution	resolve(Project project, Processor actualProperties, java.util.Collection<ResolutionCallback> callbacks) The main workhorse to resolve
java.util.List<Resource>	sortByDependencies(java.util.Map<Resource,java.util.List<Wire>> resolution) Sort the resources based on their dependencies.
boolean	updateBundles(BndEditModel model) Update the BndEditModel with the calculated set of runbundles.
void	updateBundles(Project project)

Methods inherited from class java.lang.Object

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

Field Detail

project

public final Project project

properties

public final Processor properties

required

public final java.util.Map<Resource,java.util.List<Wire>> required

optional

public final java.util.Map<Resource,java.util.List<Wire>> optional

exception

public final java.lang.Exception exception

log

public final java.lang.String log

runstartlevel

public final RunStartLevel runstartlevel

Method Detail

resolve

public static RunResolution resolve(Project project,
                                    Processor actualProperties,
                                    java.util.Collection<ResolutionCallback> callbacks)

The main workhorse to resolve

Parameters:

project - used for reporting errors

actualProperties - the actual properties used for resolving. This can be the project in builders that do not use the BndEditModel, otherwise it is generally the BndEditModel.

callbacks - any callbacks

Returns:

a Resolution

resolve

public static RunResolution resolve(Project project,
                                    java.util.Collection<ResolutionCallback> callbacks)

The secondary workhorse to resolve. This can be used if there is no interactive editing. In that case the properties to resolve are in the project and we can use the project both for the domain and the properties.

Parameters:

project - used for reporting errors and the properties for the resolve operations

callbacks - any callbacks

Returns:

a Resolution

isOK

public boolean isOK()

Check if the resolution is ok, that is, there was no exception.

Returns:

true if there was no exception

updateBundles

public boolean updateBundles(BndEditModel model)

Update the BndEditModel with the calculated set of runbundles. Use the ResolutionInstructions#runstartlevel(RunStartLevel).order to order the bundles. Do not update it if the list has not changed. In that case return false (no changes)

If the ResolutionInstructions#runstartlevel(RunStartLevel).order is then merge the list with the previous one.

return true if the list was changed

Parameters:

model - the edit model to update

Returns:

true if there were changes

updateBundles

public void updateBundles(Project project)

sortByDependencies

public java.util.List<Resource> sortByDependencies(java.util.Map<Resource,java.util.List<Wire>> resolution)

Sort the resources based on their dependencies. Least dependent bundles are first. This method uses a toplogical sort. If there are cycles then clearly the topological sort is not perfect.

Parameters:

resolution - the required wiring

Returns:

a topologically sorted list of resources

getGraph

public java.util.Map<Resource,java.util.List<Resource>> getGraph(java.util.Map<Resource,java.util.List<Wire>> resolution)

Turn the wiring into a a->b map.

Parameters:

resolution - the wiring

Returns:

a map where the vertices are connected to other vertices.

getRunBundles

public java.util.List<VersionedClause> getRunBundles()

Get a list of ordered run bundles.

Returns:

a list of ordered bundles

getRunBundlesAsString

public java.lang.String getRunBundlesAsString()

Return the current -runbundles.

Returns:

a non-null string in parameters format

getOrderedResources

public java.util.List<Resource> getOrderedResources(java.util.Map<Resource,java.util.List<Wire>> resolution,
                                                    Runorder runorder)

getOrderedResources

public java.util.List<Resource> getOrderedResources()

dot

public java.lang.String dot(java.lang.String name)

getContainers

public java.util.List<Container> getContainers()
                                        throws java.lang.Exception

Get a list of runbundles as containers

Throws:

java.lang.Exception

reportException

public RunResolution reportException()

report

public java.lang.String report(boolean optionals)

getRequired

public java.util.Map<Resource,java.util.List<Wire>> getRequired()

cache

public void cache()

Cache this resolution for the given project. A cache can be retrieved with getCached(Project project). This requires a real resolution

getRunBundles

public static <any> getRunBundles(Project project,
                                  boolean resolveIfNecessary)

Get the run bundles from the cache and resolve if necessary. The run bundles

Parameters:

project - the project to get the run bundles from

resolveIfNecessary - if true, call resolve

Returns:

a result, where the value can be null

asResult

public <any> asResult()

Return a result based on the isOk status. If OK, the result is a resolution, otherwise it is an error string.

Returns:

a result based on isOk

clearCache

public static void clearCache(Workspace ws)