Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +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.javamodel; |
| 17 | |
Bharat saraswal | 039f59c | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 18 | import java.io.File; |
| 19 | import java.io.IOException; |
| 20 | import java.util.List; |
| 21 | |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.translator.tojava.JavaFileInfoTranslator; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 23 | import org.onosproject.yangutils.datamodel.javadatamodel.YangJavaIdentity; |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 24 | import org.onosproject.yangutils.utils.io.YangPluginConfig; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 25 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
| 26 | import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator; |
| 27 | import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 28 | import org.onosproject.yangutils.translator.tojava.JavaImportData; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 29 | import org.onosproject.yangutils.translator.tojava.JavaQualifiedTypeInfoTranslator; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 30 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 31 | |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 32 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_IDENTITY_CLASS; |
Bharat saraswal | 039f59c | 2016-07-14 21:57:13 +0530 | [diff] [blame] | 33 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_INTERFACE_WITH_BUILDER; |
Bharat saraswal | af413b8 | 2016-07-14 15:18:20 +0530 | [diff] [blame] | 34 | import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.updatePackageInfo; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 35 | import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGeneratorUtils.getFileObject; |
| 36 | import static org.onosproject.yangutils.translator.tojava.utils.JavaFileGeneratorUtils.initiateJavaFileGeneration; |
| 37 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.createPackage; |
Bharat saraswal | d14cbe8 | 2016-07-14 13:26:18 +0530 | [diff] [blame] | 38 | import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.closeFile; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 39 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getCapitalCase; |
| 40 | |
| 41 | /** |
| 42 | * Represents input information extended to support java code generation. |
| 43 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 44 | public class YangJavaIdentityTranslator extends YangJavaIdentity |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 45 | implements JavaCodeGeneratorInfo, JavaCodeGenerator { |
| 46 | |
| 47 | //File type extension for java classes. |
| 48 | private static final String JAVA_FILE_EXTENSION = ".java"; |
| 49 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 50 | //Contains the information of the imported. |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 51 | private transient JavaImportData importData; |
| 52 | |
| 53 | /** |
| 54 | * File handle to maintain temporary java code fragments as per the code |
| 55 | * snippet types. |
| 56 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 57 | private transient TempJavaCodeFragmentFiles tempFileHandle; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 58 | |
| 59 | /** |
| 60 | * Creates YANG java container object. |
| 61 | */ |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 62 | public YangJavaIdentityTranslator() { |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 63 | setJavaFileInfo(new JavaFileInfoTranslator()); |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 64 | getJavaFileInfo().setGeneratedFileTypes(GENERATE_INTERFACE_WITH_BUILDER); |
| 65 | importData = new JavaImportData(); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Returns the generated java file information. |
| 70 | * |
| 71 | * @return generated java file information |
| 72 | */ |
| 73 | @Override |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 74 | public JavaFileInfoTranslator getJavaFileInfo() { |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 75 | if (javaFileInfo == null) { |
| 76 | throw new TranslatorException("Missing java info in java datamodel node"); |
| 77 | } |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 78 | return (JavaFileInfoTranslator) javaFileInfo; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 79 | } |
| 80 | |
| 81 | /** |
| 82 | * Sets the java file info object. |
| 83 | * |
| 84 | * @param javaInfo java file info object |
| 85 | */ |
| 86 | @Override |
Bharat saraswal | e50edca | 2016-08-05 01:58:25 +0530 | [diff] [blame] | 87 | public void setJavaFileInfo(JavaFileInfoTranslator javaInfo) { |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 88 | javaFileInfo = javaInfo; |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Returns the temporary file handle. |
| 93 | * |
| 94 | * @return temporary file handle |
| 95 | */ |
| 96 | @Override |
| 97 | public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() { |
| 98 | return tempFileHandle; |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Sets temporary file handle. |
| 103 | * |
| 104 | * @param fileHandle temporary file handle |
| 105 | */ |
| 106 | @Override |
| 107 | public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) { |
| 108 | tempFileHandle = fileHandle; |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Prepare the information for java code generation corresponding to YANG |
| 113 | * container info. |
| 114 | * |
| 115 | * @param yangPlugin YANG plugin config |
| 116 | * @throws TranslatorException translator operation fail |
| 117 | */ |
| 118 | @Override |
| 119 | public void generateCodeEntry(YangPluginConfig yangPlugin) throws TranslatorException { |
| 120 | try { |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 121 | |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 122 | updatePackageInfo(this, yangPlugin); |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 123 | JavaQualifiedTypeInfoTranslator basePkgInfo = new JavaQualifiedTypeInfoTranslator(); |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 124 | String className = getCapitalCase(getJavaFileInfo().getJavaName()); |
| 125 | String path = getJavaFileInfo().getPackageFilePath(); |
| 126 | createPackage(this); |
| 127 | List<String> imports = null; |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 128 | boolean isQualified; |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 129 | |
| 130 | if (getBaseNode() != null && getBaseNode().getReferredIdentity() != null) { |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 131 | if (!(getBaseNode().getReferredIdentity() instanceof YangJavaIdentityTranslator)) { |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 132 | throw new TranslatorException("Failed to prepare generate code entry for base node"); |
| 133 | } |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 134 | YangJavaIdentityTranslator baseIdentity = (YangJavaIdentityTranslator) getBaseNode() |
| 135 | .getReferredIdentity(); |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 136 | String baseClassName = getCapitalCase(baseIdentity.getJavaFileInfo().getJavaName()); |
Shankara-Huawei | b756477 | 2016-08-02 18:13:13 +0530 | [diff] [blame] | 137 | String basePkg = baseIdentity.getJavaFileInfo().getPackage(); |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 138 | basePkgInfo.setClassInfo(baseClassName); |
| 139 | basePkgInfo.setPkgInfo(basePkg); |
| 140 | isQualified = importData.addImportInfo(basePkgInfo, className, getJavaFileInfo().getPackage()); |
| 141 | if (!isQualified) { |
| 142 | imports = importData.getImports(); |
| 143 | } |
| 144 | } |
| 145 | |
Bharat saraswal | 8beac34 | 2016-08-04 02:00:03 +0530 | [diff] [blame] | 146 | File file = getFileObject(path, className, JAVA_FILE_EXTENSION, getJavaFileInfo()); |
Shankara-Huawei | 234cd09 | 2016-07-14 11:35:34 +0530 | [diff] [blame] | 147 | |
| 148 | initiateJavaFileGeneration(file, GENERATE_IDENTITY_CLASS, imports, this, className); |
| 149 | closeFile(file, false); |
| 150 | } catch (IOException e) { |
| 151 | throw new TranslatorException( |
| 152 | "Failed to prepare generate code entry for identity node " + this.getName()); |
| 153 | } |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Create a java file using the YANG container info. |
| 158 | * |
| 159 | * @throws TranslatorException translator operation fail |
| 160 | */ |
| 161 | @Override |
| 162 | public void generateCodeExit() throws TranslatorException { |
| 163 | /* Do nothing, file is already generated in entry*/ |
| 164 | } |
| 165 | } |
| 166 | |