/
ClassBuilder.java
446 lines (401 loc) · 10.5 KB
/
ClassBuilder.java
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
/*******************************************************************************
* Copyright (c) 2017 Red Hat, Inc and others.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Red Hat, Inc - initial API and implementation
*******************************************************************************/
package org.eclipse.reddeer.codegen.builder;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.eclipse.reddeer.codegen.wizards.MethodsPage;
import org.eclipse.swt.SWT;
/**
* Class for completing and building a structure of JAVA class.
*
* @author djelinek
*/
public class ClassBuilder {
private static final String SPACE = " ";
private static final String SEMICOLON = ";";
private static final String TAB = "\t";
private static final String NEW_LINE = "\n";
private static final String D_NEW_LINE = "\n\n";
private static final String JAVA_QUALIFIER = ".java";
private String className;
private String visibility;
private StringBuffer classBuilder;
private String packageName;
private List<String> imports;
private List<String> selectedOptions;
private List<MethodBuilder> methods;
private Map<String, String> constants;
private String extendedClass;
public ClassBuilder(String name, String projectPackage) {
this.className = getClassName(name);
this.visibility = "public";
this.packageName = projectPackage;
this.extendedClass = "";
methods = new ArrayList<>();
imports = new ArrayList<>();
selectedOptions = new ArrayList<>();
constants = new TreeMap<>();
classBuilder = new StringBuffer();
}
public ClassBuilder(String name, String projectPackage, List<MethodBuilder> methods) {
this.className = getClassName(name);
this.visibility = "public";
this.packageName = projectPackage;
this.methods = methods;
this.extendedClass = "";
imports = new ArrayList<>();
selectedOptions = new ArrayList<>();
constants = new TreeMap<>();
classBuilder = new StringBuffer();
}
/**
* Default constructor with predefined class parameters
*
* <ul>
* <li>className - DefaultCodeGenClass</li>
* <li>visibility - public</li>
* </ul>
*/
public ClassBuilder() {
this.className = "CodeGenDefault";
this.visibility = "public";
this.packageName = "org";
this.extendedClass = "";
methods = new ArrayList<>();
imports = new ArrayList<>();
selectedOptions = new ArrayList<>();
constants = new TreeMap<>();
classBuilder = new StringBuffer();
}
/**
* Static method for ClassBuilder instance
*
* @return ClassBuilder instance
*/
public static ClassBuilder getInstance() {
return new ClassBuilder();
}
/**
* Create class method with defined name
*
* @param name
* String
*/
public void createMethod(String name) {
methods.add(new MethodBuilder().name(name));
}
/**
* Adds method
*
* @param method
* MethodBuilder - method
*/
public void addMethod(MethodBuilder method) {
for (MethodBuilder m : methods) {
if (m.getName().equals(method.getName()))
return;
}
methods.add(method);
}
/**
* Adds list of methods
*
* @param methods
* MethodBuilder - list of methods
*/
public void addMethods(List<MethodBuilder> meths) {
boolean exist;
for (MethodBuilder meth : meths) {
exist = false;
for (MethodBuilder m : methods) {
if (m.getName().equals(meth.getName()))
exist = true;
}
if (!exist)
this.methods.add(meth);
}
}
/**
* Adds package to class imported packages
*
* @param packageName
* String - name for class imported packages
*/
public void setPackage(String packageName) {
this.packageName = packageName;
}
/**
* Adds import to class
*
* @param importName
* String - name for class import
*/
public void addImport(String importName) {
if (!this.imports.contains(importName))
this.imports.add(importName);
}
/**
* Adds imports to class
*
* @param imports
* List of imports
*/
public void addImports(List<String> imports) {
for (String im : imports) {
if (!this.imports.contains(im))
this.imports.add(im);
}
}
/**
* Delete all class imports
*/
public void clearImports() {
this.imports.clear();
}
/**
* Delete specific import
*
* @param importt
* String
*/
public void removeImport(String importt) {
if (imports.contains(importt))
imports.remove(importt);
}
/**
* Delete specific import
*
* @param type
* SWT
*/
public void removeImport(int type) {
String importt = "";
switch (type) {
case SWT.PUSH:
importt = "org.eclipse.reddeer.swt.impl.button.PushButton";
break;
case SWT.CHECK:
importt = "org.eclipse.reddeer.swt.impl.button.CheckBox";
break;
case SWT.ARROW:
importt = "org.eclipse.reddeer.swt.impl.button.ArrowButton";
break;
case SWT.RADIO:
importt = "org.eclipse.reddeer.swt.impl.button.RadioButton";
break;
case SWT.TOGGLE:
importt = "org.eclipse.reddeer.swt.impl.button.ToggleButton";
break;
default:
break;
}
if (imports.contains(importt))
imports.remove(importt);
}
/**
* Add new selected additional property to optional properties list
*
* @param options
* List of selected optional properties
*/
public void addOptions(List<String> options) {
this.selectedOptions = options;
}
/**
* Sets name of class
*
* @param name
* String
*/
public void setClassName(String name) {
this.className = name;
}
/**
* Get class name
*
* @return String
*/
public String getClassName() {
return this.className;
}
/**
* Get package name
*
* @return String
*/
public String getPackageName() {
return this.packageName;
}
/**
* Get extended class name
*
* @return String
*/
public String getExtendedClass() {
return this.extendedClass;
}
/**
* Set extended class name
*
* @param name
* String
*/
public void setExtendedClass(String name) {
this.extendedClass = name;
}
/**
* Add new constants
*
* @param map
* Map of generated constants
*/
public void addConstants(Map<String, String> map) {
if (map != null)
this.constants.putAll(map);
}
@Override
public String toString() {
classBuilder = new StringBuffer(iniComment());
// Add all packages into class
classBuilder.append("package").append(SPACE).append(packageName).append(SEMICOLON).append(D_NEW_LINE);
// remove methods which will be inherit and use appropriate "extends" class
// header
boolean extend = removeInheriteMethods();
// Add all imports into class
for (String projectImport : imports) {
classBuilder.append("import").append(SPACE).append(projectImport).append(SEMICOLON).append(NEW_LINE);
}
if (!imports.isEmpty())
classBuilder.append(NEW_LINE);
// create head of class
if (extend && selectedOptions.contains(MethodsPage.INHERITING)
&& selectedOptions.contains(MethodsPage.INCLUDE_ALL)) {
classBuilder.append(visibility).append(SPACE).append("class").append(SPACE).append(getClassName(className))
.append(SPACE).append("extends").append(SPACE).append(extendedClass).append(SPACE).append("{");
} else {
classBuilder.append(visibility).append(SPACE).append("class").append(SPACE).append(getClassName(className))
.append(SPACE).append("{");
}
// class constants
if (!constants.isEmpty()) {
for (String constant : constants.keySet()) {
classBuilder.append(D_NEW_LINE).append(TAB).append("public static final String").append(SPACE)
.append(constant).append(" = ").append("\"" + constants.get(constant) + "\"").append(SEMICOLON);
}
}
// class methods
Collections.sort(methods);
classBuilder.append(D_NEW_LINE).append(TAB).append("// Generated class methods ").append("(")
.append(methods.size()).append(")").append(NEW_LINE);
for (MethodBuilder method : methods) {
classBuilder.append(method.toString()).append(D_NEW_LINE);
}
// end of class
classBuilder.append("}");
return classBuilder.toString();
}
/**
* Validate if class could inherit or not
*
* @return true/false
*/
public boolean isExtendible() {
boolean extendible = false;
for (MethodBuilder meth : this.methods) {
if (meth.getName().contains("Finish") || meth.getName().contains("Cancel")
|| meth.getName().contains("Next") || meth.getName().contains("Back")
|| meth.getName().contains("OK")) {
extendible = true;
}
}
return extendible;
}
/**
* Remove methods which will be inherit
*/
public boolean removeInheriteMethods() {
List<MethodBuilder> toRemove = new ArrayList<>();
for (MethodBuilder meth : this.methods) {
if (meth.getName().contains("Finish") || meth.getName().contains("Cancel")
|| meth.getName().contains("Next") || meth.getName().contains("Back")
|| meth.getName().contains("OK")) {
toRemove.add(meth);
}
}
if (isExtendible() && selectedOptions.contains(MethodsPage.INHERITING)
&& selectedOptions.contains(MethodsPage.INCLUDE_ALL)) {
for (MethodBuilder rm : toRemove) {
methods.remove(rm);
}
int i = 0;
for (MethodBuilder meth : this.methods) {
if (meth.getRule().equals("BTN"))
i++;
}
if (i == 0) {
removeImport(SWT.PUSH);
}
}
return true;
}
/**
* Generate initial header (initial class comment)
*
* @return String
*/
private String iniComment() {
StringBuffer sb = new StringBuffer();
sb.append("/** \n" + " * This class '" + getFileName(className)
+ "' was generated by RedDeer Code Generator. \n");
sb.append(" * Selected options:");
for (String optional : selectedOptions) {
sb.append("\n *").append(TAB).append(TAB).append(optional);
}
sb.append("\n */ \n");
return sb.toString();
}
/**
* Get class name (advanced), could contains .java
*
* @param name
* @return String
*/
private String getClassName(String name) {
try {
if (name.substring(name.lastIndexOf("."), name.length()).equals(JAVA_QUALIFIER))
return name.substring(0, name.lastIndexOf("."));
else
return name;
} catch (Exception e) {
return name;
}
}
/**
* return file name as filename.java
*
* @param name
* @return String
*/
private String getFileName(String name) {
try {
if (name.substring(name.lastIndexOf("."), name.length()).equals(JAVA_QUALIFIER))
return name;
else
return name + JAVA_QUALIFIER;
} catch (Exception e) {
return name + JAVA_QUALIFIER;
}
}
}