Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +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 | |
| 17 | package org.onosproject.yangutils.translator.tojava.javamodel; |
| 18 | |
| 19 | import java.io.IOException; |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 20 | |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoTranslator; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.datamodel.javadatamodel.YangJavaEnumeration; |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 23 | import org.onosproject.yangutils.utils.io.YangPluginConfig; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 24 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
| 25 | import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator; |
Gaurav Agrawal | bfce934 | 2016-06-15 13:58:01 +0530 | [diff] [blame] | 26 | import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 27 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 28 | |
| 29 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_ENUM_CLASS; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 30 | import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.generateCodeOfNode; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * Represents YANG java enumeration information extended to support java code generation. |
| 34 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 35 | public class YangJavaEnumerationTranslator |
| 36 | extends YangJavaEnumeration |
Vinod Kumar S | 79a374b | 2016-04-30 21:09:15 +0530 | [diff] [blame] | 37 | implements JavaCodeGenerator, JavaCodeGeneratorInfo { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 38 | |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 39 | private static final long serialVersionUID = 806201629L; |
| 40 | |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 41 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 42 | * File handle to maintain temporary java code fragments as per the code |
| 43 | * snippet types. |
| 44 | */ |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 45 | private transient TempJavaCodeFragmentFiles tempFileHandle; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Creates YANG java enumeration object. |
| 49 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 50 | public YangJavaEnumerationTranslator() { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 51 | super(); |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 52 | setJavaFileInfo(new JavaFileInfoTranslator()); |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 53 | getJavaFileInfo().setGeneratedFileTypes(GENERATE_ENUM_CLASS); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Returns the generated java file information. |
| 58 | * |
| 59 | * @return generated java file information |
| 60 | */ |
| 61 | @Override |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 62 | public JavaFileInfoTranslator getJavaFileInfo() { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 63 | |
| 64 | if (javaFileInfo == null) { |
| 65 | throw new TranslatorException("Missing java info in java datamodel node"); |
| 66 | } |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 67 | return (JavaFileInfoTranslator) javaFileInfo; |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Sets the java file info object. |
| 72 | * |
| 73 | * @param javaInfo java file info object |
| 74 | */ |
| 75 | @Override |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 76 | public void setJavaFileInfo(JavaFileInfoTranslator javaInfo) { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 77 | javaFileInfo = javaInfo; |
| 78 | } |
| 79 | |
| 80 | /** |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 81 | * Returns the temporary file handle. |
| 82 | * |
| 83 | * @return temporary file handle |
| 84 | */ |
| 85 | @Override |
| 86 | public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 87 | return tempFileHandle; |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * Sets temporary file handle. |
| 92 | * |
| 93 | * @param fileHandle temporary file handle |
| 94 | */ |
| 95 | @Override |
| 96 | public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) { |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 97 | tempFileHandle = fileHandle; |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * Prepare the information for java code generation corresponding to YANG |
| 102 | * enumeration info. |
| 103 | * |
| 104 | * @param yangPlugin YANG plugin config |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 105 | * @throws TranslatorException translator operations fails |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 106 | */ |
| 107 | @Override |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 108 | public void generateCodeEntry(YangPluginConfig yangPlugin) throws TranslatorException { |
| 109 | try { |
| 110 | generateCodeOfNode(this, yangPlugin); |
| 111 | } catch (IOException e) { |
| 112 | throw new TranslatorException( |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 113 | "Failed to prepare generate code entry for enumeration node " + getName()); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 114 | } |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Creates a java file using the YANG enumeration info. |
| 119 | * |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 120 | * @throws TranslatorException translator operation fail |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 121 | */ |
| 122 | @Override |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 123 | public void generateCodeExit() throws TranslatorException { |
| 124 | try { |
| 125 | getTempJavaCodeFragmentFiles().generateJavaFile(GENERATE_ENUM_CLASS, this); |
| 126 | } catch (IOException e) { |
Bharat saraswal | c2d3be1 | 2016-06-16 00:29:12 +0530 | [diff] [blame] | 127 | throw new TranslatorException("Failed to generate code for enumeration node " + getName()); |
Bharat saraswal | 4aaab4d | 2016-05-17 14:19:38 +0530 | [diff] [blame] | 128 | } |
Bharat saraswal | 68fa0d1 | 2016-04-19 01:00:16 +0530 | [diff] [blame] | 129 | } |
| 130 | |
| 131 | } |