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