binding/mdsal-binding-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/java/api/generator/JavaFileTemplate.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.java.api.generator;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Verify.verify;
  12 import static java.util.Objects.requireNonNull;
  13 import static org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME;
  14
  15 import com.google.common.collect.ImmutableSortedSet;
  16 import java.lang.reflect.Method;
  17 import java.util.AbstractMap;
  18 import java.util.Arrays;
  19 import java.util.Collection;
  20 import java.util.Collections;
  21 import java.util.Comparator;
  22 import java.util.HashMap;
  23 import java.util.LinkedHashSet;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.Objects;
  27 import java.util.Optional;
  28 import java.util.Set;
  29 import java.util.regex.Pattern;
  30 import java.util.stream.Collectors;
  31 import org.eclipse.jdt.annotation.NonNull;
  32 import org.eclipse.xtext.xbase.lib.StringExtensions;
  33 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
  34 import org.opendaylight.mdsal.binding.model.api.DefaultType;
  35 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  36 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  37 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  38 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  39 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  40 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
  41 import org.opendaylight.mdsal.binding.model.api.Restrictions;
  42 import org.opendaylight.mdsal.binding.model.api.Type;
  43 import org.opendaylight.mdsal.binding.model.util.Types;
  44 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  45 import org.opendaylight.yangtools.yang.binding.Augmentable;
  46 import org.opendaylight.yangtools.yang.binding.AugmentationHolder;
  47 import org.opendaylight.yangtools.yang.binding.CodeHelpers;
  48
  49
  50 /**
  51  * Base Java file template. Contains a non-null type and imports which the generated code refers to.
  52  */
  53 class JavaFileTemplate {
  54     /**
  55      * {@code java.lang.Class} as a JavaTypeName.
  56      */
  57     static final @NonNull JavaTypeName CLASS = JavaTypeName.create(Class.class);
  58     /**
  59      * {@code java.lang.Deprecated} as a JavaTypeName.
  60      */
  61     static final @NonNull JavaTypeName DEPRECATED = JavaTypeName.create(Deprecated.class);
  62     /**
  63      * {@code java.lang.NullPointerException} as a JavaTypeName.
  64      */
  65     static final @NonNull JavaTypeName NPE = JavaTypeName.create(NullPointerException.class);
  66     /**
  67      * {@code java.lang.Override} as a JavaTypeName.
  68      */
  69     static final @NonNull JavaTypeName OVERRIDE = JavaTypeName.create(Override.class);
  70     /**
  71      * {@code java.lang.SuppressWarnings} as a JavaTypeName.
  72      */
  73     static final @NonNull JavaTypeName SUPPRESS_WARNINGS = JavaTypeName.create(SuppressWarnings.class);
  74
  75     /**
  76      * {@code java.util.Arrays} as a JavaTypeName.
  77      */
  78     static final @NonNull JavaTypeName JU_ARRAYS = JavaTypeName.create(Arrays.class);
  79     /**
  80      * {@code java.util.HashMap} as a JavaTypeName.
  81      */
  82     static final @NonNull JavaTypeName JU_HASHMAP = JavaTypeName.create(HashMap.class);
  83     /**
  84      * {@code java.util.List} as a JavaTypeName.
  85      */
  86     static final @NonNull JavaTypeName JU_LIST = JavaTypeName.create(List.class);
  87     /**
  88      * {@code java.util.Map} as a JavaTypeName.
  89      */
  90     static final @NonNull JavaTypeName JU_MAP = JavaTypeName.create(Map.class);
  91     /**
  92      * {@code java.util.Objects} as a JavaTypeName.
  93      */
  94     static final @NonNull JavaTypeName JU_OBJECTS = JavaTypeName.create(Objects.class);
  95     /**
  96      * {@code java.util.regex.Pattern} as a JavaTypeName.
  97      */
  98     static final @NonNull JavaTypeName JUR_PATTERN = JavaTypeName.create(Pattern.class);
  99
 100     /**
 101      * {@code org.eclipse.jdt.annotation.NonNull} as a JavaTypeName.
 102      */
 103     static final @NonNull JavaTypeName NONNULL = JavaTypeName.create("org.eclipse.jdt.annotation", "NonNull");
 104     /**
 105      * {@code org.eclipse.jdt.annotation.Nullable} as a JavaTypeName.
 106      */
 107     static final @NonNull JavaTypeName NULLABLE = JavaTypeName.create("org.eclipse.jdt.annotation", "Nullable");
 108
 109     /**
 110      * {@code org.opendaylight.yangtools.yang.binding.CodeHelpers} as a JavaTypeName.
 111      */
 112     static final @NonNull JavaTypeName CODEHELPERS = JavaTypeName.create(CodeHelpers.class);
 113     /**
 114      * {@code org.opendaylight.yangtools.yang.binding.AugmentationHolder} as a JavaTypeName.
 115      */
 116     static final @NonNull JavaTypeName AUGMENTATION_HOLDER = JavaTypeName.create(AugmentationHolder.class);
 117
 118     private static final Comparator<MethodSignature> METHOD_COMPARATOR = new AlphabeticallyTypeMemberComparator<>();
 119     private static final Type AUGMENTATION_RET_TYPE;
 120
 121     static {
 122         final Method m;
 123         try {
 124             m = Augmentable.class.getDeclaredMethod(AUGMENTABLE_AUGMENTATION_NAME, Class.class);
 125         } catch (NoSuchMethodException e) {
 126             throw new ExceptionInInitializerError(e);
 127         }
 128
 129         AUGMENTATION_RET_TYPE = DefaultType.of(JavaTypeName.create(m.getReturnType()));
 130     }
 131
 132     private final AbstractJavaGeneratedType javaType;
 133     private final GeneratedType type;
 134
 135     JavaFileTemplate(final @NonNull GeneratedType type) {
 136         this(new TopLevelJavaGeneratedType(type), type);
 137     }
 138
 139     JavaFileTemplate(final AbstractJavaGeneratedType javaType, final GeneratedType type) {
 140         this.javaType = requireNonNull(javaType);
 141         this.type = requireNonNull(type);
 142     }
 143
 144     final AbstractJavaGeneratedType javaType() {
 145         return javaType;
 146     }
 147
 148     final GeneratedType type() {
 149         return type;
 150     }
 151
 152     final String generateImportBlock() {
 153         verify(javaType instanceof TopLevelJavaGeneratedType);
 154         return ((TopLevelJavaGeneratedType) javaType).imports().map(name -> "import " + name + ";\n")
 155                 .collect(Collectors.joining());
 156     }
 157
 158     final @NonNull String importedJavadocName(final @NonNull Type intype) {
 159         return importedName(intype instanceof ParameterizedType ? ((ParameterizedType) intype).getRawType() : intype);
 160     }
 161
 162     final @NonNull String importedName(final @NonNull Type intype) {
 163         return javaType.getReferenceString(intype);
 164     }
 165
 166     final @NonNull String importedName(final @NonNull Type intype, final @NonNull String annotation) {
 167         return javaType.getReferenceString(intype, annotation);
 168     }
 169
 170     final @NonNull String importedName(final Class<?> cls) {
 171         return importedName(Types.typeForClass(cls));
 172     }
 173
 174     final @NonNull String importedName(final @NonNull JavaTypeName intype) {
 175         return javaType.getReferenceString(intype);
 176     }
 177
 178     final @NonNull String importedNonNull(final @NonNull Type intype) {
 179         return importedName(intype, importedName(NONNULL));
 180     }
 181
 182     final @NonNull String importedNullable(final @NonNull Type intype) {
 183         return importedName(intype, importedName(NULLABLE));
 184     }
 185
 186     final @NonNull String fullyQualifiedNonNull(final @NonNull Type intype) {
 187         return fullyQualifiedName(intype, importedName(NONNULL));
 188     }
 189
 190     final @NonNull String fullyQualifiedName(final @NonNull Type intype, final @NonNull String annotation) {
 191         return javaType.getFullyQualifiedReference(intype, annotation);
 192     }
 193
 194     // Exposed for BuilderTemplate
 195     boolean isLocalInnerClass(final JavaTypeName name) {
 196         final Optional<JavaTypeName> optEnc = name.immediatelyEnclosingClass();
 197         return optEnc.isPresent() && type.getIdentifier().equals(optEnc.get());
 198     }
 199
 200     final CharSequence generateInnerClass(final GeneratedType innerClass) {
 201         if (!(innerClass instanceof GeneratedTransferObject)) {
 202             return "";
 203         }
 204
 205         final GeneratedTransferObject gto = (GeneratedTransferObject) innerClass;
 206         final NestedJavaGeneratedType innerJavaType = javaType.getEnclosedType(innerClass.getIdentifier());
 207         return gto.isUnionType() ? new UnionTemplate(innerJavaType, gto).generateAsInnerClass()
 208                 : new ClassTemplate(innerJavaType, gto).generateAsInnerClass();
 209     }
 210
 211     /**
 212      * Return imported name of java.util class, whose hashCode/equals methods we want to invoke on the property. Returns
 213      * {@link Arrays} if the property is an array, {@link Objects} otherwise.
 214      *
 215      * @param property Generated property
 216      * @return Imported class name
 217      */
 218     final String importedUtilClass(final GeneratedProperty property) {
 219         return importedName(property.getReturnType().getName().indexOf('[') != -1 ? JU_ARRAYS : JU_OBJECTS);
 220     }
 221
 222     /**
 223      * Run type analysis, which results in identification of the augmentable type, as well as all methods available
 224      * to the type, expressed as properties.
 225      */
 226     static Map.Entry<Type, Set<BuilderGeneratedProperty>> analyzeTypeHierarchy(final GeneratedType type) {
 227         final Set<MethodSignature> methods = new LinkedHashSet<>();
 228         final Type augmentType = createMethods(type, methods);
 229         final Set<MethodSignature> sortedMethods = ImmutableSortedSet.orderedBy(METHOD_COMPARATOR).addAll(methods)
 230                 .build();
 231
 232         return new AbstractMap.SimpleImmutableEntry<>(augmentType, propertiesFromMethods(sortedMethods));
 233     }
 234
 235     static final Restrictions restrictionsForSetter(final Type actualType) {
 236         return actualType instanceof GeneratedType ? null : getRestrictions(actualType);
 237     }
 238
 239     static final Restrictions getRestrictions(final Type type) {
 240         if (type instanceof ConcreteType) {
 241             return ((ConcreteType) type).getRestrictions();
 242         }
 243         if (type instanceof GeneratedTransferObject) {
 244             return ((GeneratedTransferObject) type).getRestrictions();
 245         }
 246         return null;
 247     }
 248
 249     /**
 250      * Returns set of method signature instances which contains all the methods of the <code>genType</code>
 251      * and all the methods of the implemented interfaces.
 252      *
 253      * @returns set of method signature instances
 254      */
 255     private static ParameterizedType createMethods(final GeneratedType type, final Set<MethodSignature> methods) {
 256         methods.addAll(type.getMethodDefinitions());
 257         return collectImplementedMethods(type, methods, type.getImplements());
 258     }
 259
 260     /**
 261      * Adds to the <code>methods</code> set all the methods of the <code>implementedIfcs</code>
 262      * and recursively their implemented interfaces.
 263      *
 264      * @param methods set of method signatures
 265      * @param implementedIfcs list of implemented interfaces
 266      */
 267     private static ParameterizedType collectImplementedMethods(final GeneratedType type,
 268             final Set<MethodSignature> methods, final List<Type> implementedIfcs) {
 269         if (implementedIfcs == null || implementedIfcs.isEmpty()) {
 270             return null;
 271         }
 272
 273         ParameterizedType augmentType = null;
 274         for (Type implementedIfc : implementedIfcs) {
 275             if (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject)) {
 276                 final GeneratedType ifc = (GeneratedType) implementedIfc;
 277                 methods.addAll(ifc.getMethodDefinitions());
 278
 279                 final ParameterizedType t = collectImplementedMethods(type, methods, ifc.getImplements());
 280                 if (t != null && augmentType == null) {
 281                     augmentType = t;
 282                 }
 283             } else if (Augmentable.class.getName().equals(implementedIfc.getFullyQualifiedName())) {
 284                 augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, DefaultType.of(type.getIdentifier()));
 285             }
 286         }
 287
 288         return augmentType;
 289     }
 290
 291     /**
 292      * Creates set of generated property instances from getter <code>methods</code>.
 293      *
 294      * @param methods set of method signature instances which should be transformed to list of properties
 295      * @return set of generated property instances which represents the getter <code>methods</code>
 296      */
 297     private static Set<BuilderGeneratedProperty> propertiesFromMethods(final Collection<MethodSignature> methods) {
 298         if (methods == null || methods.isEmpty()) {
 299             return Collections.emptySet();
 300         }
 301         final Set<BuilderGeneratedProperty> result = new LinkedHashSet<>();
 302         for (MethodSignature m : methods) {
 303             final BuilderGeneratedProperty createdField = propertyFromGetter(m);
 304             if (createdField != null) {
 305                 result.add(createdField);
 306             }
 307         }
 308         return result;
 309     }
 310
 311     /**
 312      * Creates generated property instance from the getter <code>method</code> name and return type.
 313      *
 314      * @param method method signature from which is the method name and return type obtained
 315      * @return generated property instance for the getter <code>method</code>
 316      * @throws IllegalArgumentException <ul>
 317      *  <li>if the <code>method</code> equals <code>null</code></li>
 318      *  <li>if the name of the <code>method</code> equals <code>null</code></li>
 319      *  <li>if the name of the <code>method</code> is empty</li>
 320      *  <li>if the return type of the <code>method</code> equals <code>null</code></li>
 321      * </ul>
 322      */
 323     private static BuilderGeneratedProperty propertyFromGetter(final MethodSignature method) {
 324         checkArgument(method != null);
 325         checkArgument(method.getReturnType() != null);
 326         checkArgument(method.getName() != null);
 327         checkArgument(!method.getName().isEmpty());
 328         if (method.isDefault()) {
 329             return null;
 330         }
 331         final String prefix = BindingMapping.getGetterPrefix(Types.BOOLEAN.equals(method.getReturnType()));
 332         if (!method.getName().startsWith(prefix)) {
 333             return null;
 334         }
 335
 336         final String fieldName = StringExtensions.toFirstLower(method.getName().substring(prefix.length()));
 337         return new BuilderGeneratedProperty(fieldName, method);
 338     }
 339 }