blob: 0c5ddcfa001f5156bdbd47cefada55b706f70926 [file] [log] [blame]
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +05301/*
Brian O'Connor5ab426f2016-04-09 01:19:45 -07002 * Copyright 2016-present Open Networking Laboratory
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +05303 *
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
17package org.onosproject.yangutils.translator.tojava.javamodel;
18
19import java.io.IOException;
Vinod Kumar Se4b9b0c2016-04-30 21:09:15 +053020
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053021import org.onosproject.yangutils.datamodel.YangOutput;
Bharat saraswal6ef0b762016-04-05 12:45:45 +053022import org.onosproject.yangutils.translator.exception.TranslatorException;
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053023import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator;
24import org.onosproject.yangutils.translator.tojava.JavaFileInfo;
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053025import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles;
janani bde4ffab2016-04-15 16:18:30 +053026import org.onosproject.yangutils.translator.tojava.utils.YangPluginConfig;
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053027
28import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_INTERFACE_WITH_BUILDER;
Gaurav Agrawal1c8f80c2016-04-12 13:30:16 +053029import static org.onosproject.yangutils.translator.tojava.utils.YangJavaModelUtils.generateCodeOfNode;
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053030
31/**
Bharat saraswald9822e92016-04-05 15:13:44 +053032 * Represents output information extended to support java code generation.
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053033 */
Vinod Kumar Se4b9b0c2016-04-30 21:09:15 +053034public class YangJavaOutput
35 extends YangOutput
36 implements JavaCodeGeneratorInfo, JavaCodeGenerator {
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053037
38 /**
39 * Contains information of the java file being generated.
40 */
41 private JavaFileInfo javaFileInfo;
42
43 /**
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053044 * File handle to maintain temporary java code fragments as per the code
45 * snippet types.
46 */
47 private TempJavaCodeFragmentFiles tempFileHandle;
48
49 /**
50 * Creates an instance of java output.
51 */
52 public YangJavaOutput() {
53 super();
54 setJavaFileInfo(new JavaFileInfo());
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053055 getJavaFileInfo().setGeneratedFileTypes(GENERATE_INTERFACE_WITH_BUILDER);
56 }
57
58 /**
59 * Returns the generated java file information.
60 *
61 * @return generated java file information
62 */
63 @Override
64 public JavaFileInfo getJavaFileInfo() {
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053065 if (javaFileInfo == null) {
Gaurav Agrawal56527662016-04-20 15:49:17 +053066 throw new TranslatorException("missing java info in java datamodel node");
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053067 }
68 return javaFileInfo;
69 }
70
71 /**
Bharat saraswald9822e92016-04-05 15:13:44 +053072 * Sets the java file info object.
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053073 *
74 * @param javaInfo java file info object
75 */
76 @Override
77 public void setJavaFileInfo(JavaFileInfo javaInfo) {
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053078 javaFileInfo = javaInfo;
79 }
80
81 /**
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053082 * Returns the temporary file handle.
83 *
84 * @return temporary file handle
85 */
86 @Override
87 public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() {
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053088 return tempFileHandle;
89 }
90
91 /**
Bharat saraswald9822e92016-04-05 15:13:44 +053092 * Sets temporary file handle.
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053093 *
94 * @param fileHandle temporary file handle
95 */
96 @Override
97 public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) {
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +053098 tempFileHandle = fileHandle;
99 }
100
101 /**
102 * Prepare the information for java code generation corresponding to YANG
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530103 * output info.
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +0530104 *
janani bde4ffab2016-04-15 16:18:30 +0530105 * @param yangPlugin YANG plugin config
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +0530106 * @throws IOException IO operation fail
107 */
108 @Override
Vinod Kumar Se4b9b0c2016-04-30 21:09:15 +0530109 public void generateCodeEntry(YangPluginConfig yangPlugin)
110 throws IOException {
Gaurav Agrawal56527662016-04-20 15:49:17 +0530111 generateCodeOfNode(this, yangPlugin);
Vinod Kumar Se4b9b0c2016-04-30 21:09:15 +0530112
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +0530113 }
114
115 /**
Bharat saraswalcc1cdab2016-04-16 02:28:25 +0530116 * Creates a java file using the YANG output info.
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +0530117 *
118 * @throws IOException IO operation fail
119 */
120 @Override
Vinod Kumar Se4b9b0c2016-04-30 21:09:15 +0530121 public void generateCodeExit()
122 throws IOException {
Bharat saraswale2d51d62016-03-23 19:40:35 +0530123 getTempJavaCodeFragmentFiles().generateJavaFile(GENERATE_INTERFACE_WITH_BUILDER, this);
Gaurav Agrawale3ed0d92016-03-23 19:04:17 +0530124 }
125}