opendaylight/sal/yang-prototype/code-generator/binding-java-api-generator/src/main/java/org/opendaylight/controller/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.controller.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.controller.sal.binding.model.api.CodeGenerator;
  21 import org.opendaylight.controller.sal.binding.model.api.Enumeration;
  22 import org.opendaylight.controller.sal.binding.model.api.GeneratedTransferObject;
  23 import org.opendaylight.controller.sal.binding.model.api.GeneratedType;
  24 import org.opendaylight.controller.sal.binding.model.api.Type;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 public final class GeneratorJavaFile {
  29
  30     private static final Logger log = LoggerFactory
  31             .getLogger(GeneratorJavaFile.class);
  32     private final CodeGenerator interfaceGenerator;
  33     private final ClassCodeGenerator classGenerator;
  34     private final EnumGenerator enumGenerator;
  35
  36     private final Set<GeneratedType> genTypes;
  37     private final Set<GeneratedTransferObject> genTransferObjects;
  38     private final Set<Enumeration> enumerations;
  39
  40     public GeneratorJavaFile(final CodeGenerator codeGenerator,
  41             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 ClassCodeGenerator();
  47         this.enumGenerator = new EnumGenerator();
  48     }
  49
  50     public GeneratorJavaFile(final Set<GeneratedType> types,
  51             final Set<GeneratedTransferObject> genTransferObjects,
  52             final Set<Enumeration> enumerations) {
  53         this.interfaceGenerator = new InterfaceGenerator();
  54         this.classGenerator = new ClassCodeGenerator();
  55         this.enumGenerator = new EnumGenerator();
  56
  57         this.genTypes = types;
  58         this.genTransferObjects = genTransferObjects;
  59         this.enumerations = enumerations;
  60     }
  61
  62     public List<File> generateToFile(final File parentDirectory) throws IOException {
  63         final List<File> result = new ArrayList<>();
  64         for (GeneratedType type : genTypes) {
  65             final File genFile = generateTypeToJavaFile(parentDirectory, type,
  66                     interfaceGenerator);
  67
  68             if (genFile != null) {
  69                 result.add(genFile);
  70             }
  71         }
  72         for (GeneratedTransferObject transferObject : genTransferObjects) {
  73             final File genFile = generateTypeToJavaFile(parentDirectory,
  74                     transferObject, classGenerator);
  75
  76             if (genFile != null) {
  77                 result.add(genFile);
  78             }
  79         }
  80
  81         for (Enumeration enumeration : enumerations) {
  82             final File genFile = generateTypeToJavaFile(parentDirectory,
  83                     enumeration, enumGenerator);
  84
  85             if (genFile != null) {
  86                 result.add(genFile);
  87             }
  88         }
  89
  90         return result;
  91     }
  92
  93     private File generateTypeToJavaFile(final File parentDir, final Type type,
  94             final CodeGenerator generator) throws IOException {
  95         if (parentDir == null) {
  96             log.warn("Parent Directory not specified, files will be generated "
  97                     + "accordingly to generated Type package path.");
  98         }
  99         if (type == null) {
 100             log.error("Cannot generate Type into Java File because " +
 101                         "Generated Type is NULL!");
 102             throw new IllegalArgumentException("Generated Type Cannot be NULL!");
 103         }
 104         if (generator == null) {
 105             log.error("Cannot generate Type into Java File because " +
 106                         "Code Generator instance is NULL!");
 107             throw new IllegalArgumentException("Code Generator Cannot be NULL!");
 108         }
 109         final File packageDir = packageToDirectory(parentDir,
 110                 type.getPackageName());
 111
 112         if (!packageDir.exists()) {
 113             packageDir.mkdirs();
 114         }
 115         final File file = new File(packageDir, type.getName() + ".java");
 116         try (final FileWriter fw = new FileWriter(file)) {
 117             file.createNewFile();
 118
 119             try (final BufferedWriter bw = new BufferedWriter(fw)) {
 120                 Writer writer = generator.generate(type);
 121                 bw.write(writer.toString());
 122             }
 123         } catch (IOException e) {
 124             log.error(e.getMessage());
 125             throw new IOException(e.getMessage());
 126         }
 127         return file;
 128     }
 129
 130     private File packageToDirectory(final File parentDirectory,
 131             final String packageName) {
 132         if (packageName == null) {
 133             throw new IllegalArgumentException("Package Name cannot be NULL!");
 134         }
 135
 136         final String[] subDirNames = packageName.split("\\.");
 137         final StringBuilder dirPathBuilder = new StringBuilder();
 138         dirPathBuilder.append(subDirNames[0]);
 139         for (int i = 1; i < subDirNames.length; ++i) {
 140             dirPathBuilder.append(File.separator);
 141             dirPathBuilder.append(subDirNames[i]);
 142         }
 143         return new File(parentDirectory, dirPathBuilder.toString());
 144     }
 145 }