1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*******************************************************************************
* Copyright (c) 2010, 2013 Sonatype, Inc and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Sonatype, Inc. - initial API and implementation
* IBM Corporation - ongoing development
* Rapicorp, Inc. - ongoing development
*******************************************************************************/
package org.eclipse.equinox.p2.planner;
import java.util.Collection;
import org.eclipse.equinox.p2.engine.IProfile;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.metadata.IRequirement;
/**
* A profile change request is a description of a set of changes that a client
* would like to perform on a profile. The request is provided as input to an
* {@link IPlanner}, which validates which of the requested changes can be
* performed, and what other changes are required in order to make the profile
* state consistent.
*
* It is important to note that a change request can only be submitted once to the planner.
*
* Clients should create and manipulate profile change requests via the API {@link IPlanner#createChangeRequest(IProfile)}.
*
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
* @since 2.0
*/
public interface IProfileChangeRequest {
/**
* Causes the installation of the mentioned IU.
* @param toInstall the entity to add to the profile
*/
public abstract void add(IInstallableUnit toInstall);
/**
* Causes the installation of all the IUs mentioned
* @param toInstall the installable units to be added to the profile
*/
public abstract void addAll(Collection<IInstallableUnit> toInstall);
/**
* Requests the removal of the specified installable unit
*
* @param toUninstall the installable units to be remove from the profile
*/
public abstract void remove(IInstallableUnit toUninstall);
/**
* Requests the removal of all installable units in the provided collection
* @param toUninstall the installable units to be remove from the profile
*/
public abstract void removeAll(Collection<IInstallableUnit> toUninstall);
/**
* Add extra requirements that must be satisfied by the planner.
*
* @param requirements the additional requirements
*/
public void addExtraRequirements(Collection<IRequirement> requirements);
/**
* Associate an inclusion rule with the installable unit. An inclusion rule will dictate how
* the installable unit is treated when its dependencies are not satisfied.
* <p>
* The provided inclusion rule must be one of the values specified in {@link ProfileInclusionRules}.
* </p>
* @param iu the installable unit to set an inclusion rule for
* @param inclusionRule The inclusion rule.
*/
public abstract void setInstallableUnitInclusionRules(IInstallableUnit iu, String inclusionRule);
/**
* Removes all inclusion rules associated with the given installable unit
*
* @param iu the installable unit to remove inclusion rules for
*/
public abstract void removeInstallableUnitInclusionRules(IInstallableUnit iu);
/**
* Set a global property on the profile
*
* @param key key of the property
* @param value value of the property
*/
public abstract void setProfileProperty(String key, String value);
/**
* Remove a global property on the profile
*
* @param key key of the property
*/
public abstract void removeProfileProperty(String key);
/**
* Associate a property with a given installable unit.
*
* @param key key of the property
* @param value value of the property
*/
public abstract void setInstallableUnitProfileProperty(IInstallableUnit iu, String key, String value);
/**
* Remove a property with a given installable unit.
* @param iu The installable until to remove a property for
* @param key key of the property
*/
public abstract void removeInstallableUnitProfileProperty(IInstallableUnit iu, String key);
/**
* Provide the set of installable units that have been requested for addition
* @return a collection of the installable units to add
*/
public abstract Collection<IInstallableUnit> getAdditions();
/**
* Provide the set of installable units that have been requested for removal
* @return a collection of the installable units to remove
*/
public abstract Collection<IInstallableUnit> getRemovals();
/**
* Get the extra requirements that have been specified through method {@link #addExtraRequirements(Collection)}
* @since 2.2
*/
public abstract Collection<IRequirement> getExtraRequirements();
}
|
