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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/*******************************************************************************
* Copyright (c) 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.prov.ui.operations;
import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.commands.operations.*;
import org.eclipse.core.runtime.*;
import org.eclipse.equinox.prov.core.ProvisionException;
import org.eclipse.equinox.prov.ui.ProvUIActivator;
import org.eclipse.equinox.prov.ui.ProvisioningUndoSupport;
import org.eclipse.equinox.prov.ui.internal.ProvUIMessages;
import org.eclipse.osgi.util.NLS;
/**
* Abstract class representing provisioning operations
*
* @since 3.4
*/
public abstract class ProvisioningOperation extends AbstractOperation implements IAdvancedUndoableOperation, IAdvancedUndoableOperation2 {
/*
* Specifies whether any user prompting is appropriate while computing
* status.
*/
protected boolean quietCompute = false;
public ProvisioningOperation(String label) {
super(label);
addContext(ProvisioningUndoSupport.getProvisioningUndoContext());
}
/**
*
*/
public IStatus execute(IProgressMonitor monitor, final IAdaptable uiInfo) throws ExecutionException {
IStatus status;
try {
status = doExecute(monitor, uiInfo);
} catch (final ProvisionException e) {
throw new ExecutionException(NLS.bind(ProvUIMessages.ProvisioningOperation_ExecuteErrorTitle, getLabel()), e);
} catch (OperationCanceledException e) {
return Status.CANCEL_STATUS;
}
return status;
}
/**
*
*/
public IStatus redo(IProgressMonitor monitor, final IAdaptable uiInfo) throws ExecutionException {
IStatus status;
try {
status = doExecute(monitor, uiInfo);
} catch (final ProvisionException e) {
throw new ExecutionException(NLS.bind(ProvUIMessages.ProvisioningOperation_RedoErrorTitle, getLabel()), e);
} catch (OperationCanceledException e) {
return Status.CANCEL_STATUS;
}
return status;
}
/**
*
*/
public IStatus undo(IProgressMonitor monitor, final IAdaptable uiInfo) throws ExecutionException {
IStatus status;
try {
status = doUndo(monitor, uiInfo);
} catch (final ProvisionException e) {
throw new ExecutionException(NLS.bind(ProvUIMessages.ProvisioningOperation_UndoErrorTitle, getLabel()), e);
} catch (OperationCanceledException e) {
return Status.CANCEL_STATUS;
}
return status;
}
/**
* Perform the specific work involved in undoing this operation.
*
* @param monitor
* the progress monitor to use for the operation
* @param uiInfo
* the IAdaptable (or <code>null</code>) provided by the
* caller in order to supply UI information for prompting the
* user if necessary. When this parameter is not
* <code>null</code>, it contains an adapter for the
* org.eclipse.swt.widgets.Shell.class
* @throws ProvisionException
* propagates any ProvisionException thrown
*/
protected abstract IStatus doUndo(IProgressMonitor monitor, IAdaptable uiInfo) throws ProvisionException;
/**
* Perform the specific work involved in executing this operation.
*
* @param monitor
* the progress monitor to use for the operation
* @param uiInfo
* the IAdaptable (or <code>null</code>) provided by the
* caller in order to supply UI information for prompting the
* user if necessary. When this parameter is not
* <code>null</code>, it contains an adapter for the
* org.eclipse.swt.widgets.Shell.class
* @throws ProvisionException
* propagates any ProvisionException thrown
*
*/
protected abstract IStatus doExecute(IProgressMonitor monitor, IAdaptable uiInfo) throws ProvisionException;
/*
* (non-Javadoc)
*
* @see org.eclipse.core.commands.operations.AbstractOperation#canRedo()
*/
public boolean canRedo() {
return canExecute();
}
/*
* (non-Javadoc)
*
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation#aboutToNotify(org.eclipse.core.commands.operations.OperationHistoryEvent)
*/
public void aboutToNotify(OperationHistoryEvent event) {
// do nothing
}
/*
* (non-Javadoc)
*
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation#getAffectedObjects()
*/
public Object[] getAffectedObjects() {
return new Object[0];
}
/*
* (non-Javadoc)
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation#computeRedoableStatus(org.eclipse.core.runtime.IProgressMonitor)
*/
public IStatus computeRedoableStatus(IProgressMonitor monitor) throws ExecutionException {
return computeExecutionStatus(monitor);
}
/*
* (non-Javadoc)
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation#computeUndoableStatus(org.eclipse.core.runtime.IProgressMonitor)
*/
public IStatus computeUndoableStatus(IProgressMonitor monitor) throws ExecutionException {
return okStatus();
}
/*
* (non-Javadoc)
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation2#computeExecutionStatus(org.eclipse.core.runtime.IProgressMonitor)
*/
public IStatus computeExecutionStatus(IProgressMonitor monitor) throws ExecutionException {
return okStatus();
}
/*
* (non-Javadoc)
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation2#runInBackground()
*/
public boolean runInBackground() {
return true;
}
/*
* (non-Javadoc)
* @see org.eclipse.core.commands.operations.IAdvancedUndoableOperation2#setQuietCompute(boolean)
*/
public void setQuietCompute(boolean quiet) {
quietCompute = quiet;
}
protected IStatus okStatus() {
return Status.OK_STATUS;
}
protected IStatus failureStatus() {
return new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, getLabel());
}
}
|
