2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.sal.java.api.generator;
10 import static org.opendaylight.controller.sal.java.api.generator.Constants.CLASS;
11 import static org.opendaylight.controller.sal.java.api.generator.Constants.COMMA;
12 import static org.opendaylight.controller.sal.java.api.generator.Constants.ENUM;
13 import static org.opendaylight.controller.sal.java.api.generator.Constants.FINAL;
14 import static org.opendaylight.controller.sal.java.api.generator.Constants.GAP;
15 import static org.opendaylight.controller.sal.java.api.generator.Constants.IFC;
16 import static org.opendaylight.controller.sal.java.api.generator.Constants.LB;
17 import static org.opendaylight.controller.sal.java.api.generator.Constants.LCB;
18 import static org.opendaylight.controller.sal.java.api.generator.Constants.NL;
19 import static org.opendaylight.controller.sal.java.api.generator.Constants.PKG;
20 import static org.opendaylight.controller.sal.java.api.generator.Constants.PRIVATE;
21 import static org.opendaylight.controller.sal.java.api.generator.Constants.PUBLIC;
22 import static org.opendaylight.controller.sal.java.api.generator.Constants.RB;
23 import static org.opendaylight.controller.sal.java.api.generator.Constants.RCB;
24 import static org.opendaylight.controller.sal.java.api.generator.Constants.SC;
25 import static org.opendaylight.controller.sal.java.api.generator.Constants.STATIC;
26 import static org.opendaylight.controller.sal.java.api.generator.Constants.TAB;
28 import java.util.List;
30 import org.opendaylight.controller.sal.binding.model.api.AnnotationType;
31 import org.opendaylight.controller.sal.binding.model.api.Constant;
32 import org.opendaylight.controller.sal.binding.model.api.Enumeration;
33 import org.opendaylight.controller.sal.binding.model.api.Enumeration.Pair;
34 import org.opendaylight.controller.sal.binding.model.api.GeneratedProperty;
35 import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject;
36 import org.opendaylight.controller.sal.binding.model.api.GeneratedType;
37 import org.opendaylight.controller.sal.binding.model.api.MethodSignature;
38 import org.opendaylight.controller.sal.binding.model.api.MethodSignature.Parameter;
39 import org.opendaylight.controller.sal.binding.model.api.ParameterizedType;
40 import org.opendaylight.controller.sal.binding.model.api.Type;
42 public class GeneratorUtil {
44 private GeneratorUtil() {
47 public static String createIfcDeclarationWithPkgName(
48 final GeneratedType genType, final String indent) {
49 return createFileDeclarationWithPkgName(IFC, genType, indent);
52 public static String createClassDeclarationWithPkgName(
53 final GeneratedTransferObject genTransferObject, final String indent) {
54 return createFileDeclarationWithPkgName(CLASS, genTransferObject,
58 private static String createFileDeclarationWithPkgName(final String type,
59 final GeneratedType genType, final String indent) {
60 final StringBuilder builder = new StringBuilder();
61 builder.append(PKG + GAP + genType.getPackageName() + SC);
65 if (!genType.getAnnotations().isEmpty()) {
66 final List<AnnotationType> annotations = genType.getAnnotations();
67 appendAnnotations(builder, annotations);
70 builder.append(PUBLIC + GAP + type + GAP + genType.getName() + GAP
72 return builder.toString();
75 private static StringBuilder appendAnnotations(final StringBuilder builder, final List<AnnotationType> annotations) {
76 if ((builder != null) && (annotations != null)) {
77 for (final AnnotationType annotation : annotations) {
79 builder.append(annotation.getPackageName());
81 builder.append(annotation.getName());
83 if (annotation.containsParameters()) {
85 final List<AnnotationType.Parameter> parameters = annotation
87 appendAnnotationParams(builder, parameters);
95 private static StringBuilder appendAnnotationParams(
96 final StringBuilder builder,
97 final List<AnnotationType.Parameter> parameters) {
98 if (parameters != null) {
100 for (final AnnotationType.Parameter param : parameters) {
105 builder.append(", ");
107 final String paramName = param.getName();
108 if (param.getValue() != null) {
109 builder.append(paramName);
110 builder.append(" = ");
111 builder.append(param.getValue());
113 builder.append(paramName);
114 builder.append(" = {");
115 final List<String> values = param.getValues();
116 builder.append(values.get(0));
117 for (int j = 1; j < values.size(); ++j) {
118 builder.append(", ");
119 builder.append(values.get(j));
129 public static String createConstant(final Constant constant,
130 final String indent) {
131 final StringBuilder builder = new StringBuilder();
132 builder.append(indent + PUBLIC + GAP + STATIC + GAP + FINAL + GAP);
133 builder.append(getExplicitType(constant.getType()) + GAP
134 + constant.getName());
135 builder.append(GAP + "=" + GAP);
136 builder.append(constant.getValue() + SC);
137 return builder.toString();
140 public static String createField(final GeneratedProperty property,
141 final String indent) {
142 final StringBuilder builder = new StringBuilder();
143 builder.append(indent);
144 if (!property.getAnnotations().isEmpty()) {
145 final List<AnnotationType> annotations = property.getAnnotations();
146 appendAnnotations(builder, annotations);
149 builder.append(indent + PRIVATE + GAP);
150 builder.append(getExplicitType(property.getReturnType()) + GAP
151 + property.getName());
153 return builder.toString();
157 * Create method declaration in interface.
163 public static String createMethodDeclaration(final MethodSignature method,
164 final String indent) {
165 final String comment = method.getComment();
166 final Type type = method.getReturnType();
167 final String name = method.getName();
168 final List<Parameter> parameters = method.getParameters();
170 final StringBuilder builder = new StringBuilder();
171 createComment(builder, comment, indent);
173 builder.append(indent);
175 if (!method.getAnnotations().isEmpty()) {
176 final List<AnnotationType> annotations = method.getAnnotations();
177 appendAnnotations(builder, annotations);
181 builder.append(indent + getExplicitType(type) + GAP + name);
183 for (int i = 0; i < parameters.size(); i++) {
184 Parameter p = parameters.get(i);
185 String separator = COMMA;
186 if (i + 1 == parameters.size()) {
189 builder.append(getExplicitType(p.getType()) + GAP + p.getName()
195 return builder.toString();
198 public static String createConstructor(
199 GeneratedTransferObject genTransferObject, final String indent) {
200 final StringBuilder builder = new StringBuilder();
202 final List<GeneratedProperty> properties = genTransferObject
204 builder.append(indent);
205 builder.append(PUBLIC);
207 builder.append(genTransferObject.getName());
210 boolean first = true;
211 if (properties != null) {
212 for (final GeneratedProperty property : properties) {
214 builder.append(getExplicitType(property.getReturnType()));
216 builder.append(property.getName());
219 builder.append(", ");
220 builder.append(getExplicitType(property.getReturnType()));
221 builder.append(builder.append(" "));
222 builder.append(property.getName());
231 builder.append(indent);
233 builder.append("super();");
236 if (properties != null) {
237 for (final GeneratedProperty property : properties) {
238 builder.append(indent);
240 builder.append("this.");
241 builder.append(property.getName());
242 builder.append(" = ");
243 builder.append(property.getName());
249 builder.append(indent);
252 return builder.toString();
255 public static String createGetter(final GeneratedProperty property,
256 final String indent) {
257 final StringBuilder builder = new StringBuilder();
259 final Type type = property.getReturnType();
260 final String varName = property.getName();
261 final char first = Character.toUpperCase(varName.charAt(0));
262 final String methodName = "get" + first + varName.substring(1);
264 builder.append(indent + PUBLIC + GAP + getExplicitType(type) + GAP
266 builder.append(LB + RB + LCB + NL);
268 String currentIndent = indent + TAB;
270 builder.append(currentIndent + "return " + varName + SC + NL);
272 builder.append(indent + RCB);
273 return builder.toString();
276 public static String createHashCode(
277 final List<GeneratedProperty> properties, final String indent) {
278 StringBuilder builder = new StringBuilder();
279 builder.append(indent + "public int hashCode() {" + NL);
280 builder.append(indent + TAB + "final int prime = 31;" + NL);
281 builder.append(indent + TAB + "int result = 1;" + NL);
283 for (GeneratedProperty property : properties) {
284 String fieldName = property.getName();
285 builder.append(indent + TAB + "result = prime * result + (("
286 + fieldName + " == null) ? 0 : " + fieldName
287 + ".hashCode());" + NL);
290 builder.append(indent + TAB + "return result;" + NL);
291 builder.append(indent + RCB + NL);
292 return builder.toString();
295 public static String createEquals(final GeneratedTransferObject type,
296 final List<GeneratedProperty> properties, final String indent) {
297 StringBuilder builder = new StringBuilder();
298 final String indent1 = indent + TAB;
299 final String indent2 = indent + TAB + TAB;
300 final String indent3 = indent + TAB + TAB + TAB;
302 builder.append(indent + "public boolean equals(Object obj) {" + NL);
303 builder.append(indent1 + "if (this == obj) {" + NL);
304 builder.append(indent2 + "return true;" + NL);
305 builder.append(indent1 + "}" + NL);
306 builder.append(indent1 + "if (obj == null) {" + NL);
307 builder.append(indent2 + "return false;" + NL);
308 builder.append(indent1 + "}" + NL);
309 builder.append(indent1 + "if (getClass() != obj.getClass()) {" + NL);
310 builder.append(indent2 + "return false;" + NL);
311 builder.append(indent1 + "}" + NL);
313 String typeStr = type.getPackageName() + "." + type.getName();
314 builder.append(indent1 + typeStr + " other = (" + typeStr + ") obj;"
317 for (GeneratedProperty property : properties) {
318 String fieldName = property.getName();
319 builder.append(indent1 + "if (" + fieldName + " == null) {" + NL);
320 builder.append(indent2 + "if (other." + fieldName + " != null) {"
322 builder.append(indent3 + "return false;" + NL);
323 builder.append(indent2 + "}" + NL);
324 builder.append(indent1 + "} else if (!" + fieldName
325 + ".equals(other." + fieldName + ")) {" + NL);
326 builder.append(indent2 + "return false;" + NL);
327 builder.append(indent1 + "}" + NL);
330 builder.append(indent1 + "return true;" + NL);
332 builder.append(indent + RCB + NL);
333 return builder.toString();
336 public static String createToString(final GeneratedTransferObject type,
337 final List<GeneratedProperty> properties, final String indent) {
338 StringBuilder builder = new StringBuilder();
339 builder.append(indent);
340 builder.append("public String toString() {");
342 builder.append(indent);
344 builder.append("StringBuilder builder = new StringBuilder();");
346 builder.append(indent);
348 builder.append("builder.append(\"");
349 builder.append(type.getName());
350 builder.append(" [");
352 boolean first = true;
353 for (GeneratedProperty property : properties) {
355 builder.append(property.getName());
356 builder.append("=\");");
358 builder.append(indent);
360 builder.append("builder.append(");
361 builder.append(property.getName());
362 builder.append(");");
366 builder.append(indent);
368 builder.append("builder.append(\", ");
369 builder.append(property.getName());
370 builder.append("=\");");
372 builder.append(indent);
374 builder.append("builder.append(\", ");
375 builder.append(property.getName());
376 builder.append(");");
380 builder.append(indent);
382 builder.append("builder.append(\"]\");");
384 builder.append(indent);
386 builder.append("return builder.toString();");
389 builder.append(indent);
392 return builder.toString();
395 public static String createEnum(final Enumeration enumeration,
396 final String indent) {
397 final StringBuilder builder = new StringBuilder(indent + ENUM + GAP
398 + enumeration.getName() + GAP + LCB + NL);
400 String separator = COMMA;
401 final List<Pair> values = enumeration.getValues();
402 builder.append(indent + TAB);
403 for (int i = 0; i < values.size(); i++) {
404 if (i + 1 == values.size()) {
407 builder.append(values.get(i).getName() + separator);
410 builder.append(indent + RCB);
411 return builder.toString();
414 private static String getExplicitType(final Type type) {
415 String packageName = type.getPackageName();
416 if (packageName.endsWith(".")) {
417 packageName = packageName.substring(0, packageName.length() - 1);
419 final StringBuilder builder = new StringBuilder(packageName + "."
421 if (type instanceof ParameterizedType) {
422 ParameterizedType pType = (ParameterizedType) type;
423 Type[] pTypes = pType.getActualTypeArguments();
425 builder.append(getParameters(pTypes));
428 if (builder.toString().equals("java.lang.Void")) {
431 return builder.toString();
434 private static String getParameters(final Type[] pTypes) {
435 final StringBuilder builder = new StringBuilder();
436 for (int i = 0; i < pTypes.length; i++) {
439 String separator = COMMA;
440 if (i + 1 == pTypes.length) {
443 builder.append(getExplicitType(t) + separator);
445 return builder.toString();
448 private static void createComment(final StringBuilder builder,
449 final String comment, final String indent) {
450 if (comment != null && comment.length() > 0) {
451 builder.append(indent + "/*" + NL);
452 builder.append(indent + comment + NL);
453 builder.append(indent + "*/" + NL);