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