Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 66d0ad3305d667488c995f1ff8b5491f6c9c376c (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
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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
/*******************************************************************************
 * Copyright (c) 2009, 2012 Oracle. 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:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.common.core.internal.resource.java.binary;

import java.util.HashMap;
import java.util.Hashtable;
import java.util.Map;
import java.util.Vector;

import org.eclipse.jdt.core.Flags;
import org.eclipse.jdt.core.IField;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.dom.IMethodBinding;
import org.eclipse.jdt.core.dom.ITypeBinding;
import org.eclipse.jdt.core.dom.IVariableBinding;
import org.eclipse.jdt.core.dom.Modifier;
import org.eclipse.jdt.core.dom.TypeDeclaration;
import org.eclipse.jpt.common.core.internal.plugin.JptCommonCorePlugin;
import org.eclipse.jpt.common.core.internal.resource.java.InheritedAttributeKey;
import org.eclipse.jpt.common.core.internal.utility.jdt.JavaResourceTypeBinding;
import org.eclipse.jpt.common.core.resource.java.JavaResourceAnnotatedElement;
import org.eclipse.jpt.common.core.resource.java.JavaResourceAttribute;
import org.eclipse.jpt.common.core.resource.java.JavaResourceField;
import org.eclipse.jpt.common.core.resource.java.JavaResourceMethod;
import org.eclipse.jpt.common.core.resource.java.JavaResourceNode;
import org.eclipse.jpt.common.core.resource.java.JavaResourceType;
import org.eclipse.jpt.common.core.utility.jdt.TypeBinding;
import org.eclipse.jpt.common.utility.internal.ObjectTools;
import org.eclipse.jpt.common.utility.internal.collection.CollectionTools;
import org.eclipse.jpt.common.utility.internal.iterable.ArrayIterable;
import org.eclipse.jpt.common.utility.internal.iterable.FilteringIterable;
import org.eclipse.jpt.common.utility.internal.iterable.IterableTools;
import org.eclipse.jpt.common.utility.internal.iterable.LiveCloneIterable;
import org.eclipse.jpt.common.utility.internal.iterable.TransformationIterable;

/**
 * binary type
 */
final class BinaryType
		extends BinaryAbstractType
		implements JavaResourceType {
	
	private String superclassQualifiedName;
	
	private boolean abstract_;  // 'abstract' is a reserved word
	
	private boolean hasNoArgConstructor;
	
	private boolean hasPrivateNoArgConstructor;
	
	private final Vector<JavaResourceField> fields = new Vector<JavaResourceField>();
	
	private final Vector<JavaResourceMethod> methods = new Vector<JavaResourceMethod>();
	
	private final Hashtable<InheritedAttributeKey, JavaResourceTypeBinding> inheritedFieldTypes
			= new Hashtable<InheritedAttributeKey, JavaResourceTypeBinding>();
	
	private final Hashtable<InheritedAttributeKey, JavaResourceTypeBinding> inheritedMethodTypes
			= new Hashtable<InheritedAttributeKey, JavaResourceTypeBinding>();
	
	
	// ***** construction/initialization *****
	
	BinaryType(JavaResourceNode parent, IType type) {
		this(parent, new TypeAdapter(type));
	}
	
	private BinaryType(JavaResourceNode parent, TypeAdapter adapter) {
		super(parent, adapter);
		this.superclassQualifiedName = buildSuperclassQualifiedName();
		this.abstract_ = buildAbstract();
		this.hasNoArgConstructor = buildHasNoArgConstructor();
		this.hasPrivateNoArgConstructor = buildHasPrivateNoArgConstructor();
		CollectionTools.addAll(this.fields, buildFields());
		CollectionTools.addAll(this.methods, buildMethods());
		this.inheritedFieldTypes.putAll(buildInheritedFieldTypes(adapter.getTypeBinding()));
		this.inheritedMethodTypes.putAll(buildInheritedMethodTypes(adapter.getTypeBinding()));
	}
	
	
	public Kind getKind() {
		return JavaResourceAnnotatedElement.Kind.TYPE;
	}
	
	
	// ***** overrides *****
	
	@Override
	public void update() {
		super.update();
		updateSuperclassQualifiedName();
		updateAbstract();
		updateHasNoArgConstructor();
		updateHasPrivateNoArgConstructor();
		updateFields();
		updateMethods();
		updateInheritedFieldTypes();
		updateInheritedMethodTypes();
	}
	
	
	// ********** JavaResourceType implementation **********
	
	public void synchronizeWith(TypeDeclaration typeDeclaration) {
		throw new UnsupportedOperationException();		
	}
	
	public void resolveTypes(TypeDeclaration typeDeclaration) {
		throw new UnsupportedOperationException();
	}
	
	
	// ***** superclass qualified name *****
	
	public String getSuperclassQualifiedName() {
		return this.superclassQualifiedName;
	}
	
	private String buildSuperclassQualifiedName() {
		return convertTypeSignatureToTypeName(getSuperclassTypeSignature(getElement()));
	}
	
	private String getSuperclassTypeSignature(IType type) {
		try {
			return type.getSuperclassTypeSignature();
		}
		catch (JavaModelException ex) {
			JptCommonCorePlugin.instance().logError(ex);
			return null;
		}
	}
	
	protected void updateSuperclassQualifiedName() {
		throw new UnsupportedOperationException();
	}
	
	
	// ***** abstract *****
	
	public boolean isAbstract() {
		return this.abstract_;
	}
	
	private boolean buildAbstract() {
		try {
			return Flags.isAbstract(getElement().getFlags());
		}
		catch (JavaModelException ex) {
			JptCommonCorePlugin.instance().logError(ex);
			return false;
		}
	}
	
	protected void updateAbstract() {
		throw new UnsupportedOperationException();
	}
	
	
	// ***** no-arg constructor *****
	
	public boolean hasNoArgConstructor() {
		return this.hasNoArgConstructor;
	}
	
	private boolean buildHasNoArgConstructor() {
		return this.findNoArgConstructor(getElement()) != null;
	}
	
	private IMethod findNoArgConstructor(IType type) {
		try {
			for (IMethod method : type.getMethods()) {
				if (method.isConstructor()) {
					return method;
				}
			}
		}
		catch (JavaModelException ex) {
			JptCommonCorePlugin.instance().logError(ex);
		}
		return null;
	}
	
	protected void updateHasNoArgConstructor() {
		throw new UnsupportedOperationException();
	}
	
	
	// ***** private no-arg constructor *****
	
	public boolean hasPrivateNoArgConstructor() {
		return this.hasPrivateNoArgConstructor;
	}
	
	private boolean buildHasPrivateNoArgConstructor() {
		IMethod method = this.findNoArgConstructor(getElement());
		try {
			return method != null && Flags.isPrivate(method.getFlags());
		}
		catch (JavaModelException ex) {
			JptCommonCorePlugin.instance().logError(ex);
			return false;
		}
	}
	
	protected void updateHasPrivateNoArgConstructor() {
		throw new UnsupportedOperationException();
	}
	
	
	// ***** public/protected no-arg constructor *****
	
	public boolean hasPublicOrProtectedNoArgConstructor() {
		Iterable<JavaResourceMethod> constructors = this.getConstructors();
		if (IterableTools.size(constructors) == 0) {
			return true;
		}
		for (JavaResourceMethod constructor : constructors) {
			if (constructor.getParametersSize() == 0) {
				return Modifier.isPublic(constructor.getModifiers())
						|| Modifier.isProtected(constructor.getModifiers());
			}
		}
		return false;
	}
	
	public boolean hasPublicNoArgConstructor() {
		Iterable<JavaResourceMethod> constructors = this.getConstructors();
		if (IterableTools.size(constructors) == 0) {
			return true;
		}
		for (JavaResourceMethod constructor : constructors) {
			if (constructor.getParametersSize() == 0) {
				return Modifier.isPublic(constructor.getModifiers());
			}
		}
		return false;
	}
	
	protected Iterable<JavaResourceMethod> getConstructors() {
		return new FilteringIterable<JavaResourceMethod>(this.getMethods()) {
			@Override
			protected boolean accept(JavaResourceMethod method) {
				return method.isConstructor();
			}
		};
	}
	
	
	// ***** fields *****
	
	public Iterable<JavaResourceField> getFields() {
		return new LiveCloneIterable<JavaResourceField>(this.fields);
	}
	
	private Iterable<JavaResourceField> buildFields() {
		return new TransformationIterable<IField, JavaResourceField>(
				new ArrayIterable<IField>(getFields(getElement()))) {
			@Override
			protected JavaResourceField transform(IField field) {
				return buildField(field);
			}
		};
	}
	
	private IField[] getFields(IType type) {
		try {
			return type.getFields();
		}
		catch (JavaModelException ex) {
			JptCommonCorePlugin.instance().logError(ex);
			return EMPTY_FIELD_ARRAY;
		}
	}
	
	private static final IField[] EMPTY_FIELD_ARRAY = new IField[0];
	
	private JavaResourceField buildField(IField jdtField) {
		return new BinaryField(this, jdtField);
	}
	
	protected void updateFields() {
		throw new UnsupportedOperationException();
	}
	
	public JavaResourceField getField(String name) {
		for (JavaResourceField field : getFields()) {
			if (ObjectTools.equals(field.getName(), name)) {
				return field;
			}
		}
		return null;
	}
	
	
	// ***** methods *****
	
	public Iterable<JavaResourceMethod> getMethods() {
		return new LiveCloneIterable<JavaResourceMethod>(this.methods);
	}
	
	private Iterable<JavaResourceMethod> buildMethods() {
		return new TransformationIterable<IMethod, JavaResourceMethod>(
				new ArrayIterable<IMethod>(getMethods(getElement()))) {
			@Override
			protected JavaResourceMethod transform(IMethod method) {
				return buildMethod(method);
			}
		};
	}
	
	private IMethod[] getMethods(IType type) {
		try {
			return type.getMethods();
		} catch (JavaModelException ex) {
			JptCommonCorePlugin.instance().logError(ex);
			return EMPTY_METHOD_ARRAY;
		}
	}
	
	private static final IMethod[] EMPTY_METHOD_ARRAY = new IMethod[0];
	
	private JavaResourceMethod buildMethod(IMethod jdtMethod) {
		return new BinaryMethod(this, jdtMethod);
	}
	
	protected void updateMethods() {
		throw new UnsupportedOperationException();
	}
	
	public JavaResourceMethod getMethod(String propertyName) {
		for (JavaResourceMethod method : this.getMethods()) {
			if (ObjectTools.equals(method.getMethodName(), propertyName)) {
				return method;
			}
		}
		return null;
	}
	
	
	// ***** inherited field/method types *****
	
	private Map<InheritedAttributeKey, JavaResourceTypeBinding> buildInheritedFieldTypes(ITypeBinding typeBinding) {
		Map<InheritedAttributeKey, JavaResourceTypeBinding> inheritedFieldTypes = new HashMap<InheritedAttributeKey, JavaResourceTypeBinding>();
		ITypeBinding scTypeBinding = typeBinding.getSuperclass();
		while (scTypeBinding != null && scTypeBinding.isParameterizedType()) {
			// if the superclass is not parameterized, 
			// then this class will have no increased type information for inherited fields
			buildInheritedFieldTypes_(inheritedFieldTypes, scTypeBinding);
			scTypeBinding = scTypeBinding.getSuperclass();
		}
		return inheritedFieldTypes;
	}
	
	private void buildInheritedFieldTypes_(
			Map<InheritedAttributeKey, JavaResourceTypeBinding> inheritedFieldTypes, ITypeBinding typeBinding) {
		String typeName = typeBinding.getTypeDeclaration().getQualifiedName();
		IVariableBinding[] fields = typeBinding.getDeclaredFields();
		for (IVariableBinding field : fields) {
			String fieldName = field.getName();
			inheritedFieldTypes.put(new InheritedAttributeKey(typeName, fieldName), new JavaResourceTypeBinding(field.getType()));
		}
	}
	
	protected void updateInheritedFieldTypes() {
		throw new UnsupportedOperationException();
	}
	
	private Map<InheritedAttributeKey, JavaResourceTypeBinding> buildInheritedMethodTypes(ITypeBinding typeBinding) {
		Map<InheritedAttributeKey, JavaResourceTypeBinding> inheritedMethodTypes = new HashMap<InheritedAttributeKey, JavaResourceTypeBinding>();
		ITypeBinding scTypeBinding = typeBinding.getSuperclass();
		while (scTypeBinding != null && scTypeBinding.isParameterizedType()) {
			// if the superclass is not parameterized, 
			// then this class will have no increased type information for inherited fields
			buildInheritedMethodTypes_(inheritedMethodTypes, scTypeBinding);
			scTypeBinding = scTypeBinding.getSuperclass();
		}
		return inheritedMethodTypes;
	}
	
	private void buildInheritedMethodTypes_(
			Map<InheritedAttributeKey, JavaResourceTypeBinding> inheritedFieldTypes, ITypeBinding typeBinding) {
		String typeName = typeBinding.getTypeDeclaration().getQualifiedName();
		IMethodBinding[] methods = typeBinding.getDeclaredMethods();
		for (IMethodBinding method : methods) {
			String methodName = method.getName();
			inheritedFieldTypes.put(new InheritedAttributeKey(typeName, methodName), new JavaResourceTypeBinding(method.getReturnType()));
		}
	}
	
	protected void updateInheritedMethodTypes() {
		throw new UnsupportedOperationException();
	}
	
	public TypeBinding getAttributeTypeBinding(JavaResourceAttribute attribute) {
		if (attribute.getParent() == this) {
			return attribute.getTypeBinding();
		}
		InheritedAttributeKey key = new InheritedAttributeKey(attribute.getParent().getTypeBinding().getQualifiedName(), attribute.getName());
		if (attribute.getKind() == JavaResourceAnnotatedElement.Kind.FIELD) {
			return this.inheritedFieldTypes.get(key);
		}
		else /* attribute.getKind() == JavaResourceAnnotatedElement.Kind.METHOD */ {
			return this.inheritedMethodTypes.get(key);
		}
	}
	
	
	// ***** misc *****
	
	public boolean hasAnyAnnotatedFields() {
		for (JavaResourceField field : this.getFields()) {
			if (field.isAnnotated()) {
				return true;
			}
		}
		return false;
	}
	
	public boolean hasAnyAnnotatedMethods() {
		for (JavaResourceMethod method : this.getMethods()) {
			if (method.isAnnotated()) {
				return true;
			}
		}
		return false;
	}
	
	// Two more requirements for a valid equals() method:
	// 1. It should be public 
	// 2. The return type should be boolean
	// Both requirements are validated by the compiler so they are excluded here
	public boolean hasEqualsMethod() {
		for (JavaResourceMethod method : this.getMethods()) {
			if (ObjectTools.equals(method.getMethodName(), "equals") //$NON-NLS-1$
					&& method.getParametersSize() == 1
					&& ObjectTools.equals(method.getParameterTypeName(0), Object.class.getName())) {
				return true;
			}
		}
		return false;
	}
	
	// Two more requirements for a valid hashCode() method:
	// 1. It should be public 
	// 2. The return type should be int
	// Both requirements are validated by the compiler so they are excluded here
	public boolean hasHashCodeMethod() {
		for (JavaResourceMethod method : this.getMethods()) {
			if (ObjectTools.equals(method.getMethodName(), "hashCode") //$NON-NLS-1$
					&& method.getParametersSize() == 0) {
				return true;
			}
		}
		return false;
	}
}

Back to the top