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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/*******************************************************************************
* Copyright (c) 2000, 2015 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.ui.internal.registry;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtension;
import org.eclipse.core.runtime.IExtensionPoint;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.dynamichelpers.ExtensionTracker;
import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;
import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.IWorkingSetPage;
/**
* Stores working set descriptors for working set extensions.
*/
public class WorkingSetRegistry implements IExtensionChangeHandler {
// used in Workbench plugin.xml for default workingSet extension
// @issue this is an IDE specific working set page!
private static final String DEFAULT_PAGE_ID = "org.eclipse.ui.resourceWorkingSetPage"; //$NON-NLS-1$
private HashMap<String, WorkingSetDescriptor> workingSetDescriptors = new HashMap<>();
/**
*
*/
public WorkingSetRegistry() {
IExtensionTracker tracker = PlatformUI.getWorkbench().getExtensionTracker();
tracker.registerHandler(this, ExtensionTracker.createExtensionPointFilter(getExtensionPointFilter()));
}
/**
*
* @return
* @since 3.3
*/
private IExtensionPoint getExtensionPointFilter() {
return Platform.getExtensionRegistry().getExtensionPoint(PlatformUI.PLUGIN_ID,
IWorkbenchRegistryConstants.PL_WORKINGSETS);
}
/**
* Adds a working set descriptor.
*
* @param descriptor working set descriptor to add. Must not exist in the
* registry yet.
*/
public void addWorkingSetDescriptor(WorkingSetDescriptor descriptor) {
Assert.isTrue(!workingSetDescriptors.containsValue(descriptor), "working set descriptor already registered"); //$NON-NLS-1$
IExtensionTracker tracker = PlatformUI.getWorkbench().getExtensionTracker();
tracker.registerObject(descriptor.getConfigurationElement().getDeclaringExtension(), descriptor,
IExtensionTracker.REF_WEAK);
workingSetDescriptors.put(descriptor.getId(), descriptor);
}
/**
* Returns the default, resource based, working set page
*
* @return the default working set page.
*/
public IWorkingSetPage getDefaultWorkingSetPage() {
// @issue this will return the IDE resource working set page... not good for
// generic workbench
WorkingSetDescriptor descriptor = workingSetDescriptors.get(DEFAULT_PAGE_ID);
if (descriptor != null) {
return descriptor.createWorkingSetPage();
}
return null;
}
/**
* Returns the working set descriptor with the given id.
*
* @param pageId working set page id
* @return the working set descriptor with the given id.
*/
public WorkingSetDescriptor getWorkingSetDescriptor(String pageId) {
return workingSetDescriptors.get(pageId);
}
/**
* Returns an array of all working set descriptors.
*
* @return an array of all working set descriptors.
*/
public WorkingSetDescriptor[] getWorkingSetDescriptors() {
return workingSetDescriptors.values().toArray(new WorkingSetDescriptor[workingSetDescriptors.size()]);
}
/**
* Returns an array of all working set descriptors having a page class attribute
*
* @return an array of all working set descriptors having a page class attribute
*/
public WorkingSetDescriptor[] getNewPageWorkingSetDescriptors() {
Collection descriptors = workingSetDescriptors.values();
List result = new ArrayList(descriptors.size());
for (Iterator iter = descriptors.iterator(); iter.hasNext();) {
WorkingSetDescriptor descriptor = (WorkingSetDescriptor) iter.next();
if (descriptor.getPageClassName() != null) {
result.add(descriptor);
}
}
return (WorkingSetDescriptor[]) result.toArray(new WorkingSetDescriptor[result.size()]);
}
/**
* Returns <code>true</code> if there is a working set descriptor with a page
* class attribute. Otherwise <code>false</code> is returned.
*
* @return whether a descriptor with a page class attribute exists
*/
public boolean hasNewPageWorkingSetDescriptor() {
Collection descriptors = workingSetDescriptors.values();
for (Iterator iter = descriptors.iterator(); iter.hasNext();) {
WorkingSetDescriptor descriptor = (WorkingSetDescriptor) iter.next();
if (descriptor.getPageClassName() != null) {
return true;
}
}
return false;
}
public List<WorkingSetDescriptor> getUpdaterDescriptorsForNamespace(String namespace) {
if (namespace == null) { // fix for Bug 84225
return Collections.emptyList();
}
List<WorkingSetDescriptor> result = new ArrayList<>();
for (WorkingSetDescriptor descriptor : workingSetDescriptors.values()) {
if (namespace.equals(descriptor.getUpdaterNamespace())) {
result.add(descriptor);
}
}
return result;
}
public WorkingSetDescriptor[] getElementAdapterDescriptorsForNamespace(String namespace) {
if (namespace == null) // fix for Bug 84225
return new WorkingSetDescriptor[0];
Collection descriptors = workingSetDescriptors.values();
List result = new ArrayList();
for (Iterator iter = descriptors.iterator(); iter.hasNext();) {
WorkingSetDescriptor descriptor = (WorkingSetDescriptor) iter.next();
if (namespace.equals(descriptor.getDeclaringNamespace())) {
result.add(descriptor);
}
}
return (WorkingSetDescriptor[]) result.toArray(new WorkingSetDescriptor[result.size()]);
}
/**
* Returns the working set page with the given id.
*
* @param pageId working set page id
* @return the working set page with the given id.
*/
public IWorkingSetPage getWorkingSetPage(String pageId) {
WorkingSetDescriptor descriptor = workingSetDescriptors.get(pageId);
if (descriptor == null) {
return null;
}
return descriptor.createWorkingSetPage();
}
/**
* Loads the working set registry.
*/
public void load() {
WorkingSetRegistryReader reader = new WorkingSetRegistryReader();
reader.readWorkingSets(Platform.getExtensionRegistry(), this);
}
@Override
public void addExtension(IExtensionTracker tracker, IExtension extension) {
WorkingSetRegistryReader reader = new WorkingSetRegistryReader(this);
for (IConfigurationElement element : extension.getConfigurationElements()) {
reader.readElement(element);
}
}
@Override
public void removeExtension(IExtension extension, Object[] objects) {
for (Object object : objects) {
if (object instanceof WorkingSetDescriptor) {
WorkingSetDescriptor desc = (WorkingSetDescriptor) object;
workingSetDescriptors.remove(desc.getId());
}
}
}
}
|
