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.opendaylight.mdsal.binding.spec.naming.BindingMapping.getGetterMethodForNonnull
11 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getGetterMethodForRequire
12 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.isGetterMethodName
13 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.isNonnullMethodName
14 import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.isRequireMethodName
15 import static org.opendaylight.mdsal.binding.model.ri.Types.BOOLEAN
16 import static org.opendaylight.mdsal.binding.model.ri.Types.STRING
17 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.REQUIRE_PREFIX
18 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTATION_FIELD
19 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_EQUALS_NAME
20 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_HASHCODE_NAME
21 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_TO_STRING_NAME
22 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME
24 import com.google.common.annotations.VisibleForTesting;
26 import java.util.Locale
27 import java.util.Map.Entry
29 import org.gaul.modernizer_maven_annotations.SuppressModernizer
30 import org.opendaylight.mdsal.binding.model.api.AnnotationType
31 import org.opendaylight.mdsal.binding.model.api.Constant
32 import org.opendaylight.mdsal.binding.model.api.Enumeration
33 import org.opendaylight.mdsal.binding.model.api.GeneratedType
34 import org.opendaylight.mdsal.binding.model.api.JavaTypeName
35 import org.opendaylight.mdsal.binding.model.api.MethodSignature
36 import org.opendaylight.mdsal.binding.model.api.ParameterizedType
37 import org.opendaylight.mdsal.binding.model.api.Type
38 import org.opendaylight.mdsal.binding.model.ri.Types
39 import org.opendaylight.mdsal.binding.model.ri.TypeConstants
42 * Template for generating JAVA interfaces.
45 class InterfaceTemplate extends BaseTemplate {
47 * List of constant instances which are generated as JAVA public static final attributes.
49 val List<Constant> consts
52 * List of method signatures which are generated as method declarations.
54 val List<MethodSignature> methods
57 * List of enumeration which are generated as JAVA enum type.
59 val List<Enumeration> enums
62 * List of generated types which are enclosed inside <code>genType</code>
64 val List<GeneratedType> enclosedGeneratedTypes
66 var Entry<Type, Set<BuilderGeneratedProperty>> typeAnalysis
69 * Creates the instance of this class which is used for generating the interface file source
70 * code from <code>genType</code>.
72 * @throws NullPointerException if <code>genType</code> is <code>null</code>
74 new(GeneratedType genType) {
76 consts = genType.constantDefinitions
77 methods = genType.methodDefinitions
78 enums = genType.enumerations
79 enclosedGeneratedTypes = genType.enclosedTypes
83 * Template method which generate the whole body of the interface.
85 * @return string with code for interface body in JAVA format
88 «type.formatDataForJavaDoc.wrapToDocumentation»
89 «type.annotations.generateAnnotations»
91 public interface «type.name»
95 «generateInnerClasses»
107 def private generateAnnotations(List<AnnotationType> annotations) '''
108 «IF annotations !== null && !annotations.empty»
109 «FOR annotation : annotations»
110 «annotation.generateAnnotation»
115 def private generateAccessorAnnotations(MethodSignature method) '''
116 «val annotations = method.annotations»
117 «IF annotations !== null && !annotations.empty»
118 «FOR annotation : annotations»
119 «IF method.returnType != BOOLEAN || !(annotation.identifier == OVERRIDE)»
120 «annotation.generateAnnotation»
127 * Template method which generates the interface name declaration.
129 * @return string with the code for the interface declaration in JAVA format
131 def private superInterfaces()
133 «IF (!type.implements.empty)»
135 «FOR type : type.implements SEPARATOR ","»
142 * Template method which generates inner classes inside this interface.
144 * @return string with the source code for inner classes in JAVA format
146 def private generateInnerClasses() '''
147 «IF !enclosedGeneratedTypes.empty»
148 «FOR innerClass : enclosedGeneratedTypes SEPARATOR "\n"»
149 «generateInnerClass(innerClass)»
155 * Template method which generates JAVA enum type.
157 * @return string with inner enum source code in JAVA format
159 def private generateEnums() '''
161 «FOR e : enums SEPARATOR "\n"»
162 «val enumTemplate = new EnumTemplate(javaType.getEnclosedType(e.identifier), e)»
163 «enumTemplate.generateAsInnerClass»
169 * Template method which generates JAVA constants.
171 * @return string with constants in JAVA format
173 def private generateConstants() '''
176 «IF !c.name.startsWith(TypeConstants.PATTERN_CONSTANT_NAME)»
184 * Template method which generates the declaration of the methods.
186 * @return string with the declaration of methods source code in JAVA format
188 def private generateMethods() '''
190 «FOR m : methods SEPARATOR "\n"»
192 «generateDefaultMethod(m)»
194 «generateStaticMethod(m)»
195 «ELSEIF m.parameters.empty && m.name.isGetterMethodName»
196 «generateAccessorMethod(m)»
204 def private generateDefaultMethod(MethodSignature method) {
205 if (method.name.isNonnullMethodName) {
206 generateNonnullMethod(method)
207 } else if (method.name.isRequireMethodName) {
208 generateRequireMethod(method)
211 case DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME : generateDefaultImplementedInterface
213 if (VOID == method.returnType.identifier) {
214 generateNoopVoidInterfaceMethod(method)
220 def private generateStaticMethod(MethodSignature method) {
222 case BINDING_EQUALS_NAME : generateBindingEquals
223 case BINDING_HASHCODE_NAME : generateBindingHashCode
224 case BINDING_TO_STRING_NAME : generateBindingToString
229 def private generateMethod(MethodSignature method) '''
230 «method.comment.asJavadoc»
231 «method.annotations.generateAnnotations»
232 «method.returnType.importedName» «method.name»(«method.parameters.generateParameters»);
235 def private generateNoopVoidInterfaceMethod(MethodSignature method) '''
236 «method.comment.asJavadoc»
237 «method.annotations.generateAnnotations»
238 default «VOID.importedName» «method.name»(«method.parameters.generateParameters») {
243 def private accessorJavadoc(MethodSignature method, String orString) {
244 accessorJavadoc(method, orString, null)
247 def private accessorJavadoc(MethodSignature method, String orString, JavaTypeName exception) {
248 val propName = method.propertyNameFromGetter
249 val propReturn = propName + orString
251 return wrapToDocumentation('''
254 «method.comment?.referenceDescription.formatReference»
255 @return {@code «method.returnType.importedName»} «propReturn»
256 «IF exception !== null»
257 @throws «exception.importedName» if «propName» is not present
262 def private generateAccessorMethod(MethodSignature method) {
264 «accessorJavadoc(method, ", or {@code null} if it is not present.")»
265 «method.generateAccessorAnnotations»
266 «method.returnType.nullableType» «method.name»();
270 def private generateDefaultImplementedInterface() '''
271 @«OVERRIDE.importedName»
272 default «CLASS.importedName»<«type.fullyQualifiedName»> «DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME»() {
273 return «type.fullyQualifiedName».class;
278 def generateBindingHashCode() '''
279 «val augmentable = analyzeType»
280 «IF augmentable || !typeAnalysis.value.empty»
282 * Default implementation of {@link «Object.importedName»#hashCode()} contract for this interface.
283 * Implementations of this interface are encouraged to defer to this method to get consistent hashing
284 * results across all implementations.
286 * @param obj Object for which to generate hashCode() result.
287 * @return Hash code value of data modeled by this interface.
288 * @throws «NPE.importedName» if {@code obj} is null
290 static int «BINDING_HASHCODE_NAME»(final «type.fullyQualifiedNonNull» obj) {
291 final int prime = 31;
293 «FOR property : typeAnalysis.value»
294 result = prime * result + «property.importedUtilClass».hashCode(obj.«property.getterMethodName»());
297 for (var augmentation : obj.augmentations().values()) {
298 result += augmentation.hashCode();
306 def private generateBindingEquals() '''
307 «val augmentable = analyzeType»
308 «IF augmentable || !typeAnalysis.value.isEmpty»
310 * Default implementation of {@link «Object.importedName»#equals(«Object.importedName»)} contract for this interface.
311 * Implementations of this interface are encouraged to defer to this method to get consistent equality
312 * results across all implementations.
314 * @param thisObj Object acting as the receiver of equals invocation
315 * @param obj Object acting as argument to equals invocation
316 * @return True if thisObj and obj are considered equal
317 * @throws «NPE.importedName» if {@code thisObj} is null
319 static boolean «BINDING_EQUALS_NAME»(final «type.fullyQualifiedNonNull» thisObj, final «Types.objectType().importedName» obj) {
320 if (thisObj == obj) {
323 final «type.fullyQualifiedName» other = «CODEHELPERS.importedName».checkCast(«type.fullyQualifiedName».class, obj);
327 «FOR property : ByTypeMemberComparator.sort(typeAnalysis.value)»
328 if (!«property.importedUtilClass».equals(thisObj.«property.getterName»(), other.«property.getterName»())) {
332 return «IF augmentable»thisObj.augmentations().equals(other.augmentations())«ELSE»true«ENDIF»;
337 def generateBindingToString() '''
338 «val augmentable = analyzeType»
340 * Default implementation of {@link «Object.importedName»#toString()} contract for this interface.
341 * Implementations of this interface are encouraged to defer to this method to get consistent string
342 * representations across all implementations.
344 * @param obj Object for which to generate toString() result.
345 * @return {@link «STRING.importedName»} value of data modeled by this interface.
346 * @throws «NPE.importedName» if {@code obj} is null
348 static «STRING.importedName» «BINDING_TO_STRING_NAME»(final «type.fullyQualifiedNonNull» obj) {
349 final var helper = «MOREOBJECTS.importedName».toStringHelper("«type.name»");
350 «FOR property : typeAnalysis.value»
351 «CODEHELPERS.importedName».appendValue(helper, "«property.name»", obj.«property.getterName»());
354 «CODEHELPERS.importedName».appendAugmentations(helper, "«AUGMENTATION_FIELD»", obj);
356 return helper.toString();
360 def private generateNonnullMethod(MethodSignature method) '''
361 «val ret = method.returnType»
362 «val name = method.name»
363 «accessorJavadoc(method, ", or an empty list if it is not present.")»
364 «method.annotations.generateAnnotations»
365 default «ret.importedNonNull» «name»() {
366 return «CODEHELPERS.importedName».nonnull(«name.getGetterMethodForNonnull»());
370 def private generateRequireMethod(MethodSignature method) '''
371 «val ret = method.returnType»
372 «val name = method.name»
373 «val fieldName = name.toLowerCase(Locale.ROOT).replace(REQUIRE_PREFIX, "")»
374 «accessorJavadoc(method, ", guaranteed to be non-null.", NSEE)»
375 default «ret.importedNonNull» «name»() {
376 return «CODEHELPERS.importedName».require(«getGetterMethodForRequire(name)»(), "«fieldName»");
380 def private String nullableType(Type type) {
381 if (type.isObject && type instanceof ParameterizedType) {
382 val param = type as ParameterizedType
383 if (Types.isMapType(param) || Types.isListType(param) || Types.isSetType(param)) {
384 return type.importedNullable
387 return type.importedName
390 def private static boolean isObject(Type type) {
391 // The return type has a package, so it's not a primitive type
392 return !type.getPackageName().isEmpty()
395 private def boolean analyzeType() {
396 if (typeAnalysis === null) {
397 typeAnalysis = analyzeTypeHierarchy(type)
399 typeAnalysis.key !== null