X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fmdsal-binding-java-api-generator%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fbinding%2Fjava%2Fapi%2Fgenerator%2FClassTemplate.xtend;h=8eee22e21131e1401c62fb642149494364ec9922;hb=595d664323462924539cecefde9e54aeefdc98c9;hp=0f5620597994d7326b60f0ab86745aa4ba79f596;hpb=31b91156fd136caba03abb1f7cc934b732ec9443;p=yangtools.git diff --git a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/ClassTemplate.xtend b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/ClassTemplate.xtend index 0f56205979..8eee22e211 100644 --- a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/ClassTemplate.xtend +++ b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/ClassTemplate.xtend @@ -8,23 +8,37 @@ package org.opendaylight.mdsal.binding.java.api.generator import static java.util.Objects.requireNonNull -import static org.opendaylight.mdsal.binding.model.util.Types.BOOLEAN; -import static org.opendaylight.mdsal.binding.model.util.Types.BYTE_ARRAY; -import static org.opendaylight.mdsal.binding.model.util.Types.STRING; +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.BINARY_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.BOOLEAN_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.DECIMAL64_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.EMPTY_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.INSTANCE_IDENTIFIER +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.INT16_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.INT32_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.INT64_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.INT8_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.STRING_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.UINT16_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.UINT32_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.UINT64_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BaseYangTypes.UINT8_TYPE +import static org.opendaylight.mdsal.binding.model.ri.BindingTypes.SCALAR_TYPE_OBJECT +import static org.opendaylight.mdsal.binding.model.ri.Types.STRING; import static extension org.apache.commons.text.StringEscapeUtils.escapeJava +import static extension org.opendaylight.mdsal.binding.model.ri.BindingTypes.isBitsType import com.google.common.base.Preconditions import com.google.common.collect.ImmutableList import com.google.common.collect.Lists import edu.umd.cs.findbugs.annotations.SuppressFBWarnings -import java.beans.ConstructorProperties import java.util.ArrayList import java.util.Base64; +import java.util.Collection import java.util.Comparator import java.util.List import java.util.Map +import java.util.Set import javax.management.ConstructorParameters -import org.gaul.modernizer_maven_annotations.SuppressModernizer import org.opendaylight.mdsal.binding.model.api.ConcreteType import org.opendaylight.mdsal.binding.model.api.Constant import org.opendaylight.mdsal.binding.model.api.Enumeration @@ -32,20 +46,26 @@ import org.opendaylight.mdsal.binding.model.api.GeneratedProperty import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject import org.opendaylight.mdsal.binding.model.api.Restrictions import org.opendaylight.mdsal.binding.model.api.Type -import org.opendaylight.mdsal.binding.model.util.TypeConstants +import org.opendaylight.mdsal.binding.model.ri.TypeConstants +import org.opendaylight.mdsal.binding.spec.naming.BindingMapping import org.opendaylight.yangtools.yang.common.Empty -import org.opendaylight.yangtools.yang.common.Uint16 -import org.opendaylight.yangtools.yang.common.Uint32 -import org.opendaylight.yangtools.yang.common.Uint64 -import org.opendaylight.yangtools.yang.common.Uint8 -import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition /** * Template for generating JAVA class. */ -@SuppressModernizer class ClassTemplate extends BaseTemplate { static val Comparator PROP_COMPARATOR = Comparator.comparing([prop | prop.name]) + static val VALUEOF_TYPES = Set.of( + BOOLEAN_TYPE, + DECIMAL64_TYPE, + INT8_TYPE, + INT16_TYPE, + INT32_TYPE, + INT64_TYPE, + UINT8_TYPE, + UINT16_TYPE, + UINT32_TYPE, + UINT64_TYPE) protected val List properties protected val List finalProperties @@ -125,8 +145,11 @@ class ClassTemplate extends BaseTemplate { * @return string with class source code in JAVA format */ def protected generateBody(boolean isInnerClass) ''' - «wrapToDocumentation(formatDataForJavaDoc(type))» + «type.formatDataForJavaDoc.wrapToDocumentation» «annotationDeclaration» + «IF !isInnerClass» + «generatedAnnotation» + «ENDIF» «generateClassDeclaration(isInnerClass)» { «suidDeclaration» «innerClassesDeclarations» @@ -148,14 +171,9 @@ class ClassTemplate extends BaseTemplate { «defaultInstance» - «FOR field : properties SEPARATOR "\n"» - «field.getterMethod» - «IF !field.readOnly» - «field.setterMethod» - «ENDIF» - «ENDFOR» + «propertyMethods» - «IF (genTO.isTypedef() && genTO.getBaseType instanceof BitsTypeDefinition)» + «IF genTO.isBitsType» «generateGetValueForBitsTypeDef» «ENDIF» @@ -168,6 +186,38 @@ class ClassTemplate extends BaseTemplate { ''' + def protected propertyMethods() { + if (properties.empty) { + return "" + } + isScalarTypeObject ? scalarTypeObjectValue(properties.get(0)) : defaultProperties + } + + def private isScalarTypeObject() { + for (impl : genTO.implements) { + if (SCALAR_TYPE_OBJECT.identifier.equals(impl.identifier)) { + return true + } + } + return false + } + + def private defaultProperties() ''' + «FOR field : properties SEPARATOR "\n"» + «field.getterMethod» + «IF !field.readOnly» + «field.setterMethod» + «ENDIF» + «ENDFOR» + ''' + + def private scalarTypeObjectValue(GeneratedProperty field) ''' + @«OVERRIDE.importedName» + public «field.returnType.importedName» «BindingMapping.SCALAR_TYPE_OBJECT_GET_VALUE_NAME»() { + return «field.fieldName»«field.cloneCall»; + } + ''' + /** * Template method which generates the method getValue() for typedef, * which base type is BitsDefinition. @@ -215,9 +265,9 @@ class ClassTemplate extends BaseTemplate { «ENDIF» ''' - def private allValuesConstructor() ''' + def allValuesConstructor() ''' public «type.name»(«allProperties.asArgumentsDeclaration») { - «IF false == parentProperties.empty» + «IF !parentProperties.empty» super(«parentProperties.asArguments»); «ENDIF» «FOR p : allProperties» @@ -237,9 +287,8 @@ class ClassTemplate extends BaseTemplate { def private typedefConstructor() ''' @«ConstructorParameters.importedName»("«TypeConstants.VALUE_PROP»") - @«ConstructorProperties.importedName»("«TypeConstants.VALUE_PROP»") public «type.name»(«allProperties.asArgumentsDeclaration») { - «IF false == parentProperties.empty» + «IF !parentProperties.empty» super(«parentProperties.asArguments»); «ENDIF» «FOR p : allProperties» @@ -254,11 +303,7 @@ class ClassTemplate extends BaseTemplate { «FOR p : properties» «val fieldName = p.fieldName» - «IF p.returnType.name.endsWith("[]")» - this.«fieldName» = «fieldName».clone(); - «ELSE» - this.«fieldName» = «fieldName»; - «ENDIF» + this.«fieldName» = «fieldName»«p.cloneCall»; «ENDFOR» } ''' @@ -274,7 +319,7 @@ class ClassTemplate extends BaseTemplate { def protected genConstructor(GeneratedProperty property, Iterable other) ''' public «type.name»(«property.returnType.importedName + " " + property.name») { - «IF false == parentProperties.empty» + «IF !parentProperties.empty» super(«parentProperties.asArguments»); «ENDIF» @@ -290,7 +335,7 @@ class ClassTemplate extends BaseTemplate { def private genPatternEnforcer(String ref) ''' «FOR c : consts» - «IF c.name == TypeConstants.PATTERN_CONSTANT_NAME» + «IF TypeConstants.PATTERN_CONSTANT_NAME.equals(c.name)» «CODEHELPERS.importedName».checkPattern(«ref», «Constants.MEMBER_PATTERN_LIST», «Constants.MEMBER_REGEX_LIST»); «ENDIF» «ENDFOR» @@ -304,7 +349,7 @@ class ClassTemplate extends BaseTemplate { } } - def private generateRestrictions(Type type, String paramName, Type returnType) ''' + def generateRestrictions(Type type, String paramName, Type returnType) ''' «val restrictions = type.restrictions» «IF restrictions !== null» «IF restrictions.lengthConstraint.present || restrictions.rangeConstraint.present» @@ -327,7 +372,7 @@ class ClassTemplate extends BaseTemplate { * @param source Source object */ public «type.name»(«type.name» source) { - «IF false == parentProperties.empty» + «IF !parentProperties.empty» super(source); «ENDIF» «FOR p : properties» @@ -352,37 +397,22 @@ class ClassTemplate extends BaseTemplate { def protected defaultInstance() ''' «IF genTO.typedef && !allProperties.empty && !genTO.unionType» «val prop = allProperties.get(0)» - «IF !("org.opendaylight.yangtools.yang.binding.InstanceIdentifier".equals(prop.returnType.fullyQualifiedName))» - public static «genTO.name» getDefaultInstance(String defaultValue) { - «IF BYTE_ARRAY.equals(prop.returnType)» - return new «genTO.name»(«Base64.importedName».getDecoder().decode(defaultValue)); - «ELSEIF STRING.equals(prop.returnType)» + «val propType = prop.returnType» + «IF !(INSTANCE_IDENTIFIER.identifier.equals(propType.identifier))» + public static «genTO.name» getDefaultInstance(final String defaultValue) { + «IF allProperties.size > 1» + «bitsArgs» + «ELSEIF VALUEOF_TYPES.contains(propType)» + return new «genTO.name»(«propType.importedName».valueOf(defaultValue)); + «ELSEIF STRING_TYPE.equals(propType)» return new «genTO.name»(defaultValue); - «ELSEIF Constants.EMPTY.equals(prop.returnType)» + «ELSEIF BINARY_TYPE.equals(propType)» + return new «genTO.name»(«Base64.importedName».getDecoder().decode(defaultValue)); + «ELSEIF EMPTY_TYPE.equals(propType)» «Preconditions.importedName».checkArgument(defaultValue.isEmpty(), "Invalid value %s", defaultValue); - return new «genTO.name»(«Empty.importedName».getInstance()); - «ELSEIF allProperties.size > 1» - «bitsArgs» - «ELSEIF BOOLEAN.equals(prop.returnType)» - return new «genTO.name»(«Boolean.importedName».valueOf(defaultValue)); - «ELSEIF "java.lang.Byte".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Byte.importedName».valueOf(defaultValue)); - «ELSEIF "java.lang.Short".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Short.importedName».valueOf(defaultValue)); - «ELSEIF "java.lang.Integer".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Integer.importedName».valueOf(defaultValue)); - «ELSEIF "java.lang.Long".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Long.importedName».valueOf(defaultValue)); - «ELSEIF "org.opendaylight.yangtools.yang.common.Uint8".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Uint8.importedName».valueOf(defaultValue)); - «ELSEIF "org.opendaylight.yangtools.yang.common.Uint16".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Uint16.importedName».valueOf(defaultValue)); - «ELSEIF "org.opendaylight.yangtools.yang.common.Uint32".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Uint32.importedName».valueOf(defaultValue)); - «ELSEIF "org.opendaylight.yangtools.yang.common.Uint64".equals(prop.returnType.fullyQualifiedName)» - return new «genTO.name»(«Uint64.importedName».valueOf(defaultValue)); + return new «genTO.name»(«Empty.importedName».value()); «ELSE» - return new «genTO.name»(new «prop.returnType.importedName»(defaultValue)); + return new «genTO.name»(new «propType.importedName»(defaultValue)); «ENDIF» } «ENDIF» @@ -393,12 +423,12 @@ class ClassTemplate extends BaseTemplate { def protected bitsArgs() ''' «JU_LIST.importedName»<«STRING.importedName»> properties = «Lists.importedName».newArrayList(«allProperties.propsAsArgs»); if (!properties.contains(defaultValue)) { - throw new «IllegalArgumentException.importedName»("invalid default parameter"); + throw new «IAE.importedName»("invalid default parameter"); } int i = 0; return new «genTO.name»( «FOR prop : allProperties SEPARATOR ","» - properties.get(i++).equals(defaultValue) ? «Boolean.importedName».TRUE : null + properties.get(i++).equals(defaultValue) ? true : false «ENDFOR» ); ''' @@ -470,7 +500,7 @@ class ClassTemplate extends BaseTemplate { def protected constantsDeclarations() ''' «IF !consts.empty» «FOR c : consts» - «IF c.name == TypeConstants.PATTERN_CONSTANT_NAME» + «IF TypeConstants.PATTERN_CONSTANT_NAME.equals(c.name)» «val cValue = c.value as Map» «val jurPatternRef = JUR_PATTERN.importedName» public static final «JU_LIST.importedName» «TypeConstants.PATTERN_CONSTANT_NAME» = «ImmutableList.importedName».of(« @@ -521,7 +551,11 @@ class ClassTemplate extends BaseTemplate { @«OVERRIDE.importedName» public int hashCode() { «IF size != 1» - «hashCodeResult(genTO.hashCodeIdentifiers)» + final int prime = 31; + int result = 1; + «FOR property : genTO.hashCodeIdentifiers» + result = prime * result + «property.importedUtilClass».hashCode(«property.fieldName»); + «ENDFOR» return result; «ELSE» return «CODEHELPERS.importedName».wrapperHashCode(«genTO.hashCodeIdentifiers.get(0).fieldName»); @@ -538,21 +572,25 @@ class ClassTemplate extends BaseTemplate { def private generateEquals() ''' «IF !genTO.equalsIdentifiers.empty» @«OVERRIDE.importedName» - public final boolean equals(java.lang.Object obj) { - if (this == obj) { - return true; - } - if (!(obj instanceof «type.name»)) { - return false; - } - final «type.name» other = («type.name») obj; + public final boolean equals(«OBJECT.importedName» obj) { + return this == obj || obj instanceof «type.name» other «FOR property : genTO.equalsIdentifiers» «val fieldName = property.fieldName» - if (!«property.importedUtilClass».equals(«fieldName», other.«fieldName»)) { - return false; - } + && «property.importedUtilClass».equals(«fieldName», other.«fieldName»)« + »«ENDFOR»; + } + «ENDIF» + ''' + + def private generateToString(Collection properties) ''' + «IF !properties.empty» + @«OVERRIDE.importedName» + public «STRING.importedName» toString() { + final var helper = «MOREOBJECTS.importedName».toStringHelper(«type.importedName».class); + «FOR property : properties» + «CODEHELPERS.importedName».appendValue(helper, "«property.name»", «property.fieldName»); «ENDFOR» - return true; + return helper.toString(); } «ENDIF» '''