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=b8b3ecf23c68474688f702a664a0af1aae4d7da4;hb=8e9118b01e2f89ebf34181de1dc6c96d1a48bf52;hp=f8aeba321c4ab282c171940648669303511ff239;hpb=ce1e55484544d25297cb60cdfc6758e9b14945fb;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 f8aeba321c..b8b3ecf23c 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 @@ -7,26 +7,132 @@ */ 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 com.google.common.collect.ImmutableSortedSet; +import java.lang.reflect.Method; +import java.util.AbstractMap; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.Comparator; +import java.util.HashMap; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; import java.util.Optional; +import java.util.Set; +import java.util.regex.Pattern; import java.util.stream.Collectors; +import org.eclipse.jdt.annotation.NonNull; +import org.eclipse.xtext.xbase.lib.StringExtensions; +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; 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.Restrictions; import org.opendaylight.mdsal.binding.model.api.Type; import org.opendaylight.mdsal.binding.model.util.Types; +import org.opendaylight.mdsal.binding.spec.naming.BindingMapping; +import org.opendaylight.yangtools.yang.binding.Augmentable; +import org.opendaylight.yangtools.yang.binding.AugmentationHolder; +import org.opendaylight.yangtools.yang.binding.CodeHelpers; + /** * Base Java file template. Contains a non-null type and imports which the generated code refers to. */ class JavaFileTemplate { + /** + * {@code java.lang.Class} as a JavaTypeName. + */ + static final @NonNull JavaTypeName CLASS = JavaTypeName.create(Class.class); + /** + * {@code java.lang.Deprecated} as a JavaTypeName. + */ + static final @NonNull JavaTypeName DEPRECATED = JavaTypeName.create(Deprecated.class); + /** + * {@code java.lang.NullPointerException} as a JavaTypeName. + */ + static final @NonNull JavaTypeName NPE = JavaTypeName.create(NullPointerException.class); + /** + * {@code java.lang.Override} as a JavaTypeName. + */ + static final @NonNull JavaTypeName OVERRIDE = JavaTypeName.create(Override.class); + /** + * {@code java.lang.SuppressWarnings} as a JavaTypeName. + */ + static final @NonNull JavaTypeName SUPPRESS_WARNINGS = JavaTypeName.create(SuppressWarnings.class); + + /** + * {@code java.util.Arrays} as a JavaTypeName. + */ + static final @NonNull JavaTypeName JU_ARRAYS = JavaTypeName.create(Arrays.class); + /** + * {@code java.util.HashMap} as a JavaTypeName. + */ + static final @NonNull JavaTypeName JU_HASHMAP = JavaTypeName.create(HashMap.class); + /** + * {@code java.util.List} as a JavaTypeName. + */ + static final @NonNull JavaTypeName JU_LIST = JavaTypeName.create(List.class); + /** + * {@code java.util.Map} as a JavaTypeName. + */ + static final @NonNull JavaTypeName JU_MAP = JavaTypeName.create(Map.class); + /** + * {@code java.util.Objects} as a JavaTypeName. + */ + static final @NonNull JavaTypeName JU_OBJECTS = JavaTypeName.create(Objects.class); + /** + * {@code java.util.regex.Pattern} as a JavaTypeName. + */ + static final @NonNull JavaTypeName JUR_PATTERN = JavaTypeName.create(Pattern.class); + + /** + * {@code org.eclipse.jdt.annotation.NonNull} as a JavaTypeName. + */ + static final @NonNull JavaTypeName NONNULL = JavaTypeName.create("org.eclipse.jdt.annotation", "NonNull"); + /** + * {@code org.eclipse.jdt.annotation.Nullable} as a JavaTypeName. + */ + static final @NonNull JavaTypeName NULLABLE = JavaTypeName.create("org.eclipse.jdt.annotation", "Nullable"); + + /** + * {@code org.opendaylight.yangtools.yang.binding.CodeHelpers} as a JavaTypeName. + */ + static final @NonNull JavaTypeName CODEHELPERS = JavaTypeName.create(CodeHelpers.class); + /** + * {@code org.opendaylight.yangtools.yang.binding.AugmentationHolder} as a JavaTypeName. + */ + static final @NonNull JavaTypeName AUGMENTATION_HOLDER = JavaTypeName.create(AugmentationHolder.class); + + private static final Comparator METHOD_COMPARATOR = new AlphabeticallyTypeMemberComparator<>(); + private static final Type AUGMENTATION_RET_TYPE; + + static { + final Method m; + try { + m = Augmentable.class.getDeclaredMethod(AUGMENTABLE_AUGMENTATION_NAME, Class.class); + } catch (NoSuchMethodException e) { + throw new ExceptionInInitializerError(e); + } + + AUGMENTATION_RET_TYPE = DefaultType.of(JavaTypeName.create(m.getReturnType())); + } + private final AbstractJavaGeneratedType javaType; private final GeneratedType type; - JavaFileTemplate(final GeneratedType type) { + JavaFileTemplate(final @NonNull GeneratedType type) { this(new TopLevelJavaGeneratedType(type), type); } @@ -43,33 +149,46 @@ class JavaFileTemplate { return type; } - final GeneratedProperty findProperty(final GeneratedTransferObject gto, final String name) { - final Optional optProp = gto.getProperties().stream() - .filter(prop -> prop.getName().equals(name)).findFirst(); - if (optProp.isPresent()) { - return optProp.get(); - } - - final GeneratedTransferObject parent = gto.getSuperType(); - return parent != null ? findProperty(parent, name) : null; - } - final String generateImportBlock() { verify(javaType instanceof TopLevelJavaGeneratedType); return ((TopLevelJavaGeneratedType) javaType).imports().map(name -> "import " + name + ";\n") .collect(Collectors.joining()); } - final String importedName(final Type intype) { + final @NonNull String importedJavadocName(final @NonNull Type intype) { + return importedName(intype instanceof ParameterizedType ? ((ParameterizedType) intype).getRawType() : intype); + } + + final @NonNull String importedName(final @NonNull Type intype) { return javaType.getReferenceString(intype); } - final String importedName(final Class cls) { + final @NonNull String importedName(final @NonNull Type intype, final @NonNull String annotation) { + return javaType.getReferenceString(intype, annotation); + } + + final @NonNull String importedName(final Class cls) { return importedName(Types.typeForClass(cls)); } - final void addImport(final Class cls) { - javaType.getReferenceString(JavaTypeName.create(cls)); + final @NonNull String importedName(final @NonNull JavaTypeName intype) { + return javaType.getReferenceString(intype); + } + + final @NonNull String importedNonNull(final @NonNull Type intype) { + return importedName(intype, importedName(NONNULL)); + } + + final @NonNull String importedNullable(final @NonNull Type intype) { + return importedName(intype, importedName(NULLABLE)); + } + + final @NonNull String fullyQualifiedNonNull(final @NonNull Type intype) { + return fullyQualifiedName(intype, importedName(NONNULL)); + } + + final @NonNull String fullyQualifiedName(final @NonNull Type intype, final @NonNull String annotation) { + return javaType.getFullyQualifiedReference(intype, annotation); } // Exposed for BuilderTemplate @@ -77,4 +196,144 @@ class JavaFileTemplate { final Optional optEnc = name.immediatelyEnclosingClass(); return optEnc.isPresent() && type.getIdentifier().equals(optEnc.get()); } + + final CharSequence generateInnerClass(final GeneratedType innerClass) { + if (!(innerClass instanceof GeneratedTransferObject)) { + return ""; + } + + final GeneratedTransferObject gto = (GeneratedTransferObject) innerClass; + final NestedJavaGeneratedType innerJavaType = javaType.getEnclosedType(innerClass.getIdentifier()); + return gto.isUnionType() ? new UnionTemplate(innerJavaType, gto).generateAsInnerClass() + : new ClassTemplate(innerJavaType, gto).generateAsInnerClass(); + } + + /** + * Return imported name of java.util class, whose hashCode/equals methods we want to invoke on the property. Returns + * {@link Arrays} if the property is an array, {@link Objects} otherwise. + * + * @param property Generated property + * @return Imported class name + */ + final String importedUtilClass(final GeneratedProperty property) { + return importedName(property.getReturnType().getName().indexOf('[') != -1 ? JU_ARRAYS : JU_OBJECTS); + } + + /** + * Run type analysis, which results in identification of the augmentable type, as well as all methods available + * to the type, expressed as properties. + */ + static Map.Entry> analyzeTypeHierarchy(final GeneratedType type) { + final Set methods = new LinkedHashSet<>(); + final Type augmentType = createMethods(type, methods); + final Set sortedMethods = ImmutableSortedSet.orderedBy(METHOD_COMPARATOR).addAll(methods) + .build(); + + return new AbstractMap.SimpleImmutableEntry<>(augmentType, propertiesFromMethods(sortedMethods)); + } + + static final Restrictions restrictionsForSetter(final Type actualType) { + return actualType instanceof GeneratedType ? null : getRestrictions(actualType); + } + + static final Restrictions getRestrictions(final Type type) { + if (type instanceof ConcreteType) { + return ((ConcreteType) type).getRestrictions(); + } + if (type instanceof GeneratedTransferObject) { + return ((GeneratedTransferObject) type).getRestrictions(); + } + return null; + } + + /** + * Returns set of method signature instances which contains all the methods of the genType + * and all the methods of the implemented interfaces. + * + * @returns set of method signature instances + */ + private static ParameterizedType createMethods(final GeneratedType type, final Set methods) { + methods.addAll(type.getMethodDefinitions()); + return collectImplementedMethods(type, methods, type.getImplements()); + } + + /** + * Adds to the methods set all the methods of the implementedIfcs + * and recursively their implemented interfaces. + * + * @param methods set of method signatures + * @param implementedIfcs list of implemented interfaces + */ + private static ParameterizedType collectImplementedMethods(final GeneratedType type, + final Set methods, final List implementedIfcs) { + if (implementedIfcs == null || implementedIfcs.isEmpty()) { + return null; + } + + ParameterizedType augmentType = null; + for (Type implementedIfc : implementedIfcs) { + if (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject)) { + final GeneratedType ifc = (GeneratedType) implementedIfc; + methods.addAll(ifc.getMethodDefinitions()); + + final ParameterizedType t = collectImplementedMethods(type, methods, ifc.getImplements()); + if (t != null && augmentType == null) { + augmentType = t; + } + } else if (Augmentable.class.getName().equals(implementedIfc.getFullyQualifiedName())) { + augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, DefaultType.of(type.getIdentifier())); + } + } + + return augmentType; + } + + /** + * Creates set of generated property instances from getter methods. + * + * @param methods set of method signature instances which should be transformed to list of properties + * @return set of generated property instances which represents the getter methods + */ + private static Set propertiesFromMethods(final Collection methods) { + if (methods == null || methods.isEmpty()) { + return Collections.emptySet(); + } + final Set result = new LinkedHashSet<>(); + for (MethodSignature m : methods) { + final BuilderGeneratedProperty createdField = propertyFromGetter(m); + if (createdField != null) { + result.add(createdField); + } + } + return result; + } + + /** + * Creates generated property instance from the getter method name and return type. + * + * @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 method equals null
    • + *
  • if the name of the method equals null
    • + *
  • if the name of the method is empty
    • + *
  • if the return type of the method equals null
    • + *
+ */ + private static BuilderGeneratedProperty propertyFromGetter(final MethodSignature method) { + checkArgument(method != null); + checkArgument(method.getReturnType() != null); + checkArgument(method.getName() != null); + checkArgument(!method.getName().isEmpty()); + if (method.isDefault()) { + return null; + } + final String prefix = BindingMapping.getGetterPrefix(Types.BOOLEAN.equals(method.getReturnType())); + if (!method.getName().startsWith(prefix)) { + return null; + } + + final String fieldName = StringExtensions.toFirstLower(method.getName().substring(prefix.length())); + return new BuilderGeneratedProperty(fieldName, method); + } }