blob: 09a7981b40459d9510021632835e21b5e2a70764 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2005, 2011 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.internal.ui.viewers;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.ISchedulingRule;
import org.eclipse.debug.internal.ui.commands.actions.AbstractRequestMonitor;
import org.eclipse.ui.progress.WorkbenchJob;
/**
* Base implementation of an asynchronous request monitor.
* <p>
* Not intended to be sub-classed or instantiated by clients. For internal use
* with the <code>AsynchronousViewer</code> implementation.
* </p>
* @since 3.2
*/
public abstract class AsynchronousRequestMonitor extends AbstractRequestMonitor {
/**
* Model node the update is rooted at
*/
private ModelNode fNode;
/**
* Model the update is being performed for
*/
private AsynchronousModel fModel;
/**
* Whether this request's 'done' method has been called.
*/
private boolean fDone = false;
protected WorkbenchJob fViewerUpdateJob = new WorkbenchJob("Asynchronous viewer update") { //$NON-NLS-1$
@Override
public IStatus runInUIThread(IProgressMonitor monitor) {
// necessary to check if widget is disposed. The item may
// have been removed from the tree when another children update
// occurred.
getModel().viewerUpdateScheduled(AsynchronousRequestMonitor.this);
if (fDone) {
getModel().requestComplete(AsynchronousRequestMonitor.this);
}
if (!isCanceled() && !getNode().isDisposed()) {
IStatus status = getStatus();
if (status != null && !status.isOK()) {
getModel().getViewer().handlePresentationFailure(AsynchronousRequestMonitor.this, status);
} else {
performUpdate();
}
}
getModel().viewerUpdateComplete(AsynchronousRequestMonitor.this);
return Status.OK_STATUS;
}
};
/**
* Constructs an update rooted at the given item.
*
* @param node model node
* @param model model the node is in
*/
public AsynchronousRequestMonitor(ModelNode node, AsynchronousModel model) {
fNode = node;
fModel = model;
// serialize updates per viewer
fViewerUpdateJob.setRule(getUpdateSchedulingRule());
fViewerUpdateJob.setSystem(true);
}
/**
* Returns the scheduling rule for viewer update job.
*
* @return rule or <code>null</code>
*/
protected ISchedulingRule getUpdateSchedulingRule() {
return AsynchronousSchedulingRuleFactory.getDefault().newSerialPerObjectRule(getModel().getViewer());
}
/**
* Returns the model this update is being performed for
*
* @return the model this update is being performed for
*/
protected AsynchronousModel getModel() {
return fModel;
}
/**
* Returns the model node this update is rooted at
*
* @return the model node this update is rooted at
*/
protected ModelNode getNode() {
return fNode;
}
/**
* Returns whether this update contains the given node.
* That is, whether this update is for the same node or a child of
* the given node.
*
* @param node node to test containment on
* @return whether this update contains the given node
*/
protected boolean contains(ModelNode node) {
if (node == getNode()) {
return true;
}
ModelNode parentNode = getNode().getParentNode();
while (parentNode != null) {
if (parentNode.equals(getNode())) {
return true;
}
parentNode = parentNode.getParentNode();
}
return false;
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.IProgressMonitor#setCanceled(boolean)
*/
@Override
public void setCanceled(boolean value) {
super.setCanceled(value);
if (value) {
getModel().requestCanceled(this);
}
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.IProgressMonitor#done()
*/
@Override
public final void done() {
synchronized (this) {
fDone = true;
}
scheduleViewerUpdate(0L);
}
/**
* Returns whether this request is done yet.
*
* @return if the request is done
*/
protected synchronized boolean isDone() {
return fDone;
}
protected void scheduleViewerUpdate(long ms) {
if(!isCanceled())
fViewerUpdateJob.schedule(ms);
}
/**
* Notification this update has been completed and should now be applied to
* this update's viewer. This method is called in the UI thread.
*/
protected abstract void performUpdate();
/**
* Returns whether this update effectively contains the given update.
* That is, whether this update will also perform the given update.
*
* @param update update to compare to
* @return whether this update will also perform the given update
*/
protected abstract boolean contains(AsynchronousRequestMonitor update);
}
|
