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.List;
  15 import java.util.Map;
  16 import java.util.Objects;
  17 import java.util.Optional;
  18 import java.util.regex.Pattern;
  19 import java.util.stream.Collectors;
  20 import org.opendaylight.mdsal.binding.model.api.ConcreteType;
  21 import org.opendaylight.mdsal.binding.model.api.GeneratedProperty;
  22 import org.opendaylight.mdsal.binding.model.api.GeneratedTransferObject;
  23 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
  24 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  25 import org.opendaylight.mdsal.binding.model.api.ParameterizedType;
  26 import org.opendaylight.mdsal.binding.model.api.Restrictions;
  27 import org.opendaylight.mdsal.binding.model.api.Type;
  28 import org.opendaylight.mdsal.binding.model.util.Types;
  29 import org.opendaylight.yangtools.yang.binding.CodeHelpers;
  30
  31 /**
  32  * Base Java file template. Contains a non-null type and imports which the generated code refers to.
  33  */
  34 class JavaFileTemplate {
  35     /**
  36      * {@code java.lang.Class} as a JavaTypeName.
  37      */
  38     static final JavaTypeName CLASS = JavaTypeName.create(Class.class);
  39     /**
  40      * {@code java.lang.Deprecated} as a JavaTypeName.
  41      */
  42     static final JavaTypeName DEPRECATED = JavaTypeName.create(Deprecated.class);
  43     /**
  44      * {@code java.lang.Override} as a JavaTypeName.
  45      */
  46     static final JavaTypeName OVERRIDE = JavaTypeName.create(Override.class);
  47
  48     /**
  49      * {@code java.lang.SuppressWarnings} as a JavaTypeName.
  50      */
  51     static final JavaTypeName SUPPRESS_WARNINGS = JavaTypeName.create(SuppressWarnings.class);
  52
  53     /**
  54      * {@code java.util.Arrays} as a JavaTypeName.
  55      */
  56     static final JavaTypeName JU_ARRAYS = JavaTypeName.create(Arrays.class);
  57     /**
  58      * {@code java.util.List} as a JavaTypeName.
  59      */
  60     static final JavaTypeName JU_LIST = JavaTypeName.create(List.class);
  61     /**
  62      * {@code java.util.Map} as a JavaTypeName.
  63      */
  64     static final JavaTypeName JU_MAP = JavaTypeName.create(Map.class);
  65     /**
  66      * {@code java.util.Objects} as a JavaTypeName.
  67      */
  68     static final JavaTypeName JU_OBJECTS = JavaTypeName.create(Objects.class);
  69     /**
  70      * {@code java.util.regex.Pattern} as a JavaTypeName.
  71      */
  72     static final JavaTypeName JUR_PATTERN = JavaTypeName.create(Pattern.class);
  73
  74     /**
  75      * {@code org.eclipse.jdt.annotation.NonNull} as a JavaTypeName.
  76      */
  77     static final JavaTypeName NONNULL = JavaTypeName.create("org.eclipse.jdt.annotation", "NonNull");
  78     /**
  79      * {@code org.eclipse.jdt.annotation.Nullable} as a JavaTypeName.
  80      */
  81     static final JavaTypeName NULLABLE = JavaTypeName.create("org.eclipse.jdt.annotation", "Nullable");
  82
  83     /**
  84      * {@code org.opendaylight.yangtools.yang.binding.CodeHelpers} as a JavaTypeName.
  85      */
  86     static final JavaTypeName CODEHELPERS = JavaTypeName.create(CodeHelpers.class);
  87
  88     private final AbstractJavaGeneratedType javaType;
  89     private final GeneratedType type;
  90
  91     JavaFileTemplate(final GeneratedType type) {
  92         this(new TopLevelJavaGeneratedType(type), type);
  93     }
  94
  95     JavaFileTemplate(final AbstractJavaGeneratedType javaType, final GeneratedType type) {
  96         this.javaType = requireNonNull(javaType);
  97         this.type = requireNonNull(type);
  98     }
  99
 100     final AbstractJavaGeneratedType javaType() {
 101         return javaType;
 102     }
 103
 104     final GeneratedType type() {
 105         return type;
 106     }
 107
 108     final GeneratedProperty findProperty(final GeneratedTransferObject gto, final String name) {
 109         final Optional<GeneratedProperty> optProp = gto.getProperties().stream()
 110                 .filter(prop -> prop.getName().equals(name)).findFirst();
 111         if (optProp.isPresent()) {
 112             return optProp.get();
 113         }
 114
 115         final GeneratedTransferObject parent = gto.getSuperType();
 116         return parent != null ? findProperty(parent, name) : null;
 117     }
 118
 119     final String generateImportBlock() {
 120         verify(javaType instanceof TopLevelJavaGeneratedType);
 121         return ((TopLevelJavaGeneratedType) javaType).imports().map(name -> "import " + name + ";\n")
 122                 .collect(Collectors.joining());
 123     }
 124
 125     final String importedJavadocName(final Type intype) {
 126         return importedName(intype instanceof ParameterizedType ? ((ParameterizedType) intype).getRawType() : intype);
 127     }
 128
 129     final String importedName(final Type intype) {
 130         return javaType.getReferenceString(intype);
 131     }
 132
 133     final String importedName(final Type intype, final String... annotations) {
 134         return javaType.getReferenceString(intype, annotations);
 135     }
 136
 137     final String importedName(final Class<?> cls) {
 138         return importedName(Types.typeForClass(cls));
 139     }
 140
 141     final String importedName(final JavaTypeName intype) {
 142         return javaType.getReferenceString(intype);
 143     }
 144
 145     final String importedNonNull(final Type intype) {
 146         return importedName(intype, importedName(NONNULL));
 147     }
 148
 149     final String importedNullable(final Type intype) {
 150         return importedName(intype, importedName(NULLABLE));
 151     }
 152
 153     final void addImport(final Class<?> cls) {
 154         javaType.getReferenceString(JavaTypeName.create(cls));
 155     }
 156
 157     // Exposed for BuilderTemplate
 158     boolean isLocalInnerClass(final JavaTypeName name) {
 159         final Optional<JavaTypeName> optEnc = name.immediatelyEnclosingClass();
 160         return optEnc.isPresent() && type.getIdentifier().equals(optEnc.get());
 161     }
 162
 163     final CharSequence generateInnerClass(final GeneratedType innerClass) {
 164         if (!(innerClass instanceof GeneratedTransferObject)) {
 165             return "";
 166         }
 167
 168         final GeneratedTransferObject gto = (GeneratedTransferObject) innerClass;
 169         final NestedJavaGeneratedType innerJavaType = javaType.getEnclosedType(innerClass.getIdentifier());
 170         return gto.isUnionType() ? new UnionTemplate(innerJavaType, gto).generateAsInnerClass()
 171                 : new ClassTemplate(innerJavaType, gto).generateAsInnerClass();
 172     }
 173
 174     /**
 175      * Return imported name of java.util class, whose hashCode/equals methods we want to invoke on the property. Returns
 176      * {@link Arrays} if the property is an array, {@link Objects} otherwise.
 177      *
 178      * @param property Generated property
 179      * @return Imported class name
 180      */
 181     final String importedUtilClass(final GeneratedProperty property) {
 182         return importedName(property.getReturnType().getName().indexOf('[') != -1 ? JU_ARRAYS : JU_OBJECTS);
 183     }
 184
 185     static final Restrictions restrictionsForSetter(final Type actualType) {
 186         return actualType instanceof GeneratedType ? null : getRestrictions(actualType);
 187     }
 188
 189     static final Restrictions getRestrictions(final Type type) {
 190         if (type instanceof ConcreteType) {
 191             return ((ConcreteType) type).getRestrictions();
 192         }
 193         if (type instanceof GeneratedTransferObject) {
 194             return ((GeneratedTransferObject) type).getRestrictions();
 195         }
 196         return null;
 197     }
 198 }