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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
/*******************************************************************************
* Copyright (c) 2006, 2008 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.wst.jsdt.core.refactoring.descriptors;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.Assert;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.wst.jsdt.core.IJavaScriptUnit;
import org.eclipse.wst.jsdt.core.IJavaScriptElement;
import org.eclipse.wst.jsdt.core.IMember;
import org.eclipse.wst.jsdt.core.IPackageFragment;
import org.eclipse.wst.jsdt.core.IPackageFragmentRoot;
import org.eclipse.wst.jsdt.core.refactoring.IJavaScriptRefactorings;
import org.eclipse.wst.jsdt.internal.core.refactoring.descriptors.DescriptorMessages;
/**
* Refactoring descriptor for the move refactoring.
* <p>
* An instance of this refactoring descriptor may be obtained by calling
* {@link org.eclipse.ltk.core.refactoring.RefactoringContribution#createDescriptor()} on a refactoring
* contribution requested by invoking
* {@link org.eclipse.ltk.core.refactoring.RefactoringCore#getRefactoringContribution(String)} with the
* appropriate refactoring id.
* </p>
* <p>
* Note: this class is not intended to be instantiated by clients.
* </p>
*
* Provisional API: This class/interface is part of an interim API that is still under development and expected to
* change significantly before reaching stability. It is being made available at this early stage to solicit feedback
* from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
* (repeatedly) as the API evolves.
*/
public final class MoveDescriptor extends JavaScriptRefactoringDescriptor {
/** The destination attribute */
private static final String ATTRIBUTE_DESTINATION= "destination"; //$NON-NLS-1$
/** The files attribute */
private static final String ATTRIBUTE_FILES= "files"; //$NON-NLS-1$
/** The folders attribute */
private static final String ATTRIBUTE_FOLDERS= "folders"; //$NON-NLS-1$
/** The fragments attribute */
private static final String ATTRIBUTE_FRAGMENTS= "fragments"; //$NON-NLS-1$
/** The members attribute */
private static final String ATTRIBUTE_MEMBERS= "members"; //$NON-NLS-1$
/** The patterns attribute */
private static final String ATTRIBUTE_PATTERNS= "patterns"; //$NON-NLS-1$
/** The policy attribute */
private static final String ATTRIBUTE_POLICY= "policy"; //$NON-NLS-1$
/** The qualified attribute */
private static final String ATTRIBUTE_QUALIFIED= "qualified"; //$NON-NLS-1$
/** The roots attribute */
private static final String ATTRIBUTE_ROOTS= "roots"; //$NON-NLS-1$
/** The target attribute */
private static final String ATTRIBUTE_TARGET= "target"; //$NON-NLS-1$
/** The units attribute */
private static final String ATTRIBUTE_UNITS= "units"; //$NON-NLS-1$
/** The move members policy */
private static final String POLICY_MOVE_MEMBERS= "org.eclipse.wst.jsdt.ui.moveMembers"; //$NON-NLS-1$
/** The move packages policy */
private static final String POLICY_MOVE_PACKAGES= "org.eclipse.wst.jsdt.ui.movePackages"; //$NON-NLS-1$
/** The move resources policy */
private static final String POLICY_MOVE_RESOURCES= "org.eclipse.wst.jsdt.ui.moveResources"; //$NON-NLS-1$
/** The move package fragment roots policy */
private static final String POLICY_MOVE_ROOTS= "org.eclipse.wst.jsdt.ui.moveRoots"; //$NON-NLS-1$
/** The destination */
private Object fDestination;
/** The files */
private IFile[] fFiles;
/** The folders */
private IFolder[] fFolders;
/** The package fragments */
private IPackageFragment[] fFragments;
/** The members */
private IMember[] fMembers;
/** The move policy */
private String fMovePolicy= null;
/** The patterns attribute */
private String fPatterns= null;
/** The qualified attribute */
private boolean fQualified= false;
/** The references attribute */
private boolean fReferences= false;
/** The package fragment roots */
private IPackageFragmentRoot[] fRoots;
/** The compilation units */
private IJavaScriptUnit[] fUnits;
/**
* Creates a new refactoring descriptor.
*/
public MoveDescriptor() {
super(IJavaScriptRefactorings.MOVE);
}
/**
* {@inheritDoc}
*/
protected void populateArgumentMap() {
super.populateArgumentMap();
fArguments.put(ATTRIBUTE_POLICY, fMovePolicy);
final String project= getProject();
if (fDestination instanceof IJavaScriptElement)
fArguments.put(ATTRIBUTE_DESTINATION, JavaScriptRefactoringDescriptor.elementToHandle(project, (IJavaScriptElement) fDestination));
else if (fDestination instanceof IResource)
fArguments.put(ATTRIBUTE_TARGET, JavaScriptRefactoringDescriptor.resourceToHandle(null, (IResource) fDestination));
if (POLICY_MOVE_RESOURCES.equals(fMovePolicy)) {
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_REFERENCES, Boolean.toString(fReferences));
fArguments.put(ATTRIBUTE_QUALIFIED, Boolean.toString(fQualified));
if (fPatterns != null && !"".equals(fPatterns)) //$NON-NLS-1$
fArguments.put(ATTRIBUTE_PATTERNS, fPatterns);
fArguments.put(ATTRIBUTE_FILES, new Integer(fFiles.length).toString());
for (int offset= 0; offset < fFiles.length; offset++)
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_ELEMENT + (offset + 1), JavaScriptRefactoringDescriptor.resourceToHandle(project, fFiles[offset]));
fArguments.put(ATTRIBUTE_FOLDERS, new Integer(fFolders.length).toString());
for (int offset= 0; offset < fFolders.length; offset++)
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_ELEMENT + (offset + fFiles.length + 1), JavaScriptRefactoringDescriptor.resourceToHandle(project, fFolders[offset]));
fArguments.put(ATTRIBUTE_UNITS, new Integer(fUnits.length).toString());
for (int offset= 0; offset < fUnits.length; offset++)
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_ELEMENT + (offset + fFolders.length + fFiles.length + 1), JavaScriptRefactoringDescriptor.elementToHandle(project, fUnits[offset]));
} else if (POLICY_MOVE_ROOTS.equals(fMovePolicy)) {
fArguments.put(ATTRIBUTE_ROOTS, new Integer(fRoots.length).toString());
for (int offset= 0; offset < fRoots.length; offset++)
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_ELEMENT + (offset + 1), JavaScriptRefactoringDescriptor.elementToHandle(project, fRoots[offset]));
} else if (POLICY_MOVE_PACKAGES.equals(fMovePolicy)) {
fArguments.put(ATTRIBUTE_FRAGMENTS, new Integer(fFragments.length).toString());
for (int offset= 0; offset < fFragments.length; offset++)
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_ELEMENT + (offset + 1), JavaScriptRefactoringDescriptor.elementToHandle(project, fFragments[offset]));
} else if (POLICY_MOVE_MEMBERS.equals(fMovePolicy)) {
fArguments.put(ATTRIBUTE_MEMBERS, new Integer(fMembers.length).toString());
for (int offset= 0; offset < fMembers.length; offset++)
fArguments.put(JavaScriptRefactoringDescriptor.ATTRIBUTE_ELEMENT + (offset + 1), JavaScriptRefactoringDescriptor.elementToHandle(project, fMembers[offset]));
}
}
/**
* Sets the destination of the move.
* <p>
* Note: Clients may call only one of the <code>setDestination</code>
* methods.
* </p>
*
* @param element
* the java element
*/
public void setDestination(IJavaScriptElement element) {
Assert.isNotNull(element);
fDestination= element;
}
/**
* Sets the destination of the move.
* <p>
* Note: Clients may call only one of the <code>setDestination</code>
* methods.
* </p>
*
* @param resource
* the resource
*/
public void setDestination(IResource resource) {
Assert.isNotNull(resource);
fDestination= resource;
}
/**
* Sets the file name patterns to use during qualified name updating.
* <p>
* The syntax of the file name patterns is a sequence of individual name
* patterns, separated by comma. Additionally, wildcard characters '*' (any
* string) and '?' (any character) may be used.
* </p>
* <p>
* Note: If file name patterns are set, qualified name updating must be
* enabled by calling {@link #setUpdateQualifiedNames(boolean)}.
* </p>
* <p>
* Note: Qualified name updating is currently applicable to files, folders
* and compilation units. The default is to not update qualified names.
* </p>
*
* @param patterns
* the non-empty file name patterns string
*/
public void setFileNamePatterns(final String patterns) {
Assert.isNotNull(patterns);
Assert.isLegal(!"".equals(patterns), "Pattern must not be empty"); //$NON-NLS-1$ //$NON-NLS-2$
fPatterns= patterns;
}
/**
* Sets the members to move.
* <p>
* Note: Clients must only call one of the <code>setMoveXXX</code>
* methods.
* </p>
*
* @param members
* the members to move
*/
public void setMoveMembers(final IMember[] members) {
Assert.isNotNull(members);
Assert.isTrue(fMovePolicy == null, "Clients must only call one of the 'setMoveXXX' methods."); //$NON-NLS-1$
fMembers= members;
fMovePolicy= POLICY_MOVE_MEMBERS;
}
/**
* Sets the package fragment roots to move.
* <p>
* Note: Clients must only call one of the <code>setMoveXXX</code>
* methods.
* </p>
*
* @param roots
* the package fragment roots to move
*/
public void setMovePackageFragmentRoots(final IPackageFragmentRoot[] roots) {
Assert.isNotNull(roots);
Assert.isTrue(fMovePolicy == null, "Clients must only call one of the 'setMoveXXX' methods."); //$NON-NLS-1$
fRoots= roots;
fMovePolicy= POLICY_MOVE_ROOTS;
}
/**
* Sets the package fragments to move.
* <p>
* Note: Clients must only call one of the <code>setMoveXXX</code>
* methods.
* </p>
*
* @param fragments
* the package fragments to move
*/
public void setMovePackages(final IPackageFragment[] fragments) {
Assert.isNotNull(fragments);
Assert.isTrue(fMovePolicy == null, "Clients must only call one of the 'setMoveXXX' methods."); //$NON-NLS-1$
fFragments= fragments;
fMovePolicy= POLICY_MOVE_PACKAGES;
}
/**
* Sets the resources and compilation units to move.
* <p>
* Note: Clients must only call one of the <code>setMoveXXX</code>
* methods.
* </p>
*
* @param files
* the files to move
* @param folders
* the folders to move
* @param units
* the compilation units to move
*/
public void setMoveResources(final IFile[] files, final IFolder[] folders, final IJavaScriptUnit[] units) {
Assert.isNotNull(files);
Assert.isNotNull(folders);
Assert.isNotNull(units);
Assert.isTrue(fMovePolicy == null, "Clients must only call one of the 'setMoveXXX' methods."); //$NON-NLS-1$
fFiles= files;
fFolders= folders;
fUnits= units;
fMovePolicy= POLICY_MOVE_RESOURCES;
}
/**
* Determines whether qualified names of the Java element should be renamed.
* <p>
* Qualified name updating adapts fully qualified names of the Java element
* to be renamed in non-Java text files. Clients may specify file name
* patterns by calling {@link #setFileNamePatterns(String)} to constrain the
* set of text files to be processed.
* </p>
* <p>
* Note: Qualified name updating is currently applicable to files, folders
* and compilation units. The default is to use no file name patterns
* (meaning that all files are processed).
* </p>
*
* @param update
* <code>true</code> to update qualified names,
* <code>false</code> otherwise
*/
public void setUpdateQualifiedNames(final boolean update) {
fQualified= update;
}
/**
* Determines whether references to the Java element should be renamed.
*
* @param update
* <code>true</code> to update references, <code>false</code>
* otherwise
*/
public void setUpdateReferences(final boolean update) {
fReferences= update;
}
/**
* {@inheritDoc}
*/
public RefactoringStatus validateDescriptor() {
RefactoringStatus status= super.validateDescriptor();
if (!status.hasFatalError()) {
if (fMovePolicy == null)
status.merge(RefactoringStatus.createFatalErrorStatus(DescriptorMessages.MoveDescriptor_no_elements_set));
if (fDestination == null)
status.merge(RefactoringStatus.createFatalErrorStatus(DescriptorMessages.MoveDescriptor_no_destination_set));
}
return status;
}
}
|
