-
Notifications
You must be signed in to change notification settings - Fork 78
/
JavaElementReferenceConverter.java
199 lines (169 loc) · 6.54 KB
/
JavaElementReferenceConverter.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
/*******************************************************************************
* Copyright (c) 2000, 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.jdt.internal.ui.commands;
import java.util.Objects;
import org.eclipse.core.commands.AbstractParameterValueConverter;
import org.eclipse.core.commands.ParameterValueConversionException;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.jdt.core.IField;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaModel;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.Signature;
/**
* A command parameter value converter to convert between Java elements and
* String references that identify them.
* <p>
* References can be made to Java types, methods and fields. The reference
* identifies the project to use as a search scope as well as the java element
* information. Note that non-source elements may be referenced (such as
* java.lang.Object), but they must be resolved within the scope of some
* project.
* </p>
* <p>
* References take the form:
*
* <pre>
* elementRef := typeRef | fieldRef | methodRef
* typeRef := projectName '/' fullyQualifiedTypeName
* fieldRef := typeRef '#' fieldName
* methodRef := typeRef '#' methodName '(' parameterSignatures ')'
* </pre>
*
* where <code>parameterSignatures</code> uses the signature format documented
* in the {@link org.eclipse.jdt.core.Signature Signature} class.
* </p>
*
* @since 3.2
*/
public class JavaElementReferenceConverter extends AbstractParameterValueConverter {
private static final char PROJECT_END_CHAR= '/';
private static final char TYPE_END_CHAR= '#';
private static final char PARAM_START_CHAR= Signature.C_PARAM_START;
private static final char PARAM_END_CHAR= Signature.C_PARAM_END;
@Override
public Object convertToObject(String parameterValue) throws ParameterValueConversionException {
if (parameterValue == null) {
throw new ParameterValueConversionException("Malformed parameterValue"); //$NON-NLS-1$
}
final int projectEndPosition= parameterValue.indexOf(PROJECT_END_CHAR);
if (!(projectEndPosition != -1)) {
throw new ParameterValueConversionException("Malformed parameterValue"); //$NON-NLS-1$
}
String projectName= parameterValue.substring(0, projectEndPosition);
String javaElementRef= parameterValue.substring(projectEndPosition + 1);
IJavaModel javaModel= JavaCore.create(ResourcesPlugin.getWorkspace().getRoot());
assertExists(javaModel);
IJavaProject javaProject= javaModel.getJavaProject(projectName);
assertExists(javaProject);
final int typeEndPosition= javaElementRef.indexOf(TYPE_END_CHAR);
String typeName;
if (typeEndPosition == -1) {
typeName= javaElementRef;
} else {
typeName= javaElementRef.substring(0, typeEndPosition);
}
IType type= null;
try {
type= javaProject.findType(typeName);
} catch (JavaModelException ex) {
// type == null
}
assertExists(type);
Objects.requireNonNull(type);
if (typeEndPosition == -1) {
return type;
}
String memberRef= javaElementRef.substring(typeEndPosition + 1);
final int paramStartPosition= memberRef.indexOf(PARAM_START_CHAR);
if (paramStartPosition == -1) {
IField field= type.getField(memberRef);
assertExists(field);
return field;
}
String methodName= memberRef.substring(0, paramStartPosition);
String signature= memberRef.substring(paramStartPosition);
String[] parameterTypes= null;
try {
parameterTypes= Signature.getParameterTypes(signature);
} catch (IllegalArgumentException ex) {
// parameterTypes == null
}
if (!(parameterTypes != null)) {
throw new ParameterValueConversionException("Malformed parameterValue"); //$NON-NLS-1$
}
IMethod method= type.getMethod(methodName, parameterTypes);
assertExists(method);
return method;
}
/**
* Throws a <code>ParameterValueConversionException</code> if the java
* element reference string identifies an element that does not exist.
*
* @param javaElement
* an element to check for existence
*/
private void assertExists(IJavaElement javaElement) throws ParameterValueConversionException {
if ((javaElement == null) || (!javaElement.exists())) {
throw new ParameterValueConversionException("parameterValue must reference an existing IJavaElement"); //$NON-NLS-1$
}
}
@Override
public String convertToString(Object parameterValue) throws ParameterValueConversionException {
if (!(parameterValue instanceof IJavaElement)) {
throw new ParameterValueConversionException("parameterValue must be an IJavaElement"); //$NON-NLS-1$
}
IJavaElement javaElement= (IJavaElement) parameterValue;
IJavaProject javaProject= javaElement.getJavaProject();
if (javaProject == null) {
throw new ParameterValueConversionException("Could not get IJavaProject for element"); //$NON-NLS-1$
}
StringBuilder buffer;
if (javaElement instanceof IType) {
IType type= (IType) javaElement;
buffer= composeTypeReference(type);
} else
if (javaElement instanceof IMethod) {
IMethod method= (IMethod) javaElement;
buffer= composeTypeReference(method.getDeclaringType());
buffer.append(TYPE_END_CHAR);
buffer.append(method.getElementName());
buffer.append(PARAM_START_CHAR);
for (String parameterType : method.getParameterTypes()) {
buffer.append(parameterType);
}
buffer.append(PARAM_END_CHAR);
} else
if (javaElement instanceof IField) {
IField field= (IField) javaElement;
buffer= composeTypeReference(field.getDeclaringType());
buffer.append(TYPE_END_CHAR);
buffer.append(field.getElementName());
} else {
throw new ParameterValueConversionException("Unsupported IJavaElement type"); //$NON-NLS-1$
}
return buffer.toString();
}
private StringBuilder composeTypeReference(IType type) {
StringBuilder buffer= new StringBuilder();
buffer.append(type.getJavaProject().getElementName());
buffer.append(PROJECT_END_CHAR);
buffer.append(type.getFullyQualifiedName());
return buffer;
}
}