2 * Copyright (c) 2014 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.mdsal.binding.java.api.generator
10 import static extension org.apache.commons.text.StringEscapeUtils.escapeJava
11 import static org.opendaylight.mdsal.binding.model.util.BindingTypes.DATA_OBJECT
12 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME
13 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTATION_FIELD
15 import com.google.common.collect.ImmutableList
16 import java.util.ArrayList
17 import java.util.Collection
18 import java.util.HashSet
22 import org.opendaylight.mdsal.binding.model.api.AnnotationType
23 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty
24 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
25 import org.opendaylight.mdsal.binding.model.api.GeneratedType
26 import org.opendaylight.mdsal.binding.model.api.JavaTypeName
27 import org.opendaylight.mdsal.binding.model.api.ParameterizedType
28 import org.opendaylight.mdsal.binding.model.api.Type
29 import org.opendaylight.mdsal.binding.model.util.TypeConstants
30 import org.opendaylight.mdsal.binding.model.util.Types
31 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping
32 import org.opendaylight.yangtools.concepts.Builder
33 import org.opendaylight.yangtools.yang.binding.AugmentationHolder
36 * Template for generating JAVA builder classes.
38 class BuilderTemplate extends AbstractBuilderTemplate {
40 * Constant used as suffix for builder name.
42 package static val BUILDER_STR = "Builder";
44 static val AUGMENTATION_FIELD_UPPER = AUGMENTATION_FIELD.toFirstUpper
45 static val BUILDER = JavaTypeName.create(Builder)
48 * Constructs new instance of this class.
49 * @throws IllegalArgumentException if <code>genType</code> equals <code>null</code>
51 new(GeneratedType genType, GeneratedType targetType, Set<GeneratedProperty> properties, Type augmentType,
53 super(genType, targetType, properties, augmentType, keyType)
56 override isLocalInnerClass(JavaTypeName name) {
57 // Builders do not have inner types
62 * Template method which generates JAVA class body for builder class and for IMPL class.
64 * @return string with JAVA source code
67 «wrapToDocumentation(formatDataForJavaDoc(targetType))»
68 «targetType.annotations.generateDeprecatedAnnotation»
69 public class «type.name» implements «BUILDER.importedName»<«targetType.importedName»> {
71 «generateFields(false)»
73 «constantsDeclarations()»
75 «IF augmentType !== null»
76 «generateAugmentField()»
79 «generateConstructorsFromIfcs()»
81 public «generateCopyConstructor(targetType, type.enclosedTypes.get(0))»
83 «generateMethodFieldsFrom()»
85 «generateGetters(false)»
86 «IF augmentType !== null»
88 «generateAugmentation()»
93 @«OVERRIDE.importedName»
94 public «targetType.name» build() {
95 return new «type.enclosedTypes.get(0).importedName»(this);
98 «new BuilderImplTemplate(this, type.enclosedTypes.get(0)).body»
102 override generateDeprecatedAnnotation(AnnotationType ann) {
103 val forRemoval = ann.getParameter("forRemoval")
104 if (forRemoval !== null) {
105 return "@" + DEPRECATED.importedName + "(forRemoval = " + forRemoval.value + ")"
107 return "@" + SUPPRESS_WARNINGS.importedName + "(\"deprecation\")"
111 * Generate default constructor and constructor for every implemented interface from uses statements.
113 def private generateConstructorsFromIfcs() '''
114 public «type.name»() {
116 «IF (!(targetType instanceof GeneratedTransferObject))»
117 «FOR impl : targetType.implements»
118 «generateConstructorFromIfc(impl)»
124 * Generate constructor with argument of given type.
126 def private Object generateConstructorFromIfc(Type impl) '''
127 «IF (impl instanceof GeneratedType)»
128 «IF impl.hasNonDefaultMethods»
129 public «type.name»(«impl.fullyQualifiedName» arg) {
130 «printConstructorPropertySetter(impl)»
133 «FOR implTypeImplement : impl.implements»
134 «generateConstructorFromIfc(implTypeImplement)»
139 def private Object printConstructorPropertySetter(Type implementedIfc) '''
140 «IF (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject))»
141 «val ifc = implementedIfc as GeneratedType»
142 «FOR getter : ifc.nonDefaultMethods»
143 «IF BindingMapping.isGetterMethodName(getter.name)»
144 this._«getter.propertyNameFromGetter» = arg.«getter.name»();
147 «FOR impl : ifc.implements»
148 «printConstructorPropertySetter(impl)»
154 * Generate 'fieldsFrom' method to set builder properties based on type of given argument.
156 def private generateMethodFieldsFrom() '''
157 «IF (!(targetType instanceof GeneratedTransferObject))»
158 «IF targetType.hasImplementsFromUses»
159 «val List<Type> done = targetType.getBaseIfcs»
160 «generateMethodFieldsFromComment(targetType)»
161 public void fieldsFrom(«DATA_OBJECT.importedName» arg) {
162 boolean isValidArg = false;
163 «FOR impl : targetType.getAllIfcs»
164 «generateIfCheck(impl, done)»
166 «CODEHELPERS.importedName».validValue(isValidArg, arg, "«targetType.getAllIfcs.toListOfNames»");
172 def private generateMethodFieldsFromComment(GeneratedType type) '''
174 * Set fields from given grouping argument. Valid argument is instance of one of following types:
176 «FOR impl : type.getAllIfcs»
177 * <li>«impl.fullyQualifiedName»</li>
181 * @param arg grouping object
182 * @throws IllegalArgumentException if given argument is none of valid types
187 * Method is used to find out if given type implements any interface from uses.
189 def boolean hasImplementsFromUses(GeneratedType type) {
191 for (impl : type.getAllIfcs) {
192 if (impl instanceof GeneratedType && (impl as GeneratedType).hasNonDefaultMethods) {
199 def private generateIfCheck(Type impl, List<Type> done) '''
200 «IF (impl instanceof GeneratedType && (impl as GeneratedType).hasNonDefaultMethods)»
201 «val implType = impl as GeneratedType»
202 if (arg instanceof «implType.fullyQualifiedName») {
203 «printPropertySetter(implType)»
209 def private printPropertySetter(Type implementedIfc) '''
210 «IF (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject))»
211 «val ifc = implementedIfc as GeneratedType»
212 «FOR getter : ifc.nonDefaultMethods»
213 «IF BindingMapping.isGetterMethodName(getter.name)»
214 this._«getter.propertyNameFromGetter» = ((«implementedIfc.fullyQualifiedName»)arg).«getter.name»();
220 private def List<Type> getBaseIfcs(GeneratedType type) {
221 val List<Type> baseIfcs = new ArrayList();
222 for (ifc : type.implements) {
223 if (ifc instanceof GeneratedType && (ifc as GeneratedType).hasNonDefaultMethods) {
230 private def Set<Type> getAllIfcs(Type type) {
231 val Set<Type> baseIfcs = new HashSet()
232 if (type instanceof GeneratedType && !(type instanceof GeneratedTransferObject)) {
233 val ifc = type as GeneratedType
234 for (impl : ifc.implements) {
235 if (impl instanceof GeneratedType && (impl as GeneratedType).hasNonDefaultMethods) {
238 baseIfcs.addAll(impl.getAllIfcs)
244 private def List<String> toListOfNames(Collection<Type> types) {
245 val List<String> names = new ArrayList
247 names.add(type.fullyQualifiedName)
252 def private constantsDeclarations() '''
253 «FOR c : type.getConstantDefinitions»
254 «IF c.getName.startsWith(TypeConstants.PATTERN_CONSTANT_NAME)»
255 «val cValue = c.value as Map<String, String>»
256 «val String fieldSuffix = c.getName.substring(TypeConstants.PATTERN_CONSTANT_NAME.length)»
257 «val jurPatternRef = JUR_PATTERN.importedName»
258 «IF cValue.size == 1»
259 «val firstEntry = cValue.entrySet.iterator.next»
260 private static final «jurPatternRef» «Constants.MEMBER_PATTERN_LIST»«fieldSuffix» = «jurPatternRef».compile("«firstEntry.key.escapeJava»");
261 private static final String «Constants.MEMBER_REGEX_LIST»«fieldSuffix» = "«firstEntry.value.escapeJava»";
263 private static final «jurPatternRef»[] «Constants.MEMBER_PATTERN_LIST»«fieldSuffix» = «CODEHELPERS.importedName».compilePatterns(«ImmutableList.importedName».of(
264 «FOR v : cValue.keySet SEPARATOR ", "»"«v.escapeJava»"«ENDFOR»));
265 private static final String[] «Constants.MEMBER_REGEX_LIST»«fieldSuffix» = { «
266 FOR v : cValue.values SEPARATOR ", "»"«v.escapeJava»"«ENDFOR» };
274 def private generateSetter(GeneratedProperty field) {
275 val returnType = field.returnType
276 if (returnType instanceof ParameterizedType) {
277 if (Types.isListType(returnType)) {
278 return generateListSetter(field, returnType.actualTypeArguments.get(0), "")
279 } else if (Types.isMapType(returnType)) {
280 return generateListSetter(field, returnType.actualTypeArguments.get(1), ".values()")
283 return generateSimpleSetter(field, returnType)
286 def private generateListSetter(GeneratedProperty field, Type actualType, String extractor) '''
287 «val restrictions = restrictionsForSetter(actualType)»
288 «IF restrictions !== null»
289 «generateCheckers(field, restrictions, actualType)»
291 public «type.getName» set«field.getName.toFirstUpper»(final «field.returnType.importedName» values) {
292 «IF restrictions !== null»
293 if (values != null) {
294 for («actualType.importedName» value : values«extractor») {
295 «checkArgument(field, restrictions, actualType, "value")»
299 this.«field.fieldName» = values;
305 def private generateSimpleSetter(GeneratedProperty field, Type actualType) '''
306 «val restrictions = restrictionsForSetter(actualType)»
307 «IF restrictions !== null»
309 «generateCheckers(field, restrictions, actualType)»
312 «val setterName = "set" + field.getName.toFirstUpper»
313 public «type.getName» «setterName»(final «field.returnType.importedName» value) {
314 «IF restrictions !== null»
316 «checkArgument(field, restrictions, actualType, "value")»
319 this.«field.fieldName» = value;
325 * Template method which generates setter methods
327 * @return string with the setter methods
329 def private generateSetters() '''
330 «IF keyType !== null»
331 public «type.getName» withKey(final «keyType.importedName» key) {
336 «FOR property : properties»
337 «generateSetter(property)»
340 «IF augmentType !== null»
341 «val augmentTypeRef = augmentType.importedName»
342 «val jlClassRef = CLASS.importedName»
343 «val hashMapRef = JU_HASHMAP.importedName»
344 public «type.name» add«AUGMENTATION_FIELD_UPPER»(«jlClassRef»<? extends «augmentTypeRef»> augmentationType, «augmentTypeRef» augmentationValue) {
345 if (augmentationValue == null) {
346 return remove«AUGMENTATION_FIELD_UPPER»(augmentationType);
349 if (!(this.«AUGMENTATION_FIELD» instanceof «hashMapRef»)) {
350 this.«AUGMENTATION_FIELD» = new «hashMapRef»<>();
353 this.«AUGMENTATION_FIELD».put(augmentationType, augmentationValue);
357 public «type.name» remove«AUGMENTATION_FIELD_UPPER»(«jlClassRef»<? extends «augmentTypeRef»> augmentationType) {
358 if (this.«AUGMENTATION_FIELD» instanceof «hashMapRef») {
359 this.«AUGMENTATION_FIELD».remove(augmentationType);
366 private def createDescription(GeneratedType targetType) {
367 val target = type.importedName
369 Class that builds {@link «target»} instances. Overall design of the class is that of a
370 <a href="https://en.wikipedia.org/wiki/Fluent_interface">fluent interface</a>, where method chaining is used.
373 In general, this class is supposed to be used like this template:
376 «target» createTarget(int fooXyzzy, int barBaz) {
377 return new «target»Builder()
378 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
379 .setBar(new BarBuilder().setBaz(barBaz).build())
386 This pattern is supported by the immutable nature of «target», as instances can be freely passed around without
387 worrying about synchronization issues.
390 As a side note: method chaining results in:
392 <li>very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
393 on the stack, so further method invocations just need to fill method arguments for the next method
394 invocation, which is terminated by {@link #build()}, which is then returned from the method</li>
395 <li>better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is
397 <li>better optimization oportunities, as the object scope is minimized in terms of invocation (rather than
398 method) stack, making <a href="https://en.wikipedia.org/wiki/Escape_analysis">escape analysis</a> a lot
399 easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely
404 @see «BUILDER.importedName»
408 override protected String formatDataForJavaDoc(GeneratedType type) {
409 val typeDescription = createDescription(type)
412 «IF !typeDescription.nullOrEmpty»
418 private def generateAugmentation() '''
419 @«SUPPRESS_WARNINGS.importedName»({ "unchecked", "checkstyle:methodTypeParameterName"})
420 public <E$$ extends «augmentType.importedName»> E$$ «AUGMENTABLE_AUGMENTATION_NAME»(«CLASS.importedName»<E$$> augmentationType) {
421 return (E$$) «AUGMENTATION_FIELD».get(«CODEHELPERS.importedName».nonNullValue(augmentationType, "augmentationType"));
425 override protected generateCopyKeys(List<GeneratedProperty> keyProps) '''
426 this.key = base.«BindingMapping.IDENTIFIABLE_KEY_NAME»();
427 «FOR field : keyProps»
428 this.«field.fieldName» = base.«field.getterMethodName»();
432 override protected generateCopyAugmentation(Type implType) {
433 val augmentationHolderRef = AugmentationHolder.importedName
434 val typeRef = targetType.importedName
435 val hashMapRef = JU_HASHMAP.importedName
436 val augmentTypeRef = augmentType.importedName
438 if (base instanceof «augmentationHolderRef») {
439 @SuppressWarnings("unchecked")
440 «JU_MAP.importedName»<«CLASS.importedName»<? extends «augmentTypeRef»>, «augmentTypeRef»> aug =((«augmentationHolderRef»<«typeRef»>) base).augmentations();
441 if (!aug.isEmpty()) {
442 this.«AUGMENTATION_FIELD» = new «hashMapRef»<>(aug);
448 private static def hasNonDefaultMethods(GeneratedType type) {
449 !type.methodDefinitions.isEmpty && type.methodDefinitions.exists([def | !def.isDefault])
452 private static def nonDefaultMethods(GeneratedType type) {
453 type.methodDefinitions.filter([def | !def.isDefault])