Package org.eclipse.equinox.p2.planner

Interface IPlanner

public interface IPlanner

Planners are responsible for determining what should be done to a given profile to reshape it as requested. That is, given the current state of a profile, a description of the desired changes to that profile and metadata describing the available installable units, a planner produces a concrete plan that lists the exact steps that the engine should perform.

Since:

2.0

Restriction:

This interface is not intended to be implemented by clients.

Restriction:

This interface is not intended to be extended by clients.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME	Service name constant for the planner service.

Method Summary

Modifier and Type	Method	Description
IProfileChangeRequest	createChangeRequest(IProfile profileToChange)
IProvisioningPlan	getDiffPlan(IProfile currentProfile, IProfile targetProfile, IProgressMonitor monitor)
IProvisioningPlan	getProvisioningPlan(IProfileChangeRequest profileChangeRequest, ProvisioningContext context, IProgressMonitor monitor)	Returns a plan describing the set of changes that must be performed to satisfy the given profile change request.
IQueryResult<IInstallableUnit>	updatesFor(IInstallableUnit iu, ProvisioningContext context, IProgressMonitor monitor)

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

Service name constant for the planner service.

Method Detail

getProvisioningPlan

IProvisioningPlan getProvisioningPlan(IProfileChangeRequest profileChangeRequest,
                                      ProvisioningContext context,
                                      IProgressMonitor monitor)

Returns a plan describing the set of changes that must be performed to satisfy the given profile change request.

Parameters:

profileChangeRequest - the request to be evaluated

context - the context in which the request is processed

monitor - a monitor on which planning

Returns:

the plan representing the system that needs to be

getDiffPlan

IProvisioningPlan getDiffPlan(IProfile currentProfile,
                              IProfile targetProfile,
                              IProgressMonitor monitor)

createChangeRequest

IProfileChangeRequest createChangeRequest(IProfile profileToChange)

updatesFor

IQueryResult<IInstallableUnit> updatesFor(IInstallableUnit iu,
                                          ProvisioningContext context,
                                          IProgressMonitor monitor)

Restriction:

This method is not intended to be referenced by clients. You may want to consider using the org.eclipse.equinox.p2.operations.UpdateOperation class instead.