code-generator/binding-java-api-generator/src/main/java/org/opendaylight/yangtools/sal/java/api/generator/GeneratorJavaFile.java

   1 /*
   2  * Copyright (c) 2013 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 package org.opendaylight.yangtools.sal.java.api.generator;
   9
  10 import java.io.BufferedWriter;
  11 import java.io.File;
  12 import java.io.FileWriter;
  13 import java.io.IOException;
  14 import java.io.Writer;
  15 import java.util.ArrayList;
  16 import java.util.HashSet;
  17 import java.util.List;
  18 import java.util.Set;
  19
  20 import org.opendaylight.yangtools.sal.binding.model.api.CodeGenerator;
  21 import org.opendaylight.yangtools.sal.binding.model.api.Enumeration;
  22 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedTransferObject;
  23 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
  24 import org.opendaylight.yangtools.sal.binding.model.api.Type;
  25 import org.opendaylight.yangtools.yang.binding.Augmentable;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 public final class GeneratorJavaFile {
  30
  31     private static final Logger log = LoggerFactory.getLogger(GeneratorJavaFile.class);
  32     private final CodeGenerator interfaceGenerator;
  33     private final ClassGenerator classGenerator;
  34     private final EnumGenerator enumGenerator;
  35     private final BuilderGenerator builderGenerator;
  36
  37     private final Set<GeneratedType> genTypes;
  38     private final Set<GeneratedTransferObject> genTransferObjects;
  39     private final Set<Enumeration> enumerations;
  40
  41     public GeneratorJavaFile(final CodeGenerator codeGenerator, final Set<GeneratedType> types) {
  42         this.interfaceGenerator = codeGenerator;
  43         this.genTypes = types;
  44         this.genTransferObjects = new HashSet<>();
  45         this.enumerations = new HashSet<>();
  46         this.classGenerator = new ClassGenerator();
  47         this.enumGenerator = new EnumGenerator();
  48         this.builderGenerator = new BuilderGenerator();
  49     }
  50
  51     public GeneratorJavaFile(final Set<GeneratedType> types, final Set<GeneratedTransferObject> genTransferObjects,
  52             final Set<Enumeration> enumerations) {
  53         this.interfaceGenerator = new InterfaceGenerator();
  54         this.classGenerator = new ClassGenerator();
  55         this.enumGenerator = new EnumGenerator();
  56         this.builderGenerator = new BuilderGenerator();
  57
  58         this.genTypes = types;
  59         this.genTransferObjects = genTransferObjects;
  60         this.enumerations = enumerations;
  61     }
  62
  63     public List<File> generateToFile(final File parentDirectory) throws IOException {
  64         final List<File> result = new ArrayList<>();
  65         for (GeneratedType type : genTypes) {
  66             final File genFile = generateTypeToJavaFile(parentDirectory, type, interfaceGenerator, "");
  67             if (genFile != null) {
  68                 result.add(genFile);
  69             }
  70             if (genFile != null) {
  71                 result.add(genFile);
  72             }
  73             // "rpc" and "grouping" elements do not implement Augmentable interface
  74             if (isAugmentableIfcImplemented(type)) {
  75                 final File genBuilderFile = generateTypeToJavaFile(parentDirectory, type, builderGenerator,
  76                         BuilderGenerator.FILE_NAME_SUFFIX);
  77                 if (genBuilderFile != null) {
  78                     result.add(genBuilderFile);
  79                 }
  80             }
  81         }
  82         for (GeneratedTransferObject transferObject : genTransferObjects) {
  83             final File genFile = generateTypeToJavaFile(parentDirectory, transferObject, classGenerator, "");
  84
  85             if (genFile != null) {
  86                 result.add(genFile);
  87             }
  88         }
  89
  90         for (Enumeration enumeration : enumerations) {
  91             final File genFile = generateTypeToJavaFile(parentDirectory, enumeration, enumGenerator, "");
  92
  93             if (genFile != null) {
  94                 result.add(genFile);
  95             }
  96         }
  97
  98         return result;
  99     }
 100
 101     private File generateTypeToJavaFile(final File parentDir, final Type type, final CodeGenerator generator, String fileNameSuffix)
 102             throws IOException {
 103         if (parentDir == null) {
 104             log.warn("Parent Directory not specified, files will be generated "
 105                     + "accordingly to generated Type package path.");
 106         }
 107         if (type == null) {
 108             log.error("Cannot generate Type into Java File because " + "Generated Type is NULL!");
 109             throw new IllegalArgumentException("Generated Type Cannot be NULL!");
 110         }
 111         if (generator == null) {
 112             log.error("Cannot generate Type into Java File because " + "Code Generator instance is NULL!");
 113             throw new IllegalArgumentException("Code Generator Cannot be NULL!");
 114         }
 115         final File packageDir = packageToDirectory(parentDir, type.getPackageName());
 116
 117         if (!packageDir.exists()) {
 118             packageDir.mkdirs();
 119         }
 120         final File file = new File(packageDir, type.getName() + fileNameSuffix + ".java");
 121         try (final FileWriter fw = new FileWriter(file)) {
 122             file.createNewFile();
 123
 124             try (final BufferedWriter bw = new BufferedWriter(fw)) {
 125                 Writer writer = generator.generate(type);
 126                 bw.write(writer.toString());
 127             }
 128         } catch (IOException e) {
 129             log.error(e.getMessage());
 130             throw new IOException(e.getMessage());
 131         }
 132         return file;
 133     }
 134
 135     private boolean isAugmentableIfcImplemented(GeneratedType genType) {
 136         for (Type implType : genType.getImplements()) {
 137             if (implType.getFullyQualifiedName().equals(Augmentable.class.getName())) {
 138                 return true;
 139             }
 140         }
 141         return false;
 142     }
 143
 144     private File packageToDirectory(final File parentDirectory, final String packageName) {
 145         if (packageName == null) {
 146             throw new IllegalArgumentException("Package Name cannot be NULL!");
 147         }
 148
 149         final String[] subDirNames = packageName.split("\\.");
 150         final StringBuilder dirPathBuilder = new StringBuilder();
 151         dirPathBuilder.append(subDirNames[0]);
 152         for (int i = 1; i < subDirNames.length; ++i) {
 153             dirPathBuilder.append(File.separator);
 154             dirPathBuilder.append(subDirNames[i]);
 155         }
 156         return new File(parentDirectory, dirPathBuilder.toString());
 157     }
 158 }