Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | 0f7908b | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 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 | |
| 18 | import java.io.IOException; |
| 19 | |
| 20 | import org.onosproject.yangutils.datamodel.YangList; |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 21 | import org.onosproject.yangutils.translator.exception.TranslatorException; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 22 | import org.onosproject.yangutils.translator.tojava.HasJavaFileInfo; |
| 23 | import org.onosproject.yangutils.translator.tojava.HasJavaImportData; |
| 24 | import org.onosproject.yangutils.translator.tojava.HasTempJavaCodeFragmentFiles; |
| 25 | import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator; |
| 26 | import org.onosproject.yangutils.translator.tojava.JavaFileInfo; |
| 27 | import org.onosproject.yangutils.translator.tojava.JavaImportData; |
| 28 | import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles; |
| 29 | |
| 30 | import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_INTERFACE_WITH_BUILDER; |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 31 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCamelCase; |
| 32 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCaptialCase; |
| 33 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getCurNodePackage; |
| 34 | import static org.onosproject.yangutils.translator.tojava.utils.JavaIdentifierSyntax.getPackageDirPathFromJavaJPackage; |
| 35 | import static org.onosproject.yangutils.utils.io.impl.FileSystemUtil.createPackage; |
| 36 | import static org.onosproject.yangutils.utils.io.impl.YangIoUtils.getAbsolutePackagePath; |
| 37 | |
| 38 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 39 | * Represents YANG List information extended to support java code generation. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 40 | */ |
| 41 | public class YangJavaList extends YangList |
| 42 | implements JavaCodeGenerator, HasJavaFileInfo, |
| 43 | HasJavaImportData, HasTempJavaCodeFragmentFiles { |
| 44 | |
| 45 | /** |
| 46 | * Contains the information of the java file being generated. |
| 47 | */ |
| 48 | private JavaFileInfo javaFileInfo; |
| 49 | |
| 50 | /** |
| 51 | * Contains information of the imports to be inserted in the java file |
| 52 | * generated. |
| 53 | */ |
| 54 | private JavaImportData javaImportData; |
| 55 | |
| 56 | /** |
| 57 | * File handle to maintain temporary java code fragments as per the code |
| 58 | * snippet types. |
| 59 | */ |
| 60 | private TempJavaCodeFragmentFiles tempFileHandle; |
| 61 | |
| 62 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 63 | * Creates YANG java list object. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 64 | */ |
| 65 | public YangJavaList() { |
| 66 | super(); |
| 67 | setJavaFileInfo(new JavaFileInfo()); |
| 68 | setJavaImportData(new JavaImportData()); |
| 69 | getJavaFileInfo().setGeneratedFileTypes(GENERATE_INTERFACE_WITH_BUILDER); |
| 70 | } |
| 71 | |
| 72 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 73 | * Returns the generated java file information. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 74 | * |
| 75 | * @return generated java file information |
| 76 | */ |
| 77 | @Override |
| 78 | public JavaFileInfo getJavaFileInfo() { |
| 79 | |
| 80 | if (javaFileInfo == null) { |
Bharat saraswal | 780eca3 | 2016-04-05 12:45:45 +0530 | [diff] [blame] | 81 | throw new TranslatorException("Missing java info in java datamodel node"); |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 82 | } |
| 83 | return javaFileInfo; |
| 84 | } |
| 85 | |
| 86 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 87 | * Sets the java file info object. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 88 | * |
| 89 | * @param javaInfo java file info object |
| 90 | */ |
| 91 | @Override |
| 92 | public void setJavaFileInfo(JavaFileInfo javaInfo) { |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 93 | javaFileInfo = javaInfo; |
| 94 | } |
| 95 | |
| 96 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 97 | * Returns the data of java imports to be included in generated file. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 98 | * |
| 99 | * @return data of java imports to be included in generated file |
| 100 | */ |
| 101 | @Override |
| 102 | public JavaImportData getJavaImportData() { |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 103 | return javaImportData; |
| 104 | } |
| 105 | |
| 106 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 107 | * Sets the data of java imports to be included in generated file. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 108 | * |
| 109 | * @param javaImportData data of java imports to be included in generated |
| 110 | * file |
| 111 | */ |
| 112 | @Override |
| 113 | public void setJavaImportData(JavaImportData javaImportData) { |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 114 | this.javaImportData = javaImportData; |
| 115 | } |
| 116 | |
| 117 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 118 | * Returns the temporary file handle. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 119 | * |
| 120 | * @return temporary file handle |
| 121 | */ |
| 122 | @Override |
| 123 | public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() { |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 124 | return tempFileHandle; |
| 125 | } |
| 126 | |
| 127 | /** |
Bharat saraswal | 63f26fb | 2016-04-05 15:13:44 +0530 | [diff] [blame^] | 128 | * Sets temporary file handle. |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 129 | * |
| 130 | * @param fileHandle temporary file handle |
| 131 | */ |
| 132 | @Override |
| 133 | public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) { |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 134 | tempFileHandle = fileHandle; |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Prepare the information for java code generation corresponding to YANG |
| 139 | * container info. |
| 140 | * |
| 141 | * @param codeGenDir code generation directory |
| 142 | * @throws IOException IO operation fail |
| 143 | */ |
| 144 | @Override |
| 145 | public void generateCodeEntry(String codeGenDir) throws IOException { |
| 146 | |
| 147 | getJavaFileInfo().setJavaName(getCaptialCase(getCamelCase(getName()))); |
| 148 | getJavaFileInfo().setPackage(getCurNodePackage(this)); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 149 | |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 150 | getJavaFileInfo().setPackageFilePath( |
| 151 | getPackageDirPathFromJavaJPackage(getJavaFileInfo().getPackage())); |
| 152 | getJavaFileInfo().setBaseCodeGenPath(codeGenDir); |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 153 | |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 154 | String absloutePath = getAbsolutePackagePath( |
| 155 | getJavaFileInfo().getBaseCodeGenPath(), |
| 156 | getJavaFileInfo().getPackageFilePath()); |
| 157 | createPackage(absloutePath, getName()); |
| 158 | |
| 159 | setTempJavaCodeFragmentFiles(new TempJavaCodeFragmentFiles( |
| 160 | getJavaFileInfo().getGeneratedFileTypes(), absloutePath, |
| 161 | getJavaFileInfo().getJavaName())); |
| 162 | |
| 163 | getTempJavaCodeFragmentFiles().addCurNodeLeavesInfoToTempFiles(this); |
| 164 | |
| 165 | getTempJavaCodeFragmentFiles().addCurNodeInfoInParentTempFile(this, true); |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Create a java file using the YANG grouping info. |
| 170 | * |
| 171 | * @throws IOException IO operation fail |
| 172 | */ |
| 173 | @Override |
| 174 | public void generateCodeExit() throws IOException { |
Bharat saraswal | 84366c5 | 2016-03-23 19:40:35 +0530 | [diff] [blame] | 175 | getTempJavaCodeFragmentFiles().generateJavaFile(GENERATE_INTERFACE_WITH_BUILDER, this); |
Vinod Kumar S | 9f26ae5 | 2016-03-23 15:30:27 +0530 | [diff] [blame] | 176 | } |
| 177 | } |