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 com.google.common.annotations.VisibleForTesting;
  11 import org.opendaylight.mdsal.binding.model.api.CodeGenerator;
  12 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  13 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  14 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  15 import org.opendaylight.mdsal.binding.model.api.MethodSignature;
  16 import org.opendaylight.mdsal.binding.model.api.Type;
  17 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenGeneratedTOBuilder;
  18 import org.opendaylight.mdsal.binding.model.ri.generated.type.builder.CodegenGeneratedTypeBuilder;
  19 import org.opendaylight.yangtools.yang.binding.Augmentable;
  20 import org.opendaylight.yangtools.yang.binding.Augmentation;
  21 import org.opendaylight.yangtools.yang.binding.YangData;
  22 import org.opendaylight.yangtools.yang.binding.contract.Naming;
  23
  24 /**
  25  * Transformator of the data from the virtual form to JAVA programming language. The result source code represent java
  26  * class. For generation of the source code is used the template written in XTEND language.
  27  */
  28 public final class BuilderGenerator implements CodeGenerator {
  29     private static final JavaTypeName AUGMENTABLE = JavaTypeName.create(Augmentable.class);
  30     private static final JavaTypeName AUGMENTATION = JavaTypeName.create(Augmentation.class);
  31     private static final JavaTypeName YANG_DATA = JavaTypeName.create(YangData.class);
  32
  33     /**
  34      * Passes via list of implemented types in <code>type</code>.
  35      *
  36      * @param type JAVA <code>Type</code>
  37      * @return boolean value which is true if any of implemented types is of the type <code>Augmentable</code>.
  38      */
  39     @Override
  40     public boolean isAcceptable(final Type type) {
  41         if (type instanceof GeneratedType generated && !(type instanceof GeneratedTransferObject)) {
  42             for (Type t : generated.getImplements()) {
  43                 // "rpc" and "grouping" elements do not implement Augmentable
  44                 final JavaTypeName name = t.getIdentifier();
  45                 if (name.equals(AUGMENTABLE) || name.equals(AUGMENTATION) || name.equals(YANG_DATA)) {
  46                     return true;
  47                 }
  48             }
  49         }
  50         return false;
  51     }
  52
  53     /**
  54      * Generates JAVA source code for generated type <code>Type</code>. The code is generated according to the template
  55      * source code template which is written in XTEND language.
  56      */
  57     @Override
  58     public String generate(final Type type) {
  59         if (type instanceof GeneratedType generated && !(type instanceof GeneratedTransferObject)) {
  60             return templateForType(generated).generate();
  61         }
  62         return "";
  63     }
  64
  65     @Override
  66     public String getUnitName(final Type type) {
  67         return type.getName() + Naming.BUILDER_SUFFIX;
  68     }
  69
  70     @VisibleForTesting
  71     static BuilderTemplate templateForType(final GeneratedType type) {
  72         final JavaTypeName origName = type.getIdentifier();
  73         final JavaTypeName builderName = origName.createSibling(origName.simpleName() + Naming.BUILDER_SUFFIX);
  74
  75         return new BuilderTemplate(new CodegenGeneratedTypeBuilder(builderName)
  76             .addEnclosingTransferObject(new CodegenGeneratedTOBuilder(
  77                 builderName.createEnclosed(origName.simpleName() + "Impl"))
  78                 .addImplementsType(type)
  79                 .build())
  80             .build(), type, getKey(type));
  81     }
  82
  83     private static Type getKey(final GeneratedType type) {
  84         for (MethodSignature m : type.getMethodDefinitions()) {
  85             if (Naming.IDENTIFIABLE_KEY_NAME.equals(m.getName())) {
  86                 return m.getReturnType();
  87             }
  88         }
  89         return null;
  90     }
  91 }