binding2/mdsal-binding2-java-api-generator/src/main/java/org/opendaylight/mdsal/binding/javav2/java/api/generator/renderers/ClassRenderer.java

   1 /*
   2  * Copyright (c) 2017 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
   9 package org.opendaylight.mdsal.binding.javav2.java.api.generator.renderers;
  10
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.mdsal.binding.javav2.java.api.generator.util.TextTemplateUtil.fieldName;
  13 import static org.opendaylight.mdsal.binding.javav2.java.api.generator.util.TextTemplateUtil.setterMethod;
  14
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.collect.Collections2;
  17 import com.google.common.collect.ImmutableList;
  18 import com.google.common.collect.Lists;
  19 import com.google.common.io.BaseEncoding;
  20
  21 import java.beans.ConstructorProperties;
  22 import java.util.ArrayList;
  23 import java.util.Arrays;
  24 import java.util.Collection;
  25 import java.util.Comparator;
  26 import java.util.LinkedList;
  27 import java.util.List;
  28 import java.util.Objects;
  29
  30 import org.opendaylight.mdsal.binding.javav2.java.api.generator.range_generators.AbstractRangeGenerator;
  31 import org.opendaylight.mdsal.binding.javav2.java.api.generator.range_generators.LengthGenerator;
  32 import org.opendaylight.mdsal.binding.javav2.java.api.generator.txt.classTemplate;
  33 import org.opendaylight.mdsal.binding.javav2.java.api.generator.txt.classTemplateConstructors;
  34 import org.opendaylight.mdsal.binding.javav2.java.api.generator.txt.classTemplateRestrictions;
  35 import org.opendaylight.mdsal.binding.javav2.java.api.generator.txt.classTemplateUnionConstr;
  36 import org.opendaylight.mdsal.binding.javav2.java.api.generator.txt.constantsTemplate;
  37 import org.opendaylight.mdsal.binding.javav2.model.api.Constant;
  38 import org.opendaylight.mdsal.binding.javav2.model.api.Enumeration;
  39 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedProperty;
  40 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedTransferObject;
  41 import org.opendaylight.mdsal.binding.javav2.model.api.GeneratedType;
  42 import org.opendaylight.mdsal.binding.javav2.model.api.Restrictions;
  43 import org.opendaylight.mdsal.binding.javav2.model.api.Type;
  44 import org.opendaylight.yangtools.yang.common.QName;
  45 import org.opendaylight.yangtools.yang.common.Uint16;
  46 import org.opendaylight.yangtools.yang.common.Uint32;
  47 import org.opendaylight.yangtools.yang.common.Uint64;
  48 import org.opendaylight.yangtools.yang.common.Uint8;
  49
  50 public class ClassRenderer extends BaseRenderer {
  51     protected final GeneratedTransferObject genTO;
  52     protected final Restrictions restrictions;
  53     private final List<GeneratedProperty> properties;
  54     private final List<GeneratedProperty> finalProperties;
  55     private final List<GeneratedProperty> parentProperties;
  56     private final List<Enumeration> enums;
  57     private final List<Constant> consts;
  58     private final List<GeneratedType> enclosedGeneratedTypes;
  59     private final List<GeneratedProperty> allProperties;
  60
  61     private final AbstractRangeGenerator<?> rangeGenerator;
  62
  63     public ClassRenderer(final GeneratedTransferObject genType) {
  64         super(genType);
  65         genTO = genType;
  66         properties = ImmutableList.copyOf(genTO.getProperties());
  67         finalProperties = ImmutableList.copyOf(resolveReadOnlyPropertiesFromTO(genTO.getProperties()));
  68         parentProperties = ImmutableList.copyOf(getPropertiesOfAllParents(genTO));
  69         enums = ImmutableList.copyOf(genTO.getEnumerations());
  70         consts = ImmutableList.copyOf(genTO.getConstantDefinitions());
  71         enclosedGeneratedTypes = ImmutableList.copyOf(genTO.getEnclosedTypes());
  72         restrictions = genTO.getRestrictions();
  73
  74         final List<GeneratedProperty> sorted = new ArrayList<>();
  75         sorted.addAll(properties);
  76         sorted.addAll(parentProperties);
  77         final Comparator<GeneratedProperty> function = (GeneratedProperty p1, GeneratedProperty p2) -> {
  78             final String name = p1.getName();
  79             final String name1 = p2.getName();
  80             return name.compareTo(name1);
  81         };
  82         sorted.sort(function);
  83         allProperties = ImmutableList.copyOf(sorted);
  84
  85         if (restrictions != null && restrictions.getRangeConstraint().isPresent()) {
  86             rangeGenerator = AbstractRangeGenerator.forType(findProperty(genType, "value").getReturnType());
  87             requireNonNull(rangeGenerator);
  88         } else {
  89             rangeGenerator = null;
  90         }
  91     }
  92
  93     protected List<GeneratedProperty> getProperties() {
  94         return properties;
  95     }
  96
  97     protected List<GeneratedProperty> getFinalProperties() {
  98         return finalProperties;
  99     }
 100
 101     protected List<GeneratedProperty> getParentProperties() {
 102         return parentProperties;
 103     }
 104
 105     protected List<Enumeration> getEnums() {
 106         return enums;
 107     }
 108
 109     protected List<Constant> getConsts() {
 110         return consts;
 111     }
 112
 113     protected List<GeneratedType> getEnclosedGeneratedTypes() {
 114         return enclosedGeneratedTypes;
 115     }
 116
 117     protected Collection<GeneratedProperty> getAllProperties() {
 118         return allProperties;
 119     }
 120
 121     protected String generateAsInnerClass() {
 122         return generateBody(true);
 123     }
 124
 125     @Override
 126     protected String body() {
 127         return generateBody(false);
 128     }
 129
 130     protected String generateInnerClassBody(final GeneratedTransferObject innerClass) {
 131         final ClassRenderer classRenderer = new ClassRenderer(innerClass);
 132         final String body = classRenderer.generateAsInnerClass();
 133         this.putAllToImportMap(classRenderer.getImportMap());
 134         return body;
 135     }
 136
 137     protected String generateBody(final boolean isInnerClass) {
 138         getImportedNames().put("type", importedName(getType()));
 139         getImportedNames().put("arrays", importedName(Arrays.class));
 140         getImportedNames().put("objects", importedName(Objects.class));
 141         getImportedNames().put("string", importedName(String.class));
 142         getImportedNames().put("byte", importedName(Byte.class));
 143         getImportedNames().put("short", importedName(Short.class));
 144         getImportedNames().put("integer", importedName(Integer.class));
 145         getImportedNames().put("long", importedName(Long.class));
 146         getImportedNames().put("uint8", importedName(Uint8.class));
 147         getImportedNames().put("uint16", importedName(Uint16.class));
 148         getImportedNames().put("uint32", importedName(Uint32.class));
 149         getImportedNames().put("uint64", importedName(Uint64.class));
 150         getImportedNames().put("stringBuilder", importedName(StringBuilder.class));
 151         getImportedNames().put("list", importedName(List.class));
 152         getImportedNames().put("lists", importedName(Lists.class));
 153         getImportedNames().put("illegalArgumentException", importedName(IllegalArgumentException.class));
 154         getImportedNames().put("boolean", importedName(Boolean.class));
 155         getImportedNames().put("qname", importedName(QName.class));
 156
 157         final List<String> implementsListBuilder = new LinkedList<>();
 158         if (!getType().getImplements().isEmpty()) {
 159             for (Type impl : getType().getImplements()) {
 160                 implementsListBuilder.add((importedName(impl)));
 161             }
 162         }
 163         final String implementsList = String.join(", ", implementsListBuilder);
 164
 165         final List<String> classTemplateBuilder = new LinkedList<>();
 166         if (!enclosedGeneratedTypes.isEmpty()) {
 167             for (GeneratedType innerClass : enclosedGeneratedTypes) {
 168                 if (innerClass instanceof GeneratedTransferObject) {
 169                     classTemplateBuilder.add(generateInnerClassBody((GeneratedTransferObject) innerClass));
 170                 }
 171             }
 172         }
 173         final String innerClasses = String.join("\n", classTemplateBuilder);
 174
 175         final List<String> enumList = new LinkedList<>();
 176         if (!enums.isEmpty()) {
 177             for (Enumeration enumeration : enums) {
 178                 enumList.add(new EnumRenderer(enumeration).body());
 179             }
 180         }
 181         final String enumerations = String.join("\n", enumList);
 182
 183         final String constants = constantsTemplate.render(getType(), getImportedNames(), this::importedName, false)
 184                 .body();
 185
 186         if (genTO.getSuperType() != null) {
 187             getImportedNames().put("superType", importedName(genTO.getSuperType()));
 188         }
 189
 190         for (GeneratedProperty property : properties) {
 191             getImportedNames().put(property.getReturnType().toString(), importedName(property.getReturnType()));
 192         }
 193
 194         final String constructors = generateConstructors();
 195
 196         final StringBuilder lengthRangeCheckerBuilder = new StringBuilder();
 197         if (restrictions != null) {
 198             if (restrictions.getLengthConstraint().isPresent()) {
 199                 lengthRangeCheckerBuilder.append(LengthGenerator.generateLengthChecker("_value", findProperty(genTO,
 200                         "value").getReturnType(), restrictions.getLengthConstraint().get()))
 201                         .append("\n");
 202             }
 203             if (restrictions.getRangeConstraint().isPresent()) {
 204                 lengthRangeCheckerBuilder.append(rangeGenerator.generateRangeChecker("_value", restrictions
 205                         .getRangeConstraint().get()))
 206                         .append("\n");
 207             }
 208         }
 209         final String lengthRangeChecker = lengthRangeCheckerBuilder.toString();
 210
 211         final StringBuilder sb2 = new StringBuilder();
 212         if (!properties.isEmpty()) {
 213             for (GeneratedProperty property : properties) {
 214                 final String isFinal = property.isReadOnly() ? " final " : " ";
 215                 sb2.append("private")
 216                         .append(isFinal)
 217                         .append(importedName(property.getReturnType()))
 218                         .append(' ')
 219                         .append(fieldName(property))
 220                         .append(";\n");
 221             }
 222         }
 223         final String fields = sb2.toString();
 224         getImportedNames().put("baseEncoding", importedName(BaseEncoding.class));
 225         if (!allProperties.isEmpty()) {
 226             getImportedNames().put("defProp", importedName(((GeneratedProperty) ((List) allProperties).get(0))
 227                     .getReturnType()));
 228         }
 229
 230         final StringBuilder sb3 = new StringBuilder();
 231         for (GeneratedProperty property : properties) {
 232             sb3.append(getterMethod(property));
 233             if (!property.isReadOnly()) {
 234                 sb3.append(setterMethod(property, getType().getName(), importedName(property
 235                         .getReturnType())));
 236             }
 237         }
 238         final String propertyMethod = sb3.toString();
 239
 240         return classTemplate.render(getType(), genTO, getImportedNames(), implementsList, innerClasses, enumerations,
 241                 constants, constructors, lengthRangeChecker, fields, allProperties, propertyMethod,
 242                 isInnerClass).body();
 243     }
 244
 245     protected String generateConstructors() {
 246         getImportedNames().put("constructorProperties", importedName(ConstructorProperties.class));
 247         getImportedNames().put("preconditions", importedName(Preconditions.class));
 248
 249         final StringBuilder sb1 = new StringBuilder();
 250         for (GeneratedProperty allProperty : allProperties) {
 251             sb1.append(classTemplateRestrictions.render(getType(), fieldName(allProperty), allProperty
 252                     .getReturnType(), rangeGenerator).body());
 253         }
 254         final String genRestrictions = sb1.toString();
 255
 256         final StringBuilder sb2 = new StringBuilder();
 257         if (genTO.isUnionType()) {
 258             for (GeneratedProperty allProperty : allProperties) {
 259                 final List other = new ArrayList<>(properties);
 260                 if (other.remove(allProperty)) {
 261                     sb2.append(classTemplateUnionConstr.render(getType(), parentProperties, allProperty,
 262                             other, importedName(allProperty.getReturnType()), genRestrictions).body());
 263                 }
 264             }
 265         }
 266         final String unionConstructor = sb2.toString();
 267
 268         final String argumentsDeclaration = asArgumentsDeclaration(allProperties);
 269         return classTemplateConstructors.render(genTO, allProperties, properties, parentProperties,
 270                 getImportedNames(), argumentsDeclaration, unionConstructor, genRestrictions).body();
 271     }
 272
 273     /**
 274      * Selects from input list of properties only those which have read only
 275      * attribute set to true.
 276      *
 277      * @param props list of properties of generated transfer object
 278      * @return subset of <code>properties</code> which have read only attribute
 279      *      set to true
 280      */
 281     private List<GeneratedProperty> resolveReadOnlyPropertiesFromTO(final List<GeneratedProperty> props) {
 282         return new ArrayList<>(Collections2.filter(props, GeneratedProperty::isReadOnly));
 283     }
 284
 285     /**
 286      * Returns the list of the read only properties of all extending generated
 287      * transfer object from <code>genTO</code> to highest parent generated
 288      * transfer object.
 289      *
 290      * @param transferObject generated transfer object for which is the list of read only
 291      *                       properties generated
 292      * @return list of all read only properties from actual to highest parent
 293      *      generated transfer object. In case when extension exists the
 294      *      method is recursive called.
 295      */
 296     private List<GeneratedProperty> getPropertiesOfAllParents(final GeneratedTransferObject transferObject) {
 297         final List<GeneratedProperty> propertiesOfAllParents = new ArrayList<>();
 298         if (transferObject.getSuperType() != null) {
 299             final List<GeneratedProperty> allPropertiesOfTO = transferObject.getSuperType().getProperties();
 300             List<GeneratedProperty> readOnlyPropertiesOfTO = resolveReadOnlyPropertiesFromTO(allPropertiesOfTO);
 301             propertiesOfAllParents.addAll(readOnlyPropertiesOfTO);
 302             propertiesOfAllParents.addAll(getPropertiesOfAllParents(transferObject.getSuperType()));
 303         }
 304         return propertiesOfAllParents;
 305     }
 306 }