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