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%2FJavaFileTemplate.java;h=cb0e5c5499a6fbc42b72218f18e822908b55a222;hb=d9bb45af73fe0becf0fe0f1bf459504553d431b0;hp=6997b4d3f73ccd749556990f6d9614e2b8f8c4d8;hpb=a86bc81d199978aeb0b5a08e52975973a4ea9e6a;p=mdsal.git diff --git a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/JavaFileTemplate.java b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/JavaFileTemplate.java index 6997b4d3f7..cb0e5c5499 100644 --- a/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/JavaFileTemplate.java +++ b/binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/JavaFileTemplate.java @@ -10,9 +10,10 @@ package org.opendaylight.mdsal.binding.java.api.generator; import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Verify.verify; import static java.util.Objects.requireNonNull; -import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME; -import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.GETTER_PREFIX; +import static org.opendaylight.mdsal.binding.generator.BindingGeneratorUtil.encodeAngleBrackets; +import static org.opendaylight.mdsal.binding.generator.BindingGeneratorUtil.replaceAllIllegalChars; +import com.google.common.base.CharMatcher; import com.google.common.collect.ImmutableSortedSet; import java.lang.reflect.Method; import java.util.AbstractMap; @@ -24,16 +25,17 @@ import java.util.HashMap; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; +import java.util.NoSuchElementException; import java.util.Objects; import java.util.Optional; import java.util.Set; import java.util.regex.Pattern; import java.util.stream.Collectors; +import javax.annotation.processing.Generated; import org.eclipse.jdt.annotation.NonNull; import org.eclipse.xtext.xbase.lib.StringExtensions; import org.opendaylight.mdsal.binding.model.api.AnnotationType; import org.opendaylight.mdsal.binding.model.api.ConcreteType; -import org.opendaylight.mdsal.binding.model.api.DefaultType; import org.opendaylight.mdsal.binding.model.api.GeneratedProperty; import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject; import org.opendaylight.mdsal.binding.model.api.GeneratedType; @@ -42,10 +44,25 @@ import org.opendaylight.mdsal.binding.model.api.MethodSignature; import org.opendaylight.mdsal.binding.model.api.ParameterizedType; import org.opendaylight.mdsal.binding.model.api.Restrictions; import org.opendaylight.mdsal.binding.model.api.Type; -import org.opendaylight.mdsal.binding.model.util.Types; +import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition.Multiple; +import org.opendaylight.mdsal.binding.model.api.YangSourceDefinition.Single; +import org.opendaylight.mdsal.binding.model.ri.Types; import org.opendaylight.mdsal.binding.spec.naming.BindingMapping; import org.opendaylight.yangtools.yang.binding.Augmentable; import org.opendaylight.yangtools.yang.binding.CodeHelpers; +import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.common.XMLNamespace; +import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; +import org.opendaylight.yangtools.yang.model.api.DocumentedNode; +import org.opendaylight.yangtools.yang.model.api.ListSchemaNode; +import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; +import org.opendaylight.yangtools.yang.model.api.RpcDefinition; +import org.opendaylight.yangtools.yang.model.api.SchemaNode; +import org.opendaylight.yangtools.yang.model.api.YangStmtMapping; +import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement; +import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement; +import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement; +import org.opendaylight.yangtools.yang.model.export.DeclaredStatementFormatter; /** * Base Java file template. Contains a non-null type and imports which the generated code refers to. @@ -63,6 +80,10 @@ class JavaFileTemplate { * {@code java.lang.NullPointerException} as a JavaTypeName. */ static final @NonNull JavaTypeName NPE = JavaTypeName.create(NullPointerException.class); + /** + * {@code java.lang.NoSuchElementException} as a JavaTypeName. + */ + static final @NonNull JavaTypeName NSEE = JavaTypeName.create(NoSuchElementException.class); /** * {@code java.lang.Override} as a JavaTypeName. */ @@ -101,6 +122,11 @@ class JavaFileTemplate { */ static final @NonNull JavaTypeName JUR_PATTERN = JavaTypeName.create(Pattern.class); + /** + * {@code javax.annotation.processing.Generated} as a JavaTypeName. + */ + static final @NonNull JavaTypeName GENERATED = JavaTypeName.create(Generated.class); + /** * {@code org.eclipse.jdt.annotation.NonNull} as a JavaTypeName. */ @@ -115,18 +141,28 @@ class JavaFileTemplate { */ static final @NonNull JavaTypeName CODEHELPERS = JavaTypeName.create(CodeHelpers.class); + private static final Comparator METHOD_COMPARATOR = new AlphabeticallyTypeMemberComparator<>(); + private static final CharMatcher AMP_MATCHER = CharMatcher.is('&'); + private static final Pattern TAIL_COMMENT_PATTERN = Pattern.compile("*/", Pattern.LITERAL); + private static final DeclaredStatementFormatter YANG_FORMATTER = DeclaredStatementFormatter.builder() + .addIgnoredStatement(YangStmtMapping.CONTACT) + .addIgnoredStatement(YangStmtMapping.DESCRIPTION) + .addIgnoredStatement(YangStmtMapping.REFERENCE) + .addIgnoredStatement(YangStmtMapping.ORGANIZATION) + .build(); + private static final int GETTER_PREFIX_LENGTH = BindingMapping.GETTER_PREFIX.length(); private static final Type AUGMENTATION_RET_TYPE; static { final Method m; try { - m = Augmentable.class.getDeclaredMethod(AUGMENTABLE_AUGMENTATION_NAME, Class.class); + m = Augmentable.class.getDeclaredMethod(BindingMapping.AUGMENTABLE_AUGMENTATION_NAME, Class.class); } catch (NoSuchMethodException e) { throw new ExceptionInInitializerError(e); } - AUGMENTATION_RET_TYPE = DefaultType.of(JavaTypeName.create(m.getReturnType())); + AUGMENTATION_RET_TYPE = Type.of(JavaTypeName.create(m.getReturnType())); } private final AbstractJavaGeneratedType javaType; @@ -219,6 +255,10 @@ class JavaFileTemplate { return importedName(property.getReturnType().getName().indexOf('[') != -1 ? JU_ARRAYS : JU_OBJECTS); } + final String generatedAnnotation() { + return "@" + importedName(GENERATED) + "(\"mdsal-binding-generator\")"; + } + /** * Run type analysis, which results in identification of the augmentable type, as well as all methods available * to the type, expressed as properties. @@ -291,7 +331,7 @@ class JavaFileTemplate { augmentType = t; } } else if (Augmentable.class.getName().equals(implementedIfc.getFullyQualifiedName())) { - augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, DefaultType.of(type.getIdentifier())); + augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, Type.of(type.getIdentifier())); } } @@ -317,10 +357,8 @@ class JavaFileTemplate { final String implMethodName) { for (MethodSignature method : methods) { final String methodName = method.getName(); - if (BindingMapping.isGetterMethodName(methodName)) { - if (isSameProperty(method.getName(), implMethodName)) { - return Optional.of(method); - } + if (BindingMapping.isGetterMethodName(methodName) && isSameProperty(method.getName(), implMethodName)) { + return Optional.of(method); } } return Optional.empty(); @@ -336,6 +374,8 @@ class JavaFileTemplate { prefix = BindingMapping.GETTER_PREFIX; } else if (BindingMapping.isNonnullMethodName(getterName)) { prefix = BindingMapping.NONNULL_PREFIX; + } else if (BindingMapping.isRequireMethodName(getterName)) { + prefix = BindingMapping.REQUIRE_PREFIX; } else { throw new IllegalArgumentException(getterName + " is not a getter"); } @@ -357,6 +397,88 @@ class JavaFileTemplate { return false; } + static void appendSnippet(final StringBuilder sb, final GeneratedType type) { + type.getYangSourceDefinition().ifPresent(def -> { + sb.append('\n'); + + if (def instanceof Single) { + final DocumentedNode node = ((Single) def).getNode(); + + sb.append("

\n") + .append("This class represents the following YANG schema fragment defined in module ") + .append(def.getModule().argument().getLocalName()).append("\n") + .append("

\n");
+                appendYangSnippet(sb, def.getModule(), ((EffectiveStatement) node).getDeclared());
+                sb.append("
"); + + if (node instanceof SchemaNode) { + final SchemaNode schema = (SchemaNode) node; + sb.append("The schema path to identify an instance is\n"); + appendPath(sb.append(""), def.getModule(), schema.getPath().getPathFromRoot()); + sb.append("\n"); + + if (hasBuilderClass(schema)) { + final String builderName = type.getName() + BindingMapping.BUILDER_SUFFIX; + + sb.append("\n

To create instances of this class use {@link ").append(builderName) + .append("}.\n") + .append("@see ").append(builderName).append('\n'); + if (node instanceof ListSchemaNode) { + final var keyDef = ((ListSchemaNode) node).getKeyDefinition(); + if (!keyDef.isEmpty()) { + sb.append("@see ").append(type.getName()).append(BindingMapping.KEY_SUFFIX); + } + sb.append('\n'); + } + } + } + } else if (def instanceof Multiple) { + sb.append("

\n");
+                for (SchemaNode node : ((Multiple) def).getNodes()) {
+                    appendYangSnippet(sb, def.getModule(), ((EffectiveStatement) node).getDeclared());
+                }
+                sb.append("
\n"); + } + }); + } + + static String encodeJavadocSymbols(final String description) { + // FIXME: Use String.isBlank()? + return description == null || description.isEmpty() ? description + : TAIL_COMMENT_PATTERN.matcher(AMP_MATCHER.replaceFrom(description, "&")).replaceAll("*/"); + } + + private static void appendYangSnippet(final StringBuilder sb, final ModuleEffectiveStatement module, + final DeclaredStatement stmt) { + for (String str : YANG_FORMATTER.toYangTextSnippet(module, stmt)) { + sb.append(replaceAllIllegalChars(encodeAngleBrackets(encodeJavadocSymbols(str)))); + } + } + + private static void appendPath(final StringBuilder sb, final ModuleEffectiveStatement module, + final List path) { + if (!path.isEmpty()) { + // FIXME: this is module name, while when we switch, we end up using QName.toString() -- which is weird + sb.append(module.argument().getLocalName()); + XMLNamespace currentNamespace = path.get(0).getNamespace(); + + for (QName pathElement : path) { + final XMLNamespace elementNamespace = pathElement.getNamespace(); + if (!elementNamespace.equals(currentNamespace)) { + sb.append(pathElement); + currentNamespace = elementNamespace; + } else { + sb.append(pathElement.getLocalName()); + } + } + } + } + + private static boolean hasBuilderClass(final SchemaNode schemaNode) { + return schemaNode instanceof ContainerSchemaNode || schemaNode instanceof ListSchemaNode + || schemaNode instanceof RpcDefinition || schemaNode instanceof NotificationDefinition; + } + private static boolean isSameProperty(final String getterName1, final String getterName2) { return propertyNameFromGetter(getterName1).equals(propertyNameFromGetter(getterName2)); } @@ -387,11 +509,11 @@ class JavaFileTemplate { * @param method method signature from which is the method name and return type obtained * @return generated property instance for the getter method * @throws IllegalArgumentException + *
  • if the {@code method} equals {@code null}
    • + *
  • if the name of the {@code method} equals {@code null}
    • + *
  • if the name of the {@code method} is empty
    • + *
  • if the return type of the {@code method} equals {@code null}
    • + * */ private static BuilderGeneratedProperty propertyFromGetter(final MethodSignature method) { checkArgument(method != null); @@ -405,7 +527,7 @@ class JavaFileTemplate { return null; } - final String fieldName = StringExtensions.toFirstLower(method.getName().substring(GETTER_PREFIX.length())); + final String fieldName = StringExtensions.toFirstLower(method.getName().substring(GETTER_PREFIX_LENGTH)); return new BuilderGeneratedProperty(fieldName, method); } }