package org.opendaylight.mdsal.binding.java.api.generator
import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getGetterMethodForNonnull
+import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.getGetterMethodForRequire
import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.isGetterMethodName
import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.isNonnullMethodName
-import static org.opendaylight.mdsal.binding.model.util.Types.STRING;
+import static extension org.opendaylight.mdsal.binding.spec.naming.BindingMapping.isRequireMethodName
+import static org.opendaylight.mdsal.binding.model.ri.Types.BOOLEAN
+import static org.opendaylight.mdsal.binding.model.ri.Types.STRING
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.REQUIRE_PREFIX
import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTATION_FIELD
+import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_CONTRACT_IMPLEMENTED_INTERFACE_NAME
import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_EQUALS_NAME
import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_HASHCODE_NAME
import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.BINDING_TO_STRING_NAME
-import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME
import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.MoreObjects
import java.util.List
+import java.util.Locale
import java.util.Map.Entry
import java.util.Set
import org.gaul.modernizer_maven_annotations.SuppressModernizer
import org.opendaylight.mdsal.binding.model.api.Constant
import org.opendaylight.mdsal.binding.model.api.Enumeration
import org.opendaylight.mdsal.binding.model.api.GeneratedType
+import org.opendaylight.mdsal.binding.model.api.JavaTypeName
import org.opendaylight.mdsal.binding.model.api.MethodSignature
+import org.opendaylight.mdsal.binding.model.api.ParameterizedType
import org.opendaylight.mdsal.binding.model.api.Type
-import org.opendaylight.mdsal.binding.model.util.Types
-import org.opendaylight.mdsal.binding.model.util.TypeConstants
+import org.opendaylight.mdsal.binding.model.ri.Types
+import org.opendaylight.mdsal.binding.model.ri.TypeConstants
/**
* Template for generating JAVA interfaces.
* @return string with code for interface body in JAVA format
*/
override body() '''
- «wrapToDocumentation(formatDataForJavaDoc(type))»
+ «type.formatDataForJavaDoc.wrapToDocumentation»
«type.annotations.generateAnnotations»
+ «generatedAnnotation»
public interface «type.name»
«superInterfaces»
{
«ENDIF»
'''
+ def private generateAccessorAnnotations(MethodSignature method) '''
+ «val annotations = method.annotations»
+ «IF annotations !== null && !annotations.empty»
+ «FOR annotation : annotations»
+ «IF method.returnType != BOOLEAN || !(annotation.identifier == OVERRIDE)»
+ «annotation.generateAnnotation»
+ «ENDIF»
+ «ENDFOR»
+ «ENDIF»
+ '''
+
/**
* Template method which generates the interface name declaration.
*
'''
/**
- * Template method wich generates JAVA constants.
+ * Template method which generates JAVA constants.
*
* @return string with constants in JAVA format
*/
def private generateDefaultMethod(MethodSignature method) {
if (method.name.isNonnullMethodName) {
generateNonnullMethod(method)
+ } else if (method.name.isRequireMethodName) {
+ generateRequireMethod(method)
} else {
switch method.name {
- case DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME : generateDefaultImplementedInterface
+ case BINDING_CONTRACT_IMPLEMENTED_INTERFACE_NAME : generateDefaultImplementedInterface
+ default :
+ if (VOID == method.returnType.identifier) {
+ generateNoopVoidInterfaceMethod(method)
+ }
}
}
}
case BINDING_EQUALS_NAME : generateBindingEquals
case BINDING_HASHCODE_NAME : generateBindingHashCode
case BINDING_TO_STRING_NAME : generateBindingToString
+ default : ""
}
}
«method.returnType.importedName» «method.name»(«method.parameters.generateParameters»);
'''
- def private generateAccessorMethod(MethodSignature method) '''
- «val ret = method.returnType»
- «formatDataForJavaDoc(method, "@return " + asCode(ret.fullyQualifiedName) + " " + asCode(propertyNameFromGetter(method)) + ", or " + asCode("null") + " if not present")»
+ def private generateNoopVoidInterfaceMethod(MethodSignature method) '''
+ «method.comment.asJavadoc»
«method.annotations.generateAnnotations»
- «nullableType(ret)» «method.name»();
+ default «VOID.importedName» «method.name»(«method.parameters.generateParameters») {
+ // No-op
+ }
'''
+ def private accessorJavadoc(MethodSignature method, String orString) {
+ accessorJavadoc(method, orString, null)
+ }
+
+ def private accessorJavadoc(MethodSignature method, String orString, JavaTypeName exception) {
+ val propName = method.propertyNameFromGetter
+ val propReturn = propName + orString
+
+ return wrapToDocumentation('''
+ Return «propReturn»
+
+ «method.comment?.referenceDescription.formatReference»
+ @return {@code «method.returnType.importedName»} «propReturn»
+ «IF exception !== null»
+ @throws «exception.importedName» if «propName» is not present
+ «ENDIF»
+ ''')
+ }
+
+ def private generateAccessorMethod(MethodSignature method) {
+ return '''
+ «accessorJavadoc(method, ", or {@code null} if it is not present.")»
+ «method.generateAccessorAnnotations»
+ «method.returnType.nullableType» «method.name»();
+ '''
+ }
+
def private generateDefaultImplementedInterface() '''
@«OVERRIDE.importedName»
- default «CLASS.importedName»<«type.fullyQualifiedName»> «DATA_CONTAINER_IMPLEMENTED_INTERFACE_NAME»() {
+ default «CLASS.importedName»<«type.fullyQualifiedName»> «BINDING_CONTRACT_IMPLEMENTED_INTERFACE_NAME»() {
return «type.fullyQualifiedName».class;
}
'''
@VisibleForTesting
def generateBindingHashCode() '''
«val augmentable = analyzeType»
- /**
- * Default implementation of {@link «Object.importedName»#hashCode()} contract for this interface.
- * Implementations of this interface are encouraged to defer to this method to get consistent hashing
- * results across all implementations.
- *
- «IF augmentable»
- * @param <T$$> implementation type, which has to also implement «AUGMENTATION_HOLDER.importedName» interface
- * contract.
- «ENDIF»
- * @param obj Object for which to generate hashCode() result.
- * @return Hash code value of data modeled by this interface.
- * @throws «NPE.importedName» if {@code obj} is null
- */
- «IF augmentable»
- static <T$$ extends «type.fullyQualifiedName» & «AUGMENTATION_HOLDER.importedName»<?>> int «BINDING_HASHCODE_NAME»(final @«NONNULL.importedName» T$$ obj) {
- «ELSE»
- static int «BINDING_HASHCODE_NAME»(final «type.fullyQualifiedName» obj) {
+ «IF augmentable || !typeAnalysis.value.empty»
+ /**
+ * Default implementation of {@link «Object.importedName»#hashCode()} contract for this interface.
+ * Implementations of this interface are encouraged to defer to this method to get consistent hashing
+ * results across all implementations.
+ *
+ * @param obj Object for which to generate hashCode() result.
+ * @return Hash code value of data modeled by this interface.
+ * @throws «NPE.importedName» if {@code obj} is null
+ */
+ static int «BINDING_HASHCODE_NAME»(final «type.fullyQualifiedNonNull» obj) {
+ final int prime = 31;
+ int result = 1;
+ «FOR property : typeAnalysis.value»
+ result = prime * result + «property.importedUtilClass».hashCode(obj.«property.getterMethodName»());
+ «ENDFOR»
+ «IF augmentable»
+ for (var augmentation : obj.augmentations().values()) {
+ result += augmentation.hashCode();
+ }
+ «ENDIF»
+ return result;
+ }
«ENDIF»
- final int prime = 31;
- int result = 1;
- «FOR property : typeAnalysis.value»
- result = prime * result + «property.importedUtilClass».hashCode(obj.«property.getterMethodName»());
- «ENDFOR»
- «IF augmentable»
- result = prime * result + «CODEHELPERS.importedName».hashAugmentations(obj);
- «ENDIF»
- return result;
- }
'''
def private generateBindingEquals() '''
* Implementations of this interface are encouraged to defer to this method to get consistent equality
* results across all implementations.
*
- «IF augmentable»
- * @param <T$$> implementation type, which has to also implement «AUGMENTATION_HOLDER.importedName» interface
- * contract.
- «ENDIF»
* @param thisObj Object acting as the receiver of equals invocation
* @param obj Object acting as argument to equals invocation
* @return True if thisObj and obj are considered equal
* @throws «NPE.importedName» if {@code thisObj} is null
*/
- «IF augmentable»
- static <T$$ extends «type.fullyQualifiedName» & «AUGMENTATION_HOLDER.importedName»<«type.fullyQualifiedName»>> boolean «BINDING_EQUALS_NAME»(final @«NONNULL.importedName» T$$ thisObj, final «Types.objectType().importedName» obj) {
- «ELSE»
- static boolean «BINDING_EQUALS_NAME»(final «type.fullyQualifiedName» thisObj, final «Types.objectType().importedName» obj) {
- «ENDIF»
+ static boolean «BINDING_EQUALS_NAME»(final «type.fullyQualifiedNonNull» thisObj, final «Types.objectType().importedName» obj) {
if (thisObj == obj) {
return true;
}
return false;
}
«ENDFOR»
- return «IF augmentable»«CODEHELPERS.importedName».equalsAugmentations(thisObj, other)«ELSE»true«ENDIF»;
+ return «IF augmentable»thisObj.augmentations().equals(other.augmentations())«ELSE»true«ENDIF»;
}
«ENDIF»
'''
* Implementations of this interface are encouraged to defer to this method to get consistent string
* representations across all implementations.
*
- «IF augmentable»
- * @param <T$$> implementation type, which has to also implement «AUGMENTATION_HOLDER.importedName» interface
- * contract.
- «ENDIF»
* @param obj Object for which to generate toString() result.
* @return {@link «STRING.importedName»} value of data modeled by this interface.
* @throws «NPE.importedName» if {@code obj} is null
*/
- «IF augmentable»
- static <T$$ extends «type.fullyQualifiedName» & «AUGMENTATION_HOLDER.importedName»<«type.fullyQualifiedName»>> «STRING.importedName» «BINDING_TO_STRING_NAME»(final @«NONNULL.importedName» T$$ obj) {
- «ELSE»
- static «STRING.importedName» «BINDING_TO_STRING_NAME»(final «type.fullyQualifiedName» obj) {
- «ENDIF»
- final «MoreObjects.importedName».ToStringHelper helper = «MoreObjects.importedName».toStringHelper("«type.name»");
+ static «STRING.importedName» «BINDING_TO_STRING_NAME»(final «type.fullyQualifiedNonNull» obj) {
+ final var helper = «MOREOBJECTS.importedName».toStringHelper("«type.name»");
«FOR property : typeAnalysis.value»
«CODEHELPERS.importedName».appendValue(helper, "«property.name»", obj.«property.getterName»());
«ENDFOR»
«IF augmentable»
- «CODEHELPERS.importedName».appendValue(helper, "«AUGMENTATION_FIELD»", obj.augmentations().values());
+ «CODEHELPERS.importedName».appendAugmentations(helper, "«AUGMENTATION_FIELD»", obj);
«ENDIF»
return helper.toString();
}
def private generateNonnullMethod(MethodSignature method) '''
«val ret = method.returnType»
«val name = method.name»
- «formatDataForJavaDoc(method, "@return " + asCode(ret.fullyQualifiedName) + " " + asCode(propertyNameFromGetter(method)) + ", or an empty list if it is not present")»
+ «accessorJavadoc(method, ", or an empty list if it is not present.")»
«method.annotations.generateAnnotations»
default «ret.importedNonNull» «name»() {
return «CODEHELPERS.importedName».nonnull(«name.getGetterMethodForNonnull»());
}
'''
+ def private generateRequireMethod(MethodSignature method) '''
+ «val ret = method.returnType»
+ «val name = method.name»
+ «val fieldName = name.toLowerCase(Locale.ROOT).replace(REQUIRE_PREFIX, "")»
+ «accessorJavadoc(method, ", guaranteed to be non-null.", NSEE)»
+ default «ret.importedNonNull» «name»() {
+ return «CODEHELPERS.importedName».require(«getGetterMethodForRequire(name)»(), "«fieldName»");
+ }
+ '''
+
def private String nullableType(Type type) {
- if (type.isObject) {
- return type.importedNullable
+ if (type.isObject && type instanceof ParameterizedType) {
+ val param = type as ParameterizedType
+ if (Types.isMapType(param) || Types.isListType(param) || Types.isSetType(param)) {
+ return type.importedNullable
+ }
}
return type.importedName
}
Code Review / mdsal.git / blobdiff