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;
25 import com.google.common.base.MoreObjects
27 import java.util.Locale
28 import java.util.Map.Entry
30 import org.gaul.modernizer_maven_annotations.SuppressModernizer
31 import org.opendaylight.mdsal.binding.model.api.AnnotationType
32 import org.opendaylight.mdsal.binding.model.api.Constant
33 import org.opendaylight.mdsal.binding.model.api.Enumeration
34 import org.opendaylight.mdsal.binding.model.api.GeneratedType
35 import org.opendaylight.mdsal.binding.model.api.JavaTypeName
36 import org.opendaylight.mdsal.binding.model.api.MethodSignature
37 import org.opendaylight.mdsal.binding.model.api.ParameterizedType
38 import org.opendaylight.mdsal.binding.model.api.Type
39 import org.opendaylight.mdsal.binding.model.ri.Types
40 import org.opendaylight.mdsal.binding.model.ri.TypeConstants
43 * Template for generating JAVA interfaces.
46 class InterfaceTemplate extends BaseTemplate {
48 * List of constant instances which are generated as JAVA public static final attributes.
50 val List<Constant> consts
53 * List of method signatures which are generated as method declarations.
55 val List<MethodSignature> methods
58 * List of enumeration which are generated as JAVA enum type.
60 val List<Enumeration> enums
63 * List of generated types which are enclosed inside <code>genType</code>
65 val List<GeneratedType> enclosedGeneratedTypes
67 var Entry<Type, Set<BuilderGeneratedProperty>> typeAnalysis
70 * Creates the instance of this class which is used for generating the interface file source
71 * code from <code>genType</code>.
73 * @throws NullPointerException if <code>genType</code> is <code>null</code>
75 new(GeneratedType genType) {
77 consts = genType.constantDefinitions
78 methods = genType.methodDefinitions
79 enums = genType.enumerations
80 enclosedGeneratedTypes = genType.enclosedTypes
84 * Template method which generate the whole body of the interface.
86 * @return string with code for interface body in JAVA format
89 «type.formatDataForJavaDoc.wrapToDocumentation»
90 «type.annotations.generateAnnotations»
92 public interface «type.name»
96 «generateInnerClasses»
108 def private generateAnnotations(List<AnnotationType> annotations) '''
109 «IF annotations !== null && !annotations.empty»
110 «FOR annotation : annotations»
111 «annotation.generateAnnotation»
116 def private generateAccessorAnnotations(MethodSignature method) '''
117 «val annotations = method.annotations»
118 «IF annotations !== null && !annotations.empty»
119 «FOR annotation : annotations»
120 «IF method.returnType != BOOLEAN || !(annotation.identifier == OVERRIDE)»
121 «annotation.generateAnnotation»
128 * Template method which generates the interface name declaration.
130 * @return string with the code for the interface declaration in JAVA format
132 def private superInterfaces()
134 «IF (!type.implements.empty)»
136 «FOR type : type.implements SEPARATOR ","»
143 * Template method which generates inner classes inside this interface.
145 * @return string with the source code for inner classes in JAVA format
147 def private generateInnerClasses() '''
148 «IF !enclosedGeneratedTypes.empty»
149 «FOR innerClass : enclosedGeneratedTypes SEPARATOR "\n"»
150 «generateInnerClass(innerClass)»
156 * Template method which generates JAVA enum type.
158 * @return string with inner enum source code in JAVA format
160 def private generateEnums() '''
162 «FOR e : enums SEPARATOR "\n"»
163 «val enumTemplate = new EnumTemplate(javaType.getEnclosedType(e.identifier), e)»
164 «enumTemplate.generateAsInnerClass»
170 * Template method wich generates JAVA constants.
172 * @return string with constants in JAVA format
174 def private generateConstants() '''
177 «IF !c.name.startsWith(TypeConstants.PATTERN_CONSTANT_NAME)»
185 * Template method which generates the declaration of the methods.
187 * @return string with the declaration of methods source code in JAVA format
189 def private generateMethods() '''
191 «FOR m : methods SEPARATOR "\n"»
193 «generateDefaultMethod(m)»
195 «generateStaticMethod(m)»
196 «ELSEIF m.parameters.empty && m.name.isGetterMethodName»
197 «generateAccessorMethod(m)»
205 def private generateDefaultMethod(MethodSignature method) {
206 if (method.name.isNonnullMethodName) {
207 generateNonnullMethod(method)
208 } else if (method.name.isRequireMethodName) {
209 generateRequireMethod(method)
212 case DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME : generateDefaultImplementedInterface
214 if (VOID == method.returnType.identifier) {
215 generateNoopVoidInterfaceMethod(method)
221 def private generateStaticMethod(MethodSignature method) {
223 case BINDING_EQUALS_NAME : generateBindingEquals
224 case BINDING_HASHCODE_NAME : generateBindingHashCode
225 case BINDING_TO_STRING_NAME : generateBindingToString
230 def private generateMethod(MethodSignature method) '''
231 «method.comment.asJavadoc»
232 «method.annotations.generateAnnotations»
233 «method.returnType.importedName» «method.name»(«method.parameters.generateParameters»);
236 def private generateNoopVoidInterfaceMethod(MethodSignature method) '''
237 «method.comment.asJavadoc»
238 «method.annotations.generateAnnotations»
239 default «VOID.importedName» «method.name»(«method.parameters.generateParameters») {
244 def private accessorJavadoc(MethodSignature method, String orString) {
245 accessorJavadoc(method, orString, null)
248 def private accessorJavadoc(MethodSignature method, String orString, JavaTypeName exception) {
249 val propName = method.propertyNameFromGetter
250 val propReturn = propName + orString
252 return wrapToDocumentation('''
255 «method.comment?.referenceDescription.formatReference»
256 @return {@code «method.returnType.importedName»} «propReturn»
257 «IF exception !== null»
258 @throws «exception.importedName» if «propName» is not present
263 def private generateAccessorMethod(MethodSignature method) {
265 «accessorJavadoc(method, ", or {@code null} if it is not present.")»
266 «method.generateAccessorAnnotations»
267 «method.returnType.nullableType» «method.name»();
271 def private generateDefaultImplementedInterface() '''
272 @«OVERRIDE.importedName»
273 default «CLASS.importedName»<«type.fullyQualifiedName»> «DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME»() {
274 return «type.fullyQualifiedName».class;
279 def generateBindingHashCode() '''
280 «val augmentable = analyzeType»
281 «IF augmentable || !typeAnalysis.value.empty»
283 * Default implementation of {@link «Object.importedName»#hashCode()} contract for this interface.
284 * Implementations of this interface are encouraged to defer to this method to get consistent hashing
285 * results across all implementations.
287 * @param obj Object for which to generate hashCode() result.
288 * @return Hash code value of data modeled by this interface.
289 * @throws «NPE.importedName» if {@code obj} is null
291 static int «BINDING_HASHCODE_NAME»(final «type.fullyQualifiedNonNull» obj) {
292 final int prime = 31;
294 «FOR property : typeAnalysis.value»
295 result = prime * result + «property.importedUtilClass».hashCode(obj.«property.getterMethodName»());
298 for (var augmentation : obj.augmentations().values()) {
299 result += augmentation.hashCode();
307 def private generateBindingEquals() '''
308 «val augmentable = analyzeType»
309 «IF augmentable || !typeAnalysis.value.isEmpty»
311 * Default implementation of {@link «Object.importedName»#equals(«Object.importedName»)} contract for this interface.
312 * Implementations of this interface are encouraged to defer to this method to get consistent equality
313 * results across all implementations.
315 * @param thisObj Object acting as the receiver of equals invocation
316 * @param obj Object acting as argument to equals invocation
317 * @return True if thisObj and obj are considered equal
318 * @throws «NPE.importedName» if {@code thisObj} is null
320 static boolean «BINDING_EQUALS_NAME»(final «type.fullyQualifiedNonNull» thisObj, final «Types.objectType().importedName» obj) {
321 if (thisObj == obj) {
324 final «type.fullyQualifiedName» other = «CODEHELPERS.importedName».checkCast(«type.fullyQualifiedName».class, obj);
328 «FOR property : ByTypeMemberComparator.sort(typeAnalysis.value)»
329 if (!«property.importedUtilClass».equals(thisObj.«property.getterName»(), other.«property.getterName»())) {
333 return «IF augmentable»thisObj.augmentations().equals(other.augmentations())«ELSE»true«ENDIF»;
338 def generateBindingToString() '''
339 «val augmentable = analyzeType»
341 * Default implementation of {@link «Object.importedName»#toString()} contract for this interface.
342 * Implementations of this interface are encouraged to defer to this method to get consistent string
343 * representations across all implementations.
345 * @param obj Object for which to generate toString() result.
346 * @return {@link «STRING.importedName»} value of data modeled by this interface.
347 * @throws «NPE.importedName» if {@code obj} is null
349 static «STRING.importedName» «BINDING_TO_STRING_NAME»(final «type.fullyQualifiedNonNull» obj) {
350 final «MoreObjects.importedName».ToStringHelper helper = «MoreObjects.importedName».toStringHelper("«type.name»");
351 «FOR property : typeAnalysis.value»
352 «CODEHELPERS.importedName».appendValue(helper, "«property.name»", obj.«property.getterName»());
355 «CODEHELPERS.importedName».appendAugmentations(helper, "«AUGMENTATION_FIELD»", obj);
357 return helper.toString();
361 def private generateNonnullMethod(MethodSignature method) '''
362 «val ret = method.returnType»
363 «val name = method.name»
364 «accessorJavadoc(method, ", or an empty list if it is not present.")»
365 «method.annotations.generateAnnotations»
366 default «ret.importedNonNull» «name»() {
367 return «CODEHELPERS.importedName».nonnull(«name.getGetterMethodForNonnull»());
371 def private generateRequireMethod(MethodSignature method) '''
372 «val ret = method.returnType»
373 «val name = method.name»
374 «val fieldName = name.toLowerCase(Locale.ROOT).replace(REQUIRE_PREFIX, "")»
375 «accessorJavadoc(method, ", guaranteed to be non-null.", NSEE)»
376 default «ret.importedNonNull» «name»() {
377 return «CODEHELPERS.importedName».require(«getGetterMethodForRequire(name)»(), "«fieldName»");
381 def private String nullableType(Type type) {
382 if (type.isObject && type instanceof ParameterizedType) {
383 val param = type as ParameterizedType
384 if (Types.isMapType(param) || Types.isListType(param) || Types.isSetType(param)) {
385 return type.importedNullable
388 return type.importedName
391 def private static boolean isObject(Type type) {
392 // The return type has a package, so it's not a primitive type
393 return !type.getPackageName().isEmpty()
396 private def boolean analyzeType() {
397 if (typeAnalysis === null) {
398 typeAnalysis = analyzeTypeHierarchy(type)
400 typeAnalysis.key !== null