Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.yangutils.utils.io.impl; |
| 18 | |
| 19 | import java.io.BufferedWriter; |
| 20 | import java.io.File; |
| 21 | import java.io.FileWriter; |
| 22 | import java.io.IOException; |
| 23 | import java.util.List; |
| 24 | |
| 25 | import org.sonatype.plexus.build.incremental.BuildContext; |
| 26 | import org.apache.maven.project.MavenProject; |
| 27 | import org.apache.maven.model.Resource; |
| 28 | |
| 29 | import org.onosproject.yangutils.utils.UtilConstants; |
Bharat saraswal | 5e3c45c | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 30 | import org.apache.commons.io.FileUtils; |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 31 | |
| 32 | import static org.slf4j.LoggerFactory.getLogger; |
| 33 | import org.slf4j.Logger; |
| 34 | |
| 35 | /** |
| 36 | * Provides common utility functionalities for code generation. |
| 37 | */ |
| 38 | public final class YangIoUtils { |
| 39 | |
| 40 | private static final Logger log = getLogger(YangIoUtils.class); |
| 41 | |
| 42 | /** |
| 43 | * Default constructor. |
| 44 | */ |
| 45 | private YangIoUtils() { |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Creates the directory structure. |
| 50 | * |
| 51 | * @param path directory path |
| 52 | * @return directory structure |
| 53 | */ |
| 54 | public static File createDirectories(String path) { |
| 55 | |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 56 | File generatedDir = new File(path); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 57 | generatedDir.mkdirs(); |
| 58 | return generatedDir; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Adds package info file for the created directory. |
| 63 | * |
| 64 | * @param path directory path |
| 65 | * @param classInfo class info for the package |
| 66 | * @param pack package of the directory |
| 67 | * @throws IOException when fails to create package info file. |
| 68 | */ |
| 69 | public static void addPackageInfo(File path, String classInfo, String pack) throws IOException { |
| 70 | |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 71 | if (pack.contains(UtilConstants.YANG_GEN_DIR)) { |
Bharat saraswal | c46ee2a | 2016-02-25 02:26:43 +0530 | [diff] [blame] | 72 | String[] strArray = pack.split(UtilConstants.YANG_GEN_DIR); |
| 73 | pack = strArray[1]; |
| 74 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 75 | try { |
| 76 | |
| 77 | File packageInfo = new File(path + File.separator + "package-info.java"); |
| 78 | packageInfo.createNewFile(); |
b.janani | 66b749c | 2016-02-24 12:23:03 +0530 | [diff] [blame] | 79 | FileWriter fileWriter = null; |
| 80 | BufferedWriter bufferedWriter = null; |
| 81 | fileWriter = new FileWriter(packageInfo); |
| 82 | bufferedWriter = new BufferedWriter(fileWriter); |
| 83 | bufferedWriter.write(CopyrightHeader.getCopyrightHeader()); |
| 84 | bufferedWriter.write(JavaDocGen.getJavaDoc(JavaDocGen.JavaDocType.PACKAGE_INFO, classInfo)); |
| 85 | bufferedWriter.write(UtilConstants.PACKAGE + UtilConstants.SPACE + pack + UtilConstants.SEMI_COLAN); |
| 86 | bufferedWriter.close(); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 87 | } catch (IOException e) { |
| 88 | throw new IOException("Exception occured while creating package info file."); |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Cleans the generated directory if already exist in source folder. |
| 94 | * |
| 95 | * @param baseDir generated directory in previous build. |
| 96 | */ |
| 97 | public static void clean(String baseDir) { |
| 98 | File generatedDirectory = new File(baseDir + File.separator + UtilConstants.YANG_GEN_DIR); |
| 99 | if (generatedDirectory.exists()) { |
| 100 | List<String> javafiles; |
| 101 | try { |
| 102 | javafiles = YangFileScanner.getJavaFiles(generatedDirectory.toString()); |
| 103 | for (String file : javafiles) { |
| 104 | File currentFile = new File(file); |
| 105 | currentFile.delete(); |
| 106 | } |
Bharat saraswal | 5e3c45c | 2016-02-22 22:15:21 +0530 | [diff] [blame] | 107 | FileUtils.deleteDirectory(generatedDirectory); |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 108 | } catch (IOException e) { |
| 109 | log.info("Failed to delete the generated files in " + generatedDirectory + " directory"); |
| 110 | } |
Bharat saraswal | 9745996 | 2016-02-20 21:57:16 +0530 | [diff] [blame] | 111 | } |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * Adds generated source directory to the compilation root. |
| 116 | * |
| 117 | * @param source directory |
| 118 | * @param project current maven project |
| 119 | * @param context current build context |
| 120 | */ |
| 121 | public static void addToSource(String source, MavenProject project, BuildContext context) { |
| 122 | |
| 123 | project.addCompileSourceRoot(source); |
| 124 | Resource rsc = new Resource(); |
| 125 | rsc.setDirectory(source); |
| 126 | project.addResource(rsc); |
| 127 | context.refresh(project.getBasedir()); |
| 128 | log.info("Source directory added to compilation root: " + source); |
| 129 | } |
| 130 | |
| 131 | } |