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 java.io.File; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 19 | import java.io.IOException; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 20 | import java.util.ArrayList; |
| 21 | import java.util.HashMap; |
| 22 | import java.util.List; |
| 23 | import java.util.Map; |
| 24 | |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 25 | import org.onosproject.yangutils.datamodel.YangEnum; |
| 26 | import org.onosproject.yangutils.datamodel.YangEnumeration; |
| 27 | import org.onosproject.yangutils.datamodel.YangNode; |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame^] | 28 | import org.onosproject.yangutils.utils.io.YangPluginConfig; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.translator.tojava.javamodel.YangJavaTypeTranslator; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 31 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.datamodel.utils.builtindatatype.YangDataTypes.INT32; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.translator.tojava.GeneratedTempFileType.ENUM_IMPL_MASK; |
| 34 | import static org.onosproject.yangutils.translator.tojava.JavaAttributeInfo.getAttributeInfoForTheData; |
| 35 | import static org.onosproject.yangutils.translator.tojava.utils.JavaCodeSnippetGen.generateEnumAttributeString; |
| 36 | import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGenerator.generateEnumClassFile; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 37 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.createPackage; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getEnumJavaAttribute; |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.utils.UtilConstants.EMPTY_STRING; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 40 | import static org.onosproject.yangutils.utils.UtilConstants.INT; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 41 | import static org.onosproject.yangutils.utils.UtilConstants.REGEX_FOR_FIRST_DIGIT; |
| 42 | import static org.onosproject.yangutils.utils.UtilConstants.YANG_AUTO_PREFIX; |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 43 | import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.closeFile; |
| 44 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getPrefixForIdentifier; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 45 | |
| 46 | /** |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 47 | * Represents implementation of java code fragments temporary implementations. Maintains the temp files required |
| 48 | * specific for enumeration java snippet generation. |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 49 | */ |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 50 | public class TempJavaEnumerationFragmentFiles extends TempJavaFragmentFiles { |
| 51 | |
| 52 | /** |
| 53 | * File name for temporary enum class. |
| 54 | */ |
| 55 | private static final String ENUM_CLASS_TEMP_FILE_NAME = "EnumClass"; |
| 56 | |
| 57 | /** |
| 58 | * File name for enum class file name suffix. |
| 59 | */ |
| 60 | private static final String ENUM_CLASS_FILE_NAME_SUFFIX = EMPTY_STRING; |
| 61 | |
| 62 | /** |
| 63 | * Current enum's value. |
| 64 | */ |
| 65 | private int enumValue; |
| 66 | |
| 67 | /** |
| 68 | * Contains data of enumSet. |
| 69 | */ |
| 70 | private Map<String, Integer> enumStringMap = new HashMap<>(); |
| 71 | |
| 72 | /** |
| 73 | * Contains data of enumSet. |
| 74 | */ |
| 75 | private List<String> enumStringList; |
| 76 | |
| 77 | /** |
| 78 | * Temporary file handle for enum class file. |
| 79 | */ |
| 80 | private File enumClassTempFileHandle; |
| 81 | |
| 82 | /** |
| 83 | * Java file handle for enum class. |
| 84 | */ |
| 85 | private File enumClassJavaFileHandle; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 86 | |
| 87 | /** |
| 88 | * Creates an instance of temporary java code fragment. |
| 89 | * |
| 90 | * @param javaFileInfo generated java file info |
| 91 | * @throws IOException when fails to create new file handle |
| 92 | */ |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame^] | 93 | TempJavaEnumerationFragmentFiles(JavaFileInfoTranslator javaFileInfo) |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 94 | throws IOException { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 95 | |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 96 | super(javaFileInfo); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 97 | setEnumSetJavaMap(new HashMap<>()); |
| 98 | setEnumStringList(new ArrayList<>()); |
| 99 | /* |
| 100 | * Initialize enum when generation file type matches to enum class mask. |
| 101 | */ |
| 102 | addGeneratedTempFile(ENUM_IMPL_MASK); |
| 103 | setEnumClassTempFileHandle(getTemporaryFileHandle(ENUM_CLASS_TEMP_FILE_NAME)); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Returns enum class java file handle. |
| 108 | * |
| 109 | * @return enum class java file handle |
| 110 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 111 | private File getEnumClassJavaFileHandle() { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 112 | return enumClassJavaFileHandle; |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * Sets enum class java file handle. |
| 117 | * |
| 118 | * @param enumClassJavaFileHandle enum class java file handle |
| 119 | */ |
| 120 | private void setEnumClassJavaFileHandle(File enumClassJavaFileHandle) { |
| 121 | this.enumClassJavaFileHandle = enumClassJavaFileHandle; |
| 122 | } |
| 123 | |
| 124 | /** |
| 125 | * Returns enum's value. |
| 126 | * |
| 127 | * @return enum's value |
| 128 | */ |
| 129 | private int getEnumValue() { |
| 130 | return enumValue; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Sets enum's value. |
| 135 | * |
| 136 | * @param enumValue enum's value |
| 137 | */ |
| 138 | private void setEnumValue(int enumValue) { |
| 139 | this.enumValue = enumValue; |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Returns enum set java map. |
| 144 | * |
| 145 | * @return the enum set java map |
| 146 | */ |
| 147 | public Map<String, Integer> getEnumSetJavaMap() { |
| 148 | return enumStringMap; |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * Sets enum set java map. |
| 153 | * |
| 154 | * @param map the enum set java map to set |
| 155 | */ |
| 156 | private void setEnumSetJavaMap(Map<String, Integer> map) { |
| 157 | this.enumStringMap = map; |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Returns temporary file handle for enum class file. |
| 162 | * |
| 163 | * @return temporary file handle for enum class file |
| 164 | */ |
| 165 | public File getEnumClassTempFileHandle() { |
| 166 | return enumClassTempFileHandle; |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Sets temporary file handle for enum class file. |
| 171 | * |
| 172 | * @param enumClassTempFileHandle temporary file handle for enum class file |
| 173 | */ |
| 174 | private void setEnumClassTempFileHandle(File enumClassTempFileHandle) { |
| 175 | this.enumClassTempFileHandle = enumClassTempFileHandle; |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Adds enum class attributes to temporary file. |
| 180 | * |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 181 | * @param curEnumName current YANG enum |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 182 | * @throws IOException when fails to do IO operations. |
| 183 | */ |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 184 | private void addAttributesForEnumClass(String curEnumName, YangPluginConfig pluginConfig) throws IOException { |
| 185 | appendToFile(getEnumClassTempFileHandle(), |
| 186 | generateEnumAttributeString(curEnumName, getEnumValue(), pluginConfig)); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Adds enum attributes to temporary files. |
| 191 | * |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 192 | * @param curNode current YANG node |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 193 | * @param pluginConfig plugin configurations |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 194 | * @throws IOException when fails to do IO operations |
| 195 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 196 | void addEnumAttributeToTempFiles(YangNode curNode, YangPluginConfig pluginConfig) throws IOException { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 197 | |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 198 | super.addJavaSnippetInfoToApplicableTempFiles(getJavaAttributeForEnum(pluginConfig), pluginConfig); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 199 | if (curNode instanceof YangEnumeration) { |
| 200 | YangEnumeration enumeration = (YangEnumeration) curNode; |
| 201 | for (YangEnum curEnum : enumeration.getEnumSet()) { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 202 | String enumName = curEnum.getNamedValue(); |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 203 | String prefixForIdentifier; |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 204 | if (enumName.matches(REGEX_FOR_FIRST_DIGIT)) { |
| 205 | prefixForIdentifier = getPrefixForIdentifier(pluginConfig.getConflictResolver()); |
| 206 | if (prefixForIdentifier != null) { |
| 207 | curEnum.setNamedValue(prefixForIdentifier + enumName); |
| 208 | } else { |
| 209 | curEnum.setNamedValue(YANG_AUTO_PREFIX + enumName); |
| 210 | } |
| 211 | } |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 212 | setEnumValue(curEnum.getValue()); |
| 213 | addToEnumStringList(curEnum.getNamedValue()); |
| 214 | addToEnumSetJavaMap(curEnum.getNamedValue(), curEnum.getValue()); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 215 | addJavaSnippetInfoToApplicableTempFiles(curEnum.getNamedValue(), pluginConfig); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 216 | } |
| 217 | } else { |
| 218 | throw new TranslatorException("current node should be of enumeration type."); |
| 219 | } |
| 220 | } |
| 221 | |
| 222 | /** |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 223 | * Returns java attribute for enum class. |
| 224 | * |
| 225 | * @param pluginConfig plugin configurations |
| 226 | * @return java attribute |
| 227 | */ |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 228 | public JavaAttributeInfo getJavaAttributeForEnum(YangPluginConfig pluginConfig) { |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 229 | YangJavaTypeTranslator<?> javaType = new YangJavaTypeTranslator<>(); |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 230 | javaType.setDataType(INT32); |
| 231 | javaType.setDataTypeName(INT); |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 232 | javaType.updateJavaQualifiedInfo(pluginConfig.getConflictResolver()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 233 | return getAttributeInfoForTheData( |
| 234 | javaType.getJavaQualifiedInfo(), |
| 235 | javaType.getDataTypeName(), javaType, |
| 236 | getIsQualifiedAccessOrAddToImportList(javaType.getJavaQualifiedInfo()), |
| 237 | false); |
| 238 | } |
| 239 | |
| 240 | /** |
| 241 | * Adds current enum name to java list. |
| 242 | * |
| 243 | * @param curEnumName current enum name |
| 244 | */ |
| 245 | private void addToEnumSetJavaMap(String curEnumName, int value) { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 246 | getEnumSetJavaMap().put(getEnumJavaAttribute(curEnumName).toUpperCase(), value); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 247 | } |
| 248 | |
| 249 | /** |
| 250 | * Adds the new attribute info to the target generated temporary files. |
| 251 | * |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 252 | * @param curEnumName the attribute name that needs to be added to temporary files |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 253 | * @throws IOException IO operation fail |
| 254 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 255 | private void addJavaSnippetInfoToApplicableTempFiles(String curEnumName, YangPluginConfig pluginConfig) |
Bharat saraswal | 715d3fc | 2016-05-17 19:59:16 +0530 | [diff] [blame] | 256 | throws IOException { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 257 | addAttributesForEnumClass(getEnumJavaAttribute(curEnumName), pluginConfig); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | /** |
| 261 | * Constructs java code exit. |
| 262 | * |
| 263 | * @param fileType generated file type |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 264 | * @param curNode current YANG node |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 265 | * @throws IOException when fails to generate java files |
| 266 | */ |
| 267 | @Override |
| 268 | public void generateJavaFile(int fileType, YangNode curNode) throws IOException { |
| 269 | createPackage(curNode); |
| 270 | setEnumClassJavaFileHandle(getJavaFileHandle(getJavaClassName(ENUM_CLASS_FILE_NAME_SUFFIX))); |
| 271 | setEnumClassJavaFileHandle(generateEnumClassFile(getEnumClassJavaFileHandle(), curNode)); |
| 272 | freeTemporaryResources(false); |
| 273 | } |
| 274 | |
| 275 | /** |
| 276 | * Removes all temporary file handles. |
| 277 | * |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 278 | * @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] | 279 | * @throws IOException when failed to delete the temporary files |
| 280 | */ |
| 281 | @Override |
| 282 | public void freeTemporaryResources(boolean isErrorOccurred) throws IOException { |
| 283 | closeFile(getEnumClassJavaFileHandle(), isErrorOccurred); |
| 284 | closeFile(getEnumClassTempFileHandle(), true); |
| 285 | super.freeTemporaryResources(isErrorOccurred); |
| 286 | } |
| 287 | |
| 288 | /** |
| 289 | * Adds to enum string list. |
| 290 | * |
| 291 | * @param curEnumValue current enum value |
| 292 | */ |
| 293 | private void addToEnumStringList(String curEnumValue) { |
janani b | 3e357f6 | 2016-05-19 17:39:50 +0530 | [diff] [blame] | 294 | getEnumStringList().add(getEnumJavaAttribute(curEnumValue).toUpperCase()); |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 295 | } |
| 296 | |
| 297 | /** |
| 298 | * Returns enum string list. |
| 299 | * |
| 300 | * @return the enumStringList |
| 301 | */ |
| 302 | public List<String> getEnumStringList() { |
| 303 | return enumStringList; |
| 304 | } |
| 305 | |
| 306 | /** |
| 307 | * Sets enum string list. |
| 308 | * |
| 309 | * @param enumStringList the enumStringList to set |
| 310 | */ |
Bharat saraswal | 64e7e23 | 2016-07-14 23:33:55 +0530 | [diff] [blame] | 311 | private void setEnumStringList(List<String> enumStringList) { |
Bharat saraswal | 250a747 | 2016-05-12 13:16:57 +0530 | [diff] [blame] | 312 | this.enumStringList = enumStringList; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 313 | } |
| 314 | } |