Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present 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 | package org.onosproject.yangutils.translator.tojava; |
| 17 | |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 18 | import org.onosproject.yangutils.datamodel.YangEnum; |
| 19 | import org.onosproject.yangutils.datamodel.YangEnumeration; |
| 20 | import org.onosproject.yangutils.datamodel.YangNode; |
| 21 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.translator.tojava.javamodel.YangJavaTypeTranslator; |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 23 | import org.onosproject.yangutils.utils.io.YangPluginConfig; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 24 | |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 25 | import java.io.File; |
| 26 | import java.io.IOException; |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 27 | import java.util.List; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 28 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 29 | import static org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes.INT32; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.ENUM_IMPL_MASK; |
| 31 | import static org.onosproject.yangutils.translator.tojava.JavaAttributeInfo.getAttributeInfoForTheData; |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.translator.tojava.utils.JavaCodeSnippetGen.generateEnumAttributeStringWithSchemaName; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGenerator.generateEnumClassFile; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.createPackage; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 35 | import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 36 | import static org.onosproject.yangutils.utils.UtilConstants.INT; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_FIRST_DIGIT; |
| 38 | import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUTO_PREFIX; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.closeFile; |
| 40 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getPrefixForIdentifier; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 41 | |
| 42 | /** |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 43 | * Represents implementation of java code fragments temporary implementations. Maintains the temp files required |
| 44 | * specific for enumeration java snippet generation. |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 45 | */ |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 46 | public class TempJavaEnumerationFragmentFiles |
| 47 | extends TempJavaFragmentFiles { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * File name for temporary enum class. |
| 51 | */ |
| 52 | private static final String ENUM_CLASS_TEMP_FILE_NAME = "EnumClass"; |
| 53 | |
| 54 | /** |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 55 | * Temporary file handle for enum class file. |
| 56 | */ |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 57 | private final File enumClassTempFileHandle; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * Java file handle for enum class. |
| 61 | */ |
| 62 | private File enumClassJavaFileHandle; |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 63 | private boolean isEnumClass; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 64 | |
| 65 | /** |
| 66 | * Creates an instance of temporary java code fragment. |
| 67 | * |
| 68 | * @param javaFileInfo generated java file info |
| 69 | * @throws IOException when fails to create new file handle |
| 70 | */ |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 71 | public TempJavaEnumerationFragmentFiles(JavaFileInfoTranslator javaFileInfo) |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 72 | throws IOException { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 73 | |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 74 | super(javaFileInfo); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 75 | /* |
| 76 | * Initialize enum when generation file type matches to enum class mask. |
| 77 | */ |
| 78 | addGeneratedTempFile(ENUM_IMPL_MASK); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 79 | enumClassTempFileHandle = getTemporaryFileHandle(ENUM_CLASS_TEMP_FILE_NAME); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | /** |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 83 | * Returns temporary file handle for enum class file. |
| 84 | * |
| 85 | * @return temporary file handle for enum class file |
| 86 | */ |
| 87 | public File getEnumClassTempFileHandle() { |
| 88 | return enumClassTempFileHandle; |
| 89 | } |
| 90 | |
| 91 | /** |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 92 | * Adds enum class attributes to temporary file. |
| 93 | * |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 94 | * @param yangEnum YANG enum |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 95 | * @throws IOException when fails to do IO operations. |
| 96 | */ |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 97 | private void addAttributesForEnumClass(YangEnum yangEnum) |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 98 | throws IOException { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 99 | appendToFile(enumClassTempFileHandle, |
Bharat saraswal | 748fc3c | 2016-09-06 16:38:20 +0530 | [diff] [blame] | 100 | generateEnumAttributeStringWithSchemaName(yangEnum.getNamedValue(), |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 101 | yangEnum.getValue())); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Adds enum attributes to temporary files. |
| 106 | * |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 107 | * @param curNode current YANG node |
| 108 | * @param config plugin configurations |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 109 | * @throws IOException when fails to do IO operations |
| 110 | */ |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 111 | public void addEnumAttributeToTempFiles(YangNode curNode, |
| 112 | YangPluginConfig config) |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 113 | throws IOException { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 114 | |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 115 | addJavaSnippetInfoToApplicableTempFiles(getJavaAttributeForEnum(config), |
| 116 | config); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 117 | if (curNode instanceof YangEnumeration) { |
| 118 | YangEnumeration enumeration = (YangEnumeration) curNode; |
| 119 | for (YangEnum curEnum : enumeration.getEnumSet()) { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 120 | String enumName = curEnum.getNamedValue(); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 121 | String prefix; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 122 | if (enumName.matches(REGEX_FOR_FIRST_DIGIT)) { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 123 | prefix = getPrefixForIdentifier( |
| 124 | config.getConflictResolver()); |
| 125 | if (prefix != null) { |
| 126 | curEnum.setNamedValue(prefix + enumName); |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 127 | } else { |
| 128 | curEnum.setNamedValue(YANG_AUTO_PREFIX + enumName); |
| 129 | } |
| 130 | } |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 131 | addJavaSnippetInfoToApplicableTempFiles(curEnum); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 132 | } |
| 133 | } else { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 134 | throw new TranslatorException( |
| 135 | "current node should be of enumeration type. " + |
| 136 | curNode.getName() + " in " + curNode.getLineNumber() + |
| 137 | " at " + curNode.getCharPosition() + " in " + curNode |
| 138 | .getFileName()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 139 | } |
| 140 | } |
| 141 | |
| 142 | /** |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 143 | * Returns java attribute for enum class. |
| 144 | * |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 145 | * @param config plugin configurations |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 146 | * @return java attribute |
| 147 | */ |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 148 | private JavaAttributeInfo getJavaAttributeForEnum(YangPluginConfig config) { |
Bharat saraswal | 2da23bf | 2016-08-25 15:28:39 +0530 | [diff] [blame] | 149 | YangJavaTypeTranslator javaType = new YangJavaTypeTranslator(); |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 150 | javaType.setDataType(INT32); |
| 151 | javaType.setDataTypeName(INT); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 152 | javaType.updateJavaQualifiedInfo(config.getConflictResolver()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 153 | return getAttributeInfoForTheData( |
| 154 | javaType.getJavaQualifiedInfo(), |
| 155 | javaType.getDataTypeName(), javaType, |
| 156 | getIsQualifiedAccessOrAddToImportList(javaType.getJavaQualifiedInfo()), |
| 157 | false); |
| 158 | } |
| 159 | |
| 160 | /** |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 161 | * Adds the new attribute info to the target generated temporary files. |
| 162 | * |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 163 | * @param yangEnum @throws IOException IO operation fail |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 164 | */ |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 165 | private void addJavaSnippetInfoToApplicableTempFiles(YangEnum yangEnum) |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 166 | throws IOException { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 167 | addAttributesForEnumClass(yangEnum); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | /** |
| 171 | * Constructs java code exit. |
| 172 | * |
| 173 | * @param fileType generated file type |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 174 | * @param curNode current YANG node |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 175 | * @throws IOException when fails to generate java files |
| 176 | */ |
| 177 | @Override |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 178 | public void generateJavaFile(int fileType, YangNode curNode) |
| 179 | throws IOException { |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 180 | |
| 181 | List<String> imports = this.getJavaImportData().getImports(); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 182 | createPackage(curNode); |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 183 | enumClassJavaFileHandle = getJavaFileHandle(getJavaClassName(EMPTY_STRING)); |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 184 | generateEnumClassFile(enumClassJavaFileHandle, curNode, imports); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 185 | freeTemporaryResources(false); |
| 186 | } |
| 187 | |
| 188 | /** |
| 189 | * Removes all temporary file handles. |
| 190 | * |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 191 | * @param isErrorOccurred flag to tell translator that error has occurred while file generation |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 192 | * @throws IOException when failed to delete the temporary files |
| 193 | */ |
| 194 | @Override |
VinodKumarS-Huawei | 9a91b48 | 2016-08-19 23:22:59 +0530 | [diff] [blame] | 195 | public void freeTemporaryResources(boolean isErrorOccurred) |
| 196 | throws IOException { |
Bharat saraswal | 9fab16b | 2016-09-23 23:27:24 +0530 | [diff] [blame] | 197 | closeFile(enumClassJavaFileHandle, isErrorOccurred); |
| 198 | closeFile(enumClassTempFileHandle, true); |
Bharat saraswal | 54e4bab | 2016-10-05 23:32:14 +0530 | [diff] [blame] | 199 | if (isEnumClass) { |
| 200 | super.freeTemporaryResources(isErrorOccurred); |
| 201 | } |
| 202 | } |
| 203 | |
| 204 | public boolean isEnumClass() { |
| 205 | return isEnumClass; |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Sets true if free super resources is required. |
| 210 | * |
| 211 | * @param enumClass true if free super resources is required |
| 212 | */ |
| 213 | public void setEnumClass(boolean enumClass) { |
| 214 | isEnumClass = enumClass; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 215 | } |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 216 | } |