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