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.Verify.verify;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import java.util.Arrays;
  14 import java.util.Objects;
  15 import java.util.Optional;
  16 import java.util.stream.Collectors;
  17 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
  18 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  19 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  20 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  21 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  22 import org.opendaylight.mdsal.binding.model.api.Restrictions;
  23 import org.opendaylight.mdsal.binding.model.api.Type;
  24 import org.opendaylight.mdsal.binding.model.util.Types;
  25
  26 /**
  27  * Base Java file template. Contains a non-null type and imports which the generated code refers to.
  28  */
  29 class JavaFileTemplate {
  30     private final AbstractJavaGeneratedType javaType;
  31     private final GeneratedType type;
  32
  33     JavaFileTemplate(final GeneratedType type) {
  34         this(new TopLevelJavaGeneratedType(type), type);
  35     }
  36
  37     JavaFileTemplate(final AbstractJavaGeneratedType javaType, final GeneratedType type) {
  38         this.javaType = requireNonNull(javaType);
  39         this.type = requireNonNull(type);
  40     }
  41
  42     final AbstractJavaGeneratedType javaType() {
  43         return javaType;
  44     }
  45
  46     final GeneratedType type() {
  47         return type;
  48     }
  49
  50     final GeneratedProperty findProperty(final GeneratedTransferObject gto, final String name) {
  51         final Optional<GeneratedProperty> optProp = gto.getProperties().stream()
  52                 .filter(prop -> prop.getName().equals(name)).findFirst();
  53         if (optProp.isPresent()) {
  54             return optProp.get();
  55         }
  56
  57         final GeneratedTransferObject parent = gto.getSuperType();
  58         return parent != null ? findProperty(parent, name) : null;
  59     }
  60
  61     final String generateImportBlock() {
  62         verify(javaType instanceof TopLevelJavaGeneratedType);
  63         return ((TopLevelJavaGeneratedType) javaType).imports().map(name -> "import " + name + ";\n")
  64                 .collect(Collectors.joining());
  65     }
  66
  67     final String importedName(final Type intype, final String... annotations) {
  68         return javaType.getReferenceString(intype, annotations);
  69     }
  70
  71     final String importedName(final Class<?> cls) {
  72         return importedName(Types.typeForClass(cls));
  73     }
  74
  75     final String importedName(final JavaTypeName intype) {
  76         return javaType.getReferenceString(intype);
  77     }
  78
  79     final void addImport(final Class<?> cls) {
  80         javaType.getReferenceString(JavaTypeName.create(cls));
  81     }
  82
  83     // Exposed for BuilderTemplate
  84     boolean isLocalInnerClass(final JavaTypeName name) {
  85         final Optional<JavaTypeName> optEnc = name.immediatelyEnclosingClass();
  86         return optEnc.isPresent() && type.getIdentifier().equals(optEnc.get());
  87     }
  88
  89     final CharSequence generateInnerClass(final GeneratedType innerClass) {
  90         if (!(innerClass instanceof GeneratedTransferObject)) {
  91             return "";
  92         }
  93
  94         final GeneratedTransferObject gto = (GeneratedTransferObject) innerClass;
  95         final NestedJavaGeneratedType innerJavaType = javaType.getEnclosedType(innerClass.getIdentifier());
  96         return gto.isUnionType() ? new UnionTemplate(innerJavaType, gto).generateAsInnerClass()
  97                 : new ClassTemplate(innerJavaType, gto).generateAsInnerClass();
  98     }
  99
 100     /**
 101      * Return imported name of java.util class, whose hashCode/equals methods we want to invoke on the property. Returns
 102      * {@link Arrays} if the property is an array, {@link Objects} otherwise.
 103      *
 104      * @param property Generated property
 105      * @return Imported class name
 106      */
 107     final String importedUtilClass(final GeneratedProperty property) {
 108         return importedName(property.getReturnType().getName().indexOf('[') != -1 ? Arrays.class : Objects.class);
 109     }
 110
 111     static final Restrictions restrictionsForSetter(final Type actualType) {
 112         return actualType instanceof GeneratedType ? null : getRestrictions(actualType);
 113     }
 114
 115     static final Restrictions getRestrictions(final Type type) {
 116         if (type instanceof ConcreteType) {
 117             return ((ConcreteType) type).getRestrictions();
 118         }
 119         if (type instanceof GeneratedTransferObject) {
 120             return ((GeneratedTransferObject) type).getRestrictions();
 121         }
 122         return null;
 123     }
 124 }