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