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

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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 org.opendaylight.mdsal.binding.spec.naming.BindingMapping.AUGMENTABLE_AUGMENTATION_NAME;
  12
  13 import com.google.common.annotations.VisibleForTesting;
  14 import com.google.common.collect.ImmutableSortedSet;
  15 import java.lang.reflect.Method;
  16 import java.util.Collection;
  17 import java.util.Collections;
  18 import java.util.Comparator;
  19 import java.util.LinkedHashSet;
  20 import java.util.List;
  21 import java.util.Set;
  22 import org.eclipse.xtext.xbase.lib.StringExtensions;
  23 import org.opendaylight.mdsal.binding.model.api.CodeGenerator;
  24 import org.opendaylight.mdsal.binding.model.api.DefaultType;
  25 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  26 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  27 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  28 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  29 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
  30 import org.opendaylight.mdsal.binding.model.api.Type;
  31 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTOBuilder;
  32 import org.opendaylight.mdsal.binding.model.api.type.builder.GeneratedTypeBuilder;
  33 import org.opendaylight.mdsal.binding.model.util.Types;
  34 import org.opendaylight.mdsal.binding.model.util.generated.type.builder.CodegenGeneratedTypeBuilder;
  35 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  36 import org.opendaylight.yangtools.yang.binding.Augmentable;
  37 import org.opendaylight.yangtools.yang.binding.Augmentation;
  38
  39 /**
  40  * Transformator of the data from the virtual form to JAVA programming language. The result source code represent java
  41  * class. For generation of the source code is used the template written in XTEND language.
  42  */
  43 public final class BuilderGenerator implements CodeGenerator {
  44     private static final JavaTypeName AUGMENTABLE = JavaTypeName.create(Augmentable.class);
  45     private static final JavaTypeName AUGMENTATION = JavaTypeName.create(Augmentation.class);
  46
  47     private static final Comparator<MethodSignature> METHOD_COMPARATOR = new AlphabeticallyTypeMemberComparator<>();
  48     private static final Type AUGMENTATION_RET_TYPE;
  49
  50     static {
  51         final Method m;
  52         try {
  53             m = Augmentable.class.getDeclaredMethod(AUGMENTABLE_AUGMENTATION_NAME, Class.class);
  54         } catch (NoSuchMethodException e) {
  55             throw new ExceptionInInitializerError(e);
  56         }
  57
  58         AUGMENTATION_RET_TYPE = DefaultType.of(JavaTypeName.create(m.getReturnType()));
  59     }
  60
  61     /**
  62      * Passes via list of implemented types in <code>type</code>.
  63      *
  64      * @param type JAVA <code>Type</code>
  65      * @return boolean value which is true if any of implemented types is of the type <code>Augmentable</code>.
  66      */
  67     @Override
  68     public boolean isAcceptable(final Type type) {
  69         if (type instanceof GeneratedType && !(type instanceof GeneratedTransferObject)) {
  70             for (Type t : ((GeneratedType) type).getImplements()) {
  71                 // "rpc" and "grouping" elements do not implement Augmentable
  72                 final JavaTypeName name = t.getIdentifier();
  73                 if (name.equals(AUGMENTABLE) || name.equals(AUGMENTATION)) {
  74                     return true;
  75                 }
  76             }
  77         }
  78         return false;
  79     }
  80
  81     /**
  82      * Generates JAVA source code for generated type <code>Type</code>. The code is generated according to the template
  83      * source code template which is written in XTEND language.
  84      */
  85     @Override
  86     public String generate(final Type type) {
  87         if (type instanceof GeneratedType && !(type instanceof GeneratedTransferObject)) {
  88             return templateForType((GeneratedType) type).generate();
  89         }
  90         return "";
  91     }
  92
  93     @Override
  94     public String getUnitName(final Type type) {
  95         return type.getName() + BuilderTemplate.BUILDER_STR;
  96     }
  97
  98     @VisibleForTesting
  99     static BuilderTemplate templateForType(final GeneratedType type) {
 100         final GeneratedType genType = type;
 101         final JavaTypeName origName = genType.getIdentifier();
 102
 103         final Set<MethodSignature> methods = new LinkedHashSet<>();
 104         final Type augmentType = createMethods(genType, methods);
 105         final Set<MethodSignature> sortedMethods = ImmutableSortedSet.orderedBy(METHOD_COMPARATOR)
 106                 .addAll(methods).build();
 107
 108         final GeneratedTypeBuilder builderTypeBuilder = new CodegenGeneratedTypeBuilder(
 109             origName.createSibling(origName.simpleName() + BuilderTemplate.BUILDER_STR));
 110
 111         final GeneratedTOBuilder implTypeBuilder = builderTypeBuilder.addEnclosingTransferObject(
 112             origName.simpleName() + "Impl");
 113         implTypeBuilder.addImplementsType(genType);
 114
 115         return new BuilderTemplate(builderTypeBuilder.build(), genType, propertiesFromMethods(sortedMethods),
 116             augmentType, getKey(genType));
 117     }
 118
 119     private static Type getKey(final GeneratedType type) {
 120         for (MethodSignature m : type.getMethodDefinitions()) {
 121             if (BindingMapping.IDENTIFIABLE_KEY_NAME.equals(m.getName())) {
 122                 return m.getReturnType();
 123             }
 124         }
 125         return null;
 126     }
 127
 128     /**
 129      * Returns set of method signature instances which contains all the methods of the <code>genType</code>
 130      * and all the methods of the implemented interfaces.
 131      *
 132      * @returns set of method signature instances
 133      */
 134     private static ParameterizedType createMethods(final GeneratedType type, final Set<MethodSignature> methods) {
 135         methods.addAll(type.getMethodDefinitions());
 136         return collectImplementedMethods(type, methods, type.getImplements());
 137     }
 138
 139     /**
 140      * Adds to the <code>methods</code> set all the methods of the <code>implementedIfcs</code>
 141      * and recursively their implemented interfaces.
 142      *
 143      * @param methods set of method signatures
 144      * @param implementedIfcs list of implemented interfaces
 145      */
 146     private static ParameterizedType collectImplementedMethods(final GeneratedType type,
 147             final Set<MethodSignature> methods, final List<Type> implementedIfcs) {
 148         if (implementedIfcs == null || implementedIfcs.isEmpty()) {
 149             return null;
 150         }
 151
 152         ParameterizedType augmentType = null;
 153         for (Type implementedIfc : implementedIfcs) {
 154             if (implementedIfc instanceof GeneratedType && !(implementedIfc instanceof GeneratedTransferObject)) {
 155                 final GeneratedType ifc = (GeneratedType) implementedIfc;
 156                 methods.addAll(ifc.getMethodDefinitions());
 157
 158                 final ParameterizedType t = collectImplementedMethods(type, methods, ifc.getImplements());
 159                 if (t != null && augmentType == null) {
 160                     augmentType = t;
 161                 }
 162             } else if (Augmentable.class.getName().equals(implementedIfc.getFullyQualifiedName())) {
 163                 augmentType = Types.parameterizedTypeFor(AUGMENTATION_RET_TYPE, DefaultType.of(type.getIdentifier()));
 164             }
 165         }
 166
 167         return augmentType;
 168     }
 169
 170     /**
 171      * Creates set of generated property instances from getter <code>methods</code>.
 172      *
 173      * @param set of method signature instances which should be transformed to list of properties
 174      * @return set of generated property instances which represents the getter <code>methods</code>
 175      */
 176     private static Set<BuilderGeneratedProperty> propertiesFromMethods(final Collection<MethodSignature> methods) {
 177         if (methods == null || methods.isEmpty()) {
 178             return Collections.emptySet();
 179         }
 180         final Set<BuilderGeneratedProperty> result = new LinkedHashSet<>();
 181         for (MethodSignature m : methods) {
 182             final BuilderGeneratedProperty createdField = propertyFromGetter(m);
 183             if (createdField != null) {
 184                 result.add(createdField);
 185             }
 186         }
 187         return result;
 188     }
 189
 190     /**
 191      * Creates generated property instance from the getter <code>method</code> name and return type.
 192      *
 193      * @param method method signature from which is the method name and return type obtained
 194      * @return generated property instance for the getter <code>method</code>
 195      * @throws IllegalArgumentException <ul>
 196      *  <li>if the <code>method</code> equals <code>null</code></li>
 197      *  <li>if the name of the <code>method</code> equals <code>null</code></li>
 198      *  <li>if the name of the <code>method</code> is empty</li>
 199      *  <li>if the return type of the <code>method</code> equals <code>null</code></li>
 200      * </ul>
 201      */
 202     private static BuilderGeneratedProperty propertyFromGetter(final MethodSignature method) {
 203         checkArgument(method != null);
 204         checkArgument(method.getReturnType() != null);
 205         checkArgument(method.getName() != null);
 206         checkArgument(!method.getName().isEmpty());
 207         if (method.isDefault()) {
 208             return null;
 209         }
 210
 211         final String prefix = BindingMapping.getGetterPrefix(Types.BOOLEAN.equals(method.getReturnType()));
 212         if (!method.getName().startsWith(prefix)) {
 213             return null;
 214         }
 215
 216         return new BuilderGeneratedProperty(StringExtensions.toFirstLower(method.getName().substring(prefix.length())),
 217             method);
 218     }
 219 }