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 com.google.common.collect.ImmutableSortedSet
11 import java.util.ArrayList
12 import java.util.Arrays
13 import java.util.Collection
14 import java.util.Collections
15 import java.util.HashMap
16 import java.util.HashSet
17 import java.util.LinkedHashSet
20 import java.util.Objects
22 import org.opendaylight.mdsal.binding.generator.util.ReferencedTypeImpl
23 import org.opendaylight.mdsal.binding.generator.util.Types
24 import org.opendaylight.mdsal.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl
25 import org.opendaylight.mdsal.binding.model.api.ConcreteType
26 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty
27 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject
28 import org.opendaylight.mdsal.binding.model.api.GeneratedType
29 import org.opendaylight.mdsal.binding.model.api.MethodSignature
30 import org.opendaylight.mdsal.binding.model.api.Type
31 import org.opendaylight.yangtools.concepts.Builder
32 import org.opendaylight.yangtools.yang.binding.Augmentable
33 import org.opendaylight.yangtools.yang.binding.AugmentationHolder
34 import org.opendaylight.yangtools.yang.binding.DataObject
35 import org.opendaylight.yangtools.yang.binding.Identifiable
38 * Template for generating JAVA builder classes.
41 class BuilderTemplate extends BaseTemplate {
44 * Constant with the name of the concrete method.
46 val static GET_AUGMENTATION_METHOD_NAME = "getAugmentation"
49 * Constant with the suffix for builder classes.
51 val static BUILDER = 'Builder'
54 * Constant with the name of the BuilderFor interface
56 val static BUILDERFOR = Builder.simpleName;
59 * Constant with suffix for the classes which are generated from the builder classes.
61 val static IMPL = 'Impl'
64 * Generated property is set if among methods is found one with the name GET_AUGMENTATION_METHOD_NAME
66 var GeneratedProperty augmentField
69 * Set of class attributes (fields) which are derived from the getter methods names
71 val Set<GeneratedProperty> properties
73 private static val METHOD_COMPARATOR = new AlphabeticallyTypeMemberComparator<MethodSignature>();
76 * Constructs new instance of this class.
77 * @throws IllegalArgumentException if <code>genType</code> equals <code>null</code>
79 new(GeneratedType genType) {
81 this.properties = propertiesFromMethods(createMethods)
82 importMap.put(Builder.simpleName, Builder.package.name)
86 * Returns set of method signature instances which contains all the methods of the <code>genType</code>
87 * and all the methods of the implemented interfaces.
89 * @returns set of method signature instances
91 def private Set<MethodSignature> createMethods() {
92 val Set<MethodSignature> methods = new LinkedHashSet();
93 methods.addAll(type.methodDefinitions)
94 collectImplementedMethods(methods, type.implements)
95 val Set<MethodSignature> sortedMethods = ImmutableSortedSet.orderedBy(METHOD_COMPARATOR).addAll(methods).build()
101 * Adds to the <code>methods</code> set all the methods of the <code>implementedIfcs</code>
102 * and recursively their implemented interfaces.
104 * @param methods set of method signatures
105 * @param implementedIfcs list of implemented interfaces
107 def private void collectImplementedMethods(Set<MethodSignature> methods, List<Type> implementedIfcs) {
108 if (implementedIfcs === null || implementedIfcs.empty) {
111 for (implementedIfc : implementedIfcs) {
112 if ((implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject))) {
113 val ifc = implementedIfc as GeneratedType
114 methods.addAll(ifc.methodDefinitions)
115 collectImplementedMethods(methods, ifc.implements)
116 } else if (implementedIfc.fullyQualifiedName == Augmentable.name) {
117 for (m : Augmentable.methods) {
118 if (m.name == GET_AUGMENTATION_METHOD_NAME) {
119 val fullyQualifiedName = m.returnType.name
120 val pkg = fullyQualifiedName.package
121 val name = fullyQualifiedName.name
122 val tmpGenTO = new GeneratedTOBuilderImpl(pkg, name)
123 val refType = new ReferencedTypeImpl(pkg, name)
124 val generic = new ReferencedTypeImpl(type.packageName, type.name)
125 val parametrizedReturnType = Types.parameterizedTypeFor(refType, generic)
126 tmpGenTO.addMethod(m.name).setReturnType(parametrizedReturnType)
127 augmentField = tmpGenTO.toInstance.methodDefinitions.first.propertyFromGetter
135 * Returns the first element of the list <code>elements</code>.
137 * @param list of elements
139 def private <E> first(List<E> elements) {
144 * Returns the name of the package from <code>fullyQualifiedName</code>.
146 * @param fullyQualifiedName string with fully qualified type name (package + type)
147 * @return string with the package name
149 def private String getPackage(String fullyQualifiedName) {
150 val lastDotIndex = fullyQualifiedName.lastIndexOf(Constants.DOT)
151 return if (lastDotIndex == -1) "" else fullyQualifiedName.substring(0, lastDotIndex)
155 * Returns the name of tye type from <code>fullyQualifiedName</code>
157 * @param fullyQualifiedName string with fully qualified type name (package + type)
158 * @return string with the name of the type
160 def private String getName(String fullyQualifiedName) {
161 val lastDotIndex = fullyQualifiedName.lastIndexOf(Constants.DOT)
162 return if (lastDotIndex == -1) fullyQualifiedName else fullyQualifiedName.substring(lastDotIndex + 1)
166 * Creates set of generated property instances from getter <code>methods</code>.
168 * @param set of method signature instances which should be transformed to list of properties
169 * @return set of generated property instances which represents the getter <code>methods</code>
171 def private propertiesFromMethods(Collection<MethodSignature> methods) {
172 if (methods === null || methods.isEmpty()) {
173 return Collections.emptySet
175 val Set<GeneratedProperty> result = new LinkedHashSet
177 val createdField = m.propertyFromGetter
178 if (createdField !== null) {
179 result.add(createdField)
186 * Creates generated property instance from the getter <code>method</code> name and return type.
188 * @param method method signature from which is the method name and return type obtained
189 * @return generated property instance for the getter <code>method</code>
190 * @throws IllegalArgumentException<ul>
191 * <li>if the <code>method</code> equals <code>null</code></li>
192 * <li>if the name of the <code>method</code> equals <code>null</code></li>
193 * <li>if the name of the <code>method</code> is empty</li>
194 * <li>if the return type of the <code>method</code> equals <code>null</code></li>
197 def private GeneratedProperty propertyFromGetter(MethodSignature method) {
198 if (method === null || method.name === null || method.name.empty || method.returnType === null) {
199 throw new IllegalArgumentException("Method, method name, method return type reference cannot be NULL or empty!")
202 if (Types.BOOLEAN.equals(method.returnType)) {
205 if (method.name.startsWith(prefix)) {
206 val fieldName = method.getName().substring(prefix.length()).toFirstLower
207 val tmpGenTO = new GeneratedTOBuilderImpl("foo", "foo")
208 tmpGenTO.addProperty(fieldName).setReturnType(method.returnType)
209 return tmpGenTO.toInstance.properties.first
214 * Template method which generates JAVA class body for builder class and for IMPL class.
216 * @return string with JAVA source code
219 «wrapToDocumentation(formatDataForJavaDoc(type))»
220 public class «type.name»«BUILDER» implements «BUILDERFOR» <«type.importedName»> {
222 «generateFields(false)»
224 «generateAugmentField(false)»
226 «generateConstructorsFromIfcs(type)»
228 «generateCopyConstructor(false)»
230 «generateMethodFieldsFrom(type)»
232 «generateGetters(false)»
236 public «type.name» build() {
237 return new «type.name»«IMPL»(this);
240 private static final class «type.name»«IMPL» implements «type.name» {
242 «implementedInterfaceGetter»
244 «generateFields(true)»
246 «generateAugmentField(true)»
248 «generateCopyConstructor(true)»
250 «generateGetters(true)»
256 «generateToString(properties)»
263 * Generate default constructor and constructor for every implemented interface from uses statements.
265 def private generateConstructorsFromIfcs(Type type) '''
266 public «type.name»«BUILDER»() {
268 «IF (type instanceof GeneratedType && !(type instanceof GeneratedTransferObject))»
269 «val ifc = type as GeneratedType»
270 «FOR impl : ifc.implements»
271 «generateConstructorFromIfc(impl)»
277 * Generate constructor with argument of given type.
279 def private Object generateConstructorFromIfc(Type impl) '''
280 «IF (impl instanceof GeneratedType)»
281 «IF !(impl.methodDefinitions.empty)»
282 public «type.name»«BUILDER»(«impl.fullyQualifiedName» arg) {
283 «printConstructorPropertySetter(impl)»
286 «FOR implTypeImplement : impl.implements»
287 «generateConstructorFromIfc(implTypeImplement)»
292 def private Object printConstructorPropertySetter(Type implementedIfc) '''
293 «IF (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject))»
294 «val ifc = implementedIfc as GeneratedType»
295 «FOR getter : ifc.methodDefinitions»
296 this._«getter.propertyNameFromGetter» = arg.«getter.name»();
298 «FOR impl : ifc.implements»
299 «printConstructorPropertySetter(impl)»
305 * Generate 'fieldsFrom' method to set builder properties based on type of given argument.
307 def private generateMethodFieldsFrom(Type type) '''
308 «IF (type instanceof GeneratedType && !(type instanceof GeneratedTransferObject))»
309 «val ifc = type as GeneratedType»
310 «IF ifc.hasImplementsFromUses»
311 «val List<Type> done = ifc.getBaseIfcs»
312 «generateMethodFieldsFromComment(ifc)»
313 public void fieldsFrom(«DataObject.importedName» arg) {
314 boolean isValidArg = false;
315 «FOR impl : ifc.getAllIfcs»
316 «generateIfCheck(impl, done)»
319 throw new IllegalArgumentException(
320 "expected one of: «ifc.getAllIfcs.toListOfNames» \n" +
329 def private generateMethodFieldsFromComment(GeneratedType type) '''
331 *Set fields from given grouping argument. Valid argument is instance of one of following types:
333 «FOR impl : type.getAllIfcs»
334 * <li>«impl.fullyQualifiedName»</li>
338 * @param arg grouping object
339 * @throws IllegalArgumentException if given argument is none of valid types
344 * Method is used to find out if given type implements any interface from uses.
346 def boolean hasImplementsFromUses(GeneratedType type) {
348 for (impl : type.getAllIfcs) {
349 if ((impl instanceof GeneratedType) && !((impl as GeneratedType).methodDefinitions.empty)) {
356 def private generateIfCheck(Type impl, List<Type> done) '''
357 «IF (impl instanceof GeneratedType) && !((impl as GeneratedType).methodDefinitions.empty)»
358 «val implType = impl as GeneratedType»
359 if (arg instanceof «implType.fullyQualifiedName») {
360 «printPropertySetter(implType)»
366 def private printPropertySetter(Type implementedIfc) '''
367 «IF (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject))»
368 «val ifc = implementedIfc as GeneratedType»
369 «FOR getter : ifc.methodDefinitions»
370 this._«getter.propertyNameFromGetter» = ((«implementedIfc.fullyQualifiedName»)arg).«getter.name»();
375 private def List<Type> getBaseIfcs(GeneratedType type) {
376 val List<Type> baseIfcs = new ArrayList();
377 for (ifc : type.implements) {
378 if (ifc instanceof GeneratedType && !(ifc as GeneratedType).methodDefinitions.empty) {
385 private def Set<Type> getAllIfcs(Type type) {
386 val Set<Type> baseIfcs = new HashSet()
387 if (type instanceof GeneratedType && !(type instanceof GeneratedTransferObject)) {
388 val ifc = type as GeneratedType
389 for (impl : ifc.implements) {
390 if (impl instanceof GeneratedType && !(impl as GeneratedType).methodDefinitions.empty) {
393 baseIfcs.addAll(impl.getAllIfcs)
399 private def List<String> toListOfNames(Collection<Type> types) {
400 val List<String> names = new ArrayList
402 names.add(type.fullyQualifiedName)
408 * Template method which generates class attributes.
410 * @param boolean value which specify whether field is|isn't final
411 * @return string with class attributes and their types
413 def private generateFields(boolean _final) '''
414 «IF properties !== null»
416 private«IF _final» final«ENDIF» «f.returnType.importedName» «f.fieldName»;
421 def private generateAugmentField(boolean isPrivate) '''
422 «IF augmentField !== null»
423 «IF isPrivate»private «ENDIF»«Map.importedName»<«Class.importedName»<? extends «augmentField.returnType.importedName»>, «augmentField.returnType.importedName»> «augmentField.name» = «Collections.importedName».emptyMap();
428 * Template method which generates setter methods
430 * @return string with the setter methods
432 def private generateSetters() '''
433 «FOR field : properties SEPARATOR '\n'»
434 «/* FIXME: generate checkers as simple blocks and embed them directly in setters */»
435 «val restrictions = field.returnType.restrictions»
436 «IF !(field.returnType instanceof GeneratedType) && restrictions !== null»
437 «IF !restrictions.rangeConstraints.nullOrEmpty»
438 «val rangeGenerator = AbstractRangeGenerator.forType(field.returnType)»
439 «rangeGenerator.generateRangeChecker(field.name.toFirstUpper, restrictions.rangeConstraints)»
442 «IF !restrictions.lengthConstraints.nullOrEmpty»
443 «LengthGenerator.generateLengthChecker(field.fieldName.toString, field.returnType, restrictions.lengthConstraints)»
447 public «type.name»«BUILDER» set«field.name.toFirstUpper»(final «field.returnType.importedName» value) {
448 «IF !(field.returnType instanceof GeneratedType) && restrictions !== null»
449 «IF restrictions !== null && (!restrictions.rangeConstraints.nullOrEmpty || !restrictions.lengthConstraints.nullOrEmpty)»
451 «IF !restrictions.rangeConstraints.nullOrEmpty»
452 «val rangeGenerator = AbstractRangeGenerator.forType(field.returnType)»
453 «IF field.returnType instanceof ConcreteType»
454 «rangeGenerator.generateRangeCheckerCall(field.name.toFirstUpper, "value")»
456 «rangeGenerator.generateRangeCheckerCall(field.name.toFirstUpper, "value.getValue()")»
459 «IF !restrictions.lengthConstraints.nullOrEmpty»
460 «IF field.returnType instanceof ConcreteType»
461 «LengthGenerator.generateLengthCheckerCall(field.fieldName.toString, "value")»
463 «LengthGenerator.generateLengthCheckerCall(field.fieldName.toString, "value.getValue()")»
469 this.«field.fieldName» = value;
473 «IF augmentField !== null»
475 public «type.name»«BUILDER» add«augmentField.name.toFirstUpper»(«Class.importedName»<? extends «augmentField.returnType.importedName»> augmentationType, «augmentField.returnType.importedName» augmentation) {
476 if (augmentation == null) {
477 return remove«augmentField.name.toFirstUpper»(augmentationType);
480 if (!(this.«augmentField.name» instanceof «HashMap.importedName»)) {
481 this.«augmentField.name» = new «HashMap.importedName»<>();
484 this.«augmentField.name».put(augmentationType, augmentation);
488 public «type.name»«BUILDER» remove«augmentField.name.toFirstUpper»(«Class.importedName»<? extends «augmentField.returnType.importedName»> augmentationType) {
489 if (this.«augmentField.name» instanceof «HashMap.importedName») {
490 this.«augmentField.name».remove(augmentationType);
497 def private CharSequence generateCopyConstructor(boolean impl) '''
498 «IF impl»private«ELSE»public«ENDIF» «type.name»«IF impl»«IMPL»«ELSE»«BUILDER»«ENDIF»(«type.name»«IF impl»«BUILDER»«ENDIF» base) {
499 «val allProps = new ArrayList(properties)»
500 «val isList = implementsIfc(type, Types.parameterizedTypeFor(Types.typeForClass(Identifiable), type))»
501 «val keyType = type.getKey»
502 «IF isList && keyType !== null»
503 «val keyProps = new ArrayList((keyType as GeneratedTransferObject).properties)»
504 «Collections.sort(keyProps,
506 return p1.name.compareTo(p2.name)
509 «FOR field : keyProps»
510 «removeProperty(allProps, field.name)»
512 «removeProperty(allProps, "key")»
513 if (base.getKey() == null) {
514 this._key = new «keyType.importedName»(
515 «FOR keyProp : keyProps SEPARATOR ", "»
516 base.«keyProp.getterMethodName»()
519 «FOR field : keyProps»
520 this.«field.fieldName» = base.«field.getterMethodName»();
523 this._key = base.getKey();
524 «FOR field : keyProps»
525 this.«field.fieldName» = _key.«field.getterMethodName»();
529 «FOR field : allProps»
530 this.«field.fieldName» = base.«field.getterMethodName»();
532 «IF augmentField !== null»
534 switch (base.«augmentField.name».size()) {
536 this.«augmentField.name» = «Collections.importedName».emptyMap();
539 final «Map.importedName».Entry<«Class.importedName»<? extends «augmentField.returnType.importedName»>, «augmentField.returnType.importedName»> e = base.«augmentField.name».entrySet().iterator().next();
540 this.«augmentField.name» = «Collections.importedName».<«Class.importedName»<? extends «augmentField.returnType.importedName»>, «augmentField.returnType.importedName»>singletonMap(e.getKey(), e.getValue());
543 this.«augmentField.name» = new «HashMap.importedName»<>(base.«augmentField.name»);
546 if (base instanceof «type.name»«IMPL») {
547 «type.name»«IMPL» impl = («type.name»«IMPL») base;
548 if (!impl.«augmentField.name».isEmpty()) {
549 this.«augmentField.name» = new «HashMap.importedName»<>(impl.«augmentField.name»);
551 } else if (base instanceof «AugmentationHolder.importedName») {
552 @SuppressWarnings("unchecked")
553 «AugmentationHolder.importedName»<«type.importedName»> casted =(«AugmentationHolder.importedName»<«type.importedName»>) base;
554 if (!casted.augmentations().isEmpty()) {
555 this.«augmentField.name» = new «HashMap.importedName»<>(casted.augmentations());
563 private def boolean implementsIfc(GeneratedType type, Type impl) {
564 for (Type ifc : type.implements) {
565 if (ifc.equals(impl)) {
572 private def Type getKey(GeneratedType type) {
573 for (m : type.methodDefinitions) {
574 if ("getKey".equals(m.name)) {
581 private def void removeProperty(Collection<GeneratedProperty> props, String name) {
582 var GeneratedProperty toRemove = null
584 if (p.name.equals(name)) {
588 if (toRemove !== null) {
589 props.remove(toRemove);
594 * Template method which generate getter methods for IMPL class.
596 * @return string with getter methods
598 def private generateGetters(boolean addOverride) '''
599 «IF !properties.empty»
600 «FOR field : properties SEPARATOR '\n'»
601 «IF addOverride»@Override«ENDIF»
605 «IF augmentField !== null»
607 @SuppressWarnings("unchecked")
608 «IF addOverride»@Override«ENDIF»
609 public <E extends «augmentField.returnType.importedName»> E get«augmentField.name.toFirstUpper»(«Class.importedName»<E> augmentationType) {
610 if (augmentationType == null) {
611 throw new IllegalArgumentException("Augmentation Type reference cannot be NULL!");
613 return (E) «augmentField.name».get(augmentationType);
619 * Template method which generates the method <code>hashCode()</code>.
621 * @return string with the <code>hashCode()</code> method definition in JAVA format
623 def protected generateHashCode() '''
624 «IF !properties.empty || augmentField !== null»
625 private int hash = 0;
626 private volatile boolean hashValid = false;
629 public int hashCode() {
634 final int prime = 31;
636 «FOR property : properties»
637 «IF property.returnType.name.contains("[")»
638 result = prime * result + «Arrays.importedName».hashCode(«property.fieldName»);
640 result = prime * result + «Objects.importedName».hashCode(«property.fieldName»);
643 «IF augmentField !== null»
644 result = prime * result + «Objects.importedName».hashCode(«augmentField.name»);
655 * Template method which generates the method <code>equals()</code>.
657 * @return string with the <code>equals()</code> method definition in JAVA format
659 def protected generateEquals() '''
660 «IF !properties.empty || augmentField !== null»
662 public boolean equals(«Object.importedName» obj) {
666 if (!(obj instanceof «DataObject.importedName»)) {
669 if (!«type.importedName».class.equals(((«DataObject.importedName»)obj).getImplementedInterface())) {
672 «type.importedName» other = («type.importedName»)obj;
673 «FOR property : properties»
674 «val fieldName = property.fieldName»
675 «IF property.returnType.name.contains("[")»
676 if (!«Arrays.importedName».equals(«fieldName», other.«property.getterMethodName»())) {
678 if (!«Objects.importedName».equals(«fieldName», other.«property.getterMethodName»())) {
683 «IF augmentField !== null»
684 if (getClass() == obj.getClass()) {
685 // Simple case: we are comparing against self
686 «type.name»«IMPL» otherImpl = («type.name»«IMPL») obj;
687 «val fieldName = augmentField.name»
688 if (!«Objects.importedName».equals(«fieldName», otherImpl.«fieldName»)) {
692 // Hard case: compare our augments with presence there...
693 for («Map.importedName».Entry<«Class.importedName»<? extends «augmentField.returnType.importedName»>, «augmentField.returnType.importedName»> e : «augmentField.name».entrySet()) {
694 if (!e.getValue().equals(other.getAugmentation(e.getKey()))) {
698 // .. and give the other one the chance to do the same
699 if (!obj.equals(this)) {
709 def override generateToString(Collection<GeneratedProperty> properties) '''
710 «IF !(properties === null)»
712 public «String.importedName» toString() {
713 «String.importedName» name = "«type.name» [";
714 «StringBuilder.importedName» builder = new «StringBuilder.importedName» (name);
715 «FOR property : properties SEPARATOR "\n builder.append(\", \");\n}" AFTER " }\n"»
716 if («property.fieldName» != null) {
717 builder.append("«property.fieldName»=");
718 «IF property.returnType.name.contains("[")»
719 builder.append(«Arrays.importedName».toString(«property.fieldName»));
721 builder.append(«property.fieldName»);
724 «IF augmentField !== null»
725 «IF !properties.empty»
726 «««Append comma separator only if it's not there already from previous operation»»»
727 final int builderLength = builder.length();
728 final int builderAdditionalLength = builder.substring(name.length(), builderLength).length();
729 if (builderAdditionalLength > 2 && !builder.substring(builderLength - 2, builderLength).equals(", ")) {
730 builder.append(", ");
733 builder.append("«augmentField.name»=");
734 builder.append(«augmentField.name».values());«"\n"»
735 return builder.append(']').toString();
737 «IF properties.empty»
738 return builder.append(']').toString();
740 return builder.append(']').toString();
747 def implementedInterfaceGetter() '''
748 public «Class.importedName»<«type.importedName»> getImplementedInterface() {
749 return «type.importedName».class;
753 private def createDescription(GeneratedType type) {
755 Class that builds {@link «type.importedName»} instances.
757 @see «type.importedName»
761 override def protected String formatDataForJavaDoc(GeneratedType type) {
762 val typeDescription = createDescription(type)
765 «IF !typeDescription.nullOrEmpty»