Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +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.translator.tojava.utils; |
| 18 | |
| 19 | import java.io.File; |
| 20 | import java.io.IOException; |
| 21 | import java.util.List; |
| 22 | |
| 23 | import org.onosproject.yangutils.datamodel.YangNode; |
| 24 | import org.onosproject.yangutils.translator.tojava.HasTempJavaCodeFragmentFiles; |
| 25 | import org.onosproject.yangutils.translator.tojava.JavaFileInfo; |
| 26 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
| 27 | import org.onosproject.yangutils.utils.io.impl.CopyrightHeader; |
| 28 | import org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType; |
| 29 | |
| 30 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.BUILDER_CLASS_MASK; |
| 31 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.BUILDER_INTERFACE_MASK; |
| 32 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_TYPEDEF_CLASS; |
| 33 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.IMPL_CLASS_MASK; |
| 34 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.INTERFACE_MASK; |
| 35 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.ATTRIBUTES_MASK; |
| 36 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.CONSTRUCTOR_IMPL_MASK; |
| 37 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.EQUALS_IMPL_MASK; |
| 38 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.GETTER_FOR_CLASS_MASK; |
| 39 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.GETTER_FOR_INTERFACE_MASK; |
| 40 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.HASH_CODE_IMPL_MASK; |
| 41 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.SETTER_FOR_CLASS_MASK; |
| 42 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.SETTER_FOR_INTERFACE_MASK; |
| 43 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.TO_STRING_IMPL_MASK; |
| 44 | import static org.onosproject.yangutils.translator.tojava.utils.JavaCodeSnippetGen.getJavaClassDefStart; |
| 45 | import static org.onosproject.yangutils.utils.UtilConstants.NEW_LINE; |
| 46 | import static org.onosproject.yangutils.utils.UtilConstants.ORG; |
| 47 | import static org.onosproject.yangutils.utils.UtilConstants.PACKAGE; |
| 48 | import static org.onosproject.yangutils.utils.UtilConstants.SEMI_COLAN; |
| 49 | import static org.onosproject.yangutils.utils.UtilConstants.SLASH; |
| 50 | import static org.onosproject.yangutils.utils.UtilConstants.SPACE; |
| 51 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.getJavaDoc; |
| 52 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILDER_CLASS; |
| 53 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.BUILDER_INTERFACE; |
| 54 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.IMPL_CLASS; |
| 55 | import static org.onosproject.yangutils.utils.io.impl.JavaDocGen.JavaDocType.INTERFACE; |
| 56 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.convertPathToPkg; |
| 57 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.insertDataIntoJavaFile; |
| 58 | |
| 59 | /** |
| 60 | * Provides utilities for java file generator. |
| 61 | */ |
| 62 | public final class JavaFileGeneratorUtils { |
| 63 | |
| 64 | /** |
| 65 | * Default constructor. |
| 66 | */ |
| 67 | private JavaFileGeneratorUtils() { |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Returns a file object for generated file. |
| 72 | * |
| 73 | * @param fileName file name |
| 74 | * @param filePath file package path |
| 75 | * @param extension file extension |
| 76 | * @param handle cached file handle |
| 77 | * @return file object |
| 78 | */ |
| 79 | public static File getFileObject(String filePath, String fileName, String extension, JavaFileInfo handle) { |
| 80 | |
| 81 | return new File(handle.getBaseCodeGenPath() + filePath + SLASH + fileName + extension); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Return data stored in temporary files. |
| 86 | * |
| 87 | * @param generatedTempFiles temporary file types |
| 88 | * @param curNode current YANG node |
| 89 | * @return data stored in temporary files |
| 90 | * @throws IOException when failed to get the data from temporary file handle |
| 91 | */ |
| 92 | public static String getDataFromTempFileHandle(int generatedTempFiles, YangNode curNode) throws IOException { |
| 93 | |
| 94 | TempJavaCodeFragmentFiles tempJavaCodeFragmentFiles = ((HasTempJavaCodeFragmentFiles) curNode) |
| 95 | .getTempJavaCodeFragmentFiles(); |
| 96 | |
| 97 | if ((generatedTempFiles & ATTRIBUTES_MASK) != 0) { |
| 98 | return tempJavaCodeFragmentFiles |
| 99 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getAttributesTempFileHandle()); |
| 100 | } else if ((generatedTempFiles & GETTER_FOR_INTERFACE_MASK) != 0) { |
| 101 | return tempJavaCodeFragmentFiles |
| 102 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getGetterInterfaceTempFileHandle()); |
| 103 | } else if ((generatedTempFiles & SETTER_FOR_INTERFACE_MASK) != 0) { |
| 104 | return tempJavaCodeFragmentFiles |
| 105 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getSetterInterfaceTempFileHandle()); |
| 106 | } else if ((generatedTempFiles & GETTER_FOR_CLASS_MASK) != 0) { |
| 107 | return tempJavaCodeFragmentFiles |
| 108 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getGetterImplTempFileHandle()); |
| 109 | } else if ((generatedTempFiles & SETTER_FOR_CLASS_MASK) != 0) { |
| 110 | return tempJavaCodeFragmentFiles |
| 111 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getSetterImplTempFileHandle()); |
| 112 | } else if ((generatedTempFiles & CONSTRUCTOR_IMPL_MASK) != 0) { |
| 113 | return tempJavaCodeFragmentFiles |
| 114 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getConstructorImplTempFileHandle()); |
| 115 | } else if ((generatedTempFiles & HASH_CODE_IMPL_MASK) != 0) { |
| 116 | return tempJavaCodeFragmentFiles |
| 117 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getHashCodeImplTempFileHandle()); |
| 118 | } else if ((generatedTempFiles & EQUALS_IMPL_MASK) != 0) { |
| 119 | return tempJavaCodeFragmentFiles |
| 120 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getEqualsImplTempFileHandle()); |
| 121 | } else if ((generatedTempFiles & TO_STRING_IMPL_MASK) != 0) { |
| 122 | return tempJavaCodeFragmentFiles |
| 123 | .getTemporaryDataFromFileHandle(tempJavaCodeFragmentFiles.getToStringImplTempFileHandle()); |
| 124 | } |
| 125 | return null; |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Initiate generation of file based on generated file type. |
| 130 | * |
| 131 | * @param file generated file |
| 132 | * @param className generated file class name |
| 133 | * @param type generated file type |
| 134 | * @param imports imports for the file |
| 135 | * @param pkg generated file package |
| 136 | * @throws IOException when fails to generate a file |
| 137 | */ |
| 138 | public static void initiateJavaFileGeneration(File file, String className, int type, List<String> imports, |
| 139 | String pkg) throws IOException { |
| 140 | |
| 141 | try { |
| 142 | file.createNewFile(); |
| 143 | appendContents(file, className, type, imports, pkg); |
| 144 | } catch (IOException e) { |
| 145 | throw new IOException("Failed to create " + file.getName() + " class file."); |
| 146 | } |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * Appends all the contents into a generated java file. |
| 151 | * |
| 152 | * @param file generated file |
| 153 | * @param fileName generated file name |
| 154 | * @param type generated file type |
| 155 | * @param pkg generated file package |
| 156 | * @param importsList list of java imports. |
| 157 | * @throws IOException when fails to append contents |
| 158 | */ |
| 159 | private static void appendContents(File file, String fileName, int type, List<String> importsList, |
| 160 | String pkg) throws IOException { |
| 161 | |
| 162 | String pkgString = parsePackageString(pkg, importsList); |
| 163 | |
| 164 | if ((type & IMPL_CLASS_MASK) != 0) { |
| 165 | |
| 166 | write(file, fileName, type, IMPL_CLASS); |
| 167 | } else if ((type & BUILDER_INTERFACE_MASK) != 0) { |
| 168 | |
| 169 | write(file, fileName, type, BUILDER_INTERFACE); |
| 170 | } else if ((type & GENERATE_TYPEDEF_CLASS) != 0) { |
| 171 | appendHeaderContents(file, pkgString, importsList); |
| 172 | write(file, fileName, type, IMPL_CLASS); |
| 173 | } else if ((type & INTERFACE_MASK) != 0) { |
| 174 | |
| 175 | appendHeaderContents(file, pkgString, importsList); |
| 176 | write(file, fileName, type, INTERFACE); |
| 177 | } else if ((type & BUILDER_CLASS_MASK) != 0) { |
| 178 | |
| 179 | appendHeaderContents(file, pkgString, importsList); |
| 180 | write(file, fileName, type, BUILDER_CLASS); |
| 181 | } |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Removes base directory path from package and generates package string for file. |
| 186 | * |
| 187 | * @param javaPkg generated java package |
| 188 | * @param importsList list of imports |
| 189 | * @return package string |
| 190 | */ |
| 191 | private static String parsePackageString(String javaPkg, List<String> importsList) { |
| 192 | |
| 193 | if (javaPkg.contains(ORG)) { |
| 194 | String[] strArray = javaPkg.split(ORG); |
| 195 | javaPkg = ORG + convertPathToPkg(strArray[1]); |
| 196 | } |
| 197 | if (importsList != null) { |
| 198 | if (!importsList.isEmpty()) { |
| 199 | return PACKAGE + SPACE + javaPkg + SEMI_COLAN + NEW_LINE; |
| 200 | } else { |
| 201 | return PACKAGE + SPACE + javaPkg + SEMI_COLAN; |
| 202 | } |
| 203 | } else { |
| 204 | return PACKAGE + SPACE + javaPkg + SEMI_COLAN; |
| 205 | } |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Appends other contents to interface, builder and typedef classes. |
| 210 | * for example : ONOS copyright, imports and package. |
| 211 | * @param file generated file |
| 212 | * @param pkg generated package |
| 213 | * @param importsList list of imports |
| 214 | * @throws IOException when fails to append contents. |
| 215 | */ |
| 216 | private static void appendHeaderContents(File file, String pkg, List<String> importsList) throws IOException { |
| 217 | |
| 218 | insertDataIntoJavaFile(file, CopyrightHeader.getCopyrightHeader()); |
| 219 | insertDataIntoJavaFile(file, pkg); |
| 220 | |
| 221 | /* |
| 222 | * TODO: add the file header using |
| 223 | * JavaCodeSnippetGen.getFileHeaderComment |
| 224 | */ |
| 225 | |
| 226 | if (importsList != null) { |
| 227 | insertDataIntoJavaFile(file, NEW_LINE); |
| 228 | for (String imports : importsList) { |
| 229 | insertDataIntoJavaFile(file, imports); |
| 230 | } |
| 231 | } |
| 232 | } |
| 233 | |
| 234 | /** |
| 235 | * Write data to the specific generated file. |
| 236 | * |
| 237 | * @param file generated file |
| 238 | * @param fileName file name |
| 239 | * @param genType generated file type |
| 240 | * @param javaDocType java doc type |
| 241 | * @throws IOException when fails to write into a file |
| 242 | */ |
| 243 | private static void write(File file, String fileName, int genType, JavaDocType javaDocType) |
| 244 | throws IOException { |
| 245 | |
| 246 | insertDataIntoJavaFile(file, getJavaDoc(javaDocType, fileName, false)); |
| 247 | insertDataIntoJavaFile(file, getJavaClassDefStart(genType, fileName)); |
| 248 | } |
| 249 | |
| 250 | } |