blob: 878a5912a2d0630f5a05b6ecf3233ac91f30b6b1 [file] [log] [blame]
Gaurav Agrawalf5766422016-03-23 19:04:17 +05301/*
Brian O'Connor0f7908b2016-04-09 01:19:45 -07002 * Copyright 2016-present Open Networking Laboratory
Gaurav Agrawalf5766422016-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 S79a374b2016-04-30 21:09:15 +053020
Shankara-Huaweib7564772016-08-02 18:13:13 +053021import org.onosproject.yangutils.datamodel.javadatamodel.YangJavaInput;
Bharat saraswal780eca32016-04-05 12:45:45 +053022import org.onosproject.yangutils.translator.exception.TranslatorException;
Gaurav Agrawalf5766422016-03-23 19:04:17 +053023import org.onosproject.yangutils.translator.tojava.JavaCodeGenerator;
Gaurav Agrawalbfce9342016-06-15 13:58:01 +053024import org.onosproject.yangutils.translator.tojava.JavaCodeGeneratorInfo;
Bharat saraswale3175d32016-08-31 17:50:11 +053025import org.onosproject.yangutils.translator.tojava.JavaFileInfoTranslator;
Gaurav Agrawalf5766422016-03-23 19:04:17 +053026import org.onosproject.yangutils.translator.tojava.TempJavaCodeFragmentFiles;
Bharat saraswale3175d32016-08-31 17:50:11 +053027import org.onosproject.yangutils.utils.io.YangPluginConfig;
Gaurav Agrawalf5766422016-03-23 19:04:17 +053028
29import static org.onosproject.yangutils.translator.tojava.GeneratedJavaFileType.GENERATE_INTERFACE_WITH_BUILDER;
Bharat saraswalaf413b82016-07-14 15:18:20 +053030import static org.onosproject.yangutils.translator.tojava.YangJavaModelUtils.generateCodeOfAugmentableNode;
Gaurav Agrawalf5766422016-03-23 19:04:17 +053031
32/**
Bharat saraswal63f26fb2016-04-05 15:13:44 +053033 * Represents input information extended to support java code generation.
Gaurav Agrawalf5766422016-03-23 19:04:17 +053034 */
Shankara-Huaweib7564772016-08-02 18:13:13 +053035public class YangJavaInputTranslator
36 extends YangJavaInput
Vinod Kumar S79a374b2016-04-30 21:09:15 +053037 implements JavaCodeGeneratorInfo, JavaCodeGenerator {
Gaurav Agrawalf5766422016-03-23 19:04:17 +053038
Bharat saraswalc2d3be12016-06-16 00:29:12 +053039 private static final long serialVersionUID = 806201627L;
40
Gaurav Agrawalf5766422016-03-23 19:04:17 +053041 /**
Gaurav Agrawalf5766422016-03-23 19:04:17 +053042 * File handle to maintain temporary java code fragments as per the code
43 * snippet types.
44 */
Bharat saraswalc2d3be12016-06-16 00:29:12 +053045 private transient TempJavaCodeFragmentFiles tempFileHandle;
Bharat saraswal5cd9e9c2016-05-26 23:48:38 +053046
Gaurav Agrawalf5766422016-03-23 19:04:17 +053047 /**
48 * Creates an instance of java input.
49 */
Shankara-Huaweib7564772016-08-02 18:13:13 +053050 public YangJavaInputTranslator() {
Gaurav Agrawalf5766422016-03-23 19:04:17 +053051 super();
Bharat saraswale50edca2016-08-05 01:58:25 +053052 setJavaFileInfo(new JavaFileInfoTranslator());
Gaurav Agrawalf5766422016-03-23 19:04:17 +053053 getJavaFileInfo().setGeneratedFileTypes(GENERATE_INTERFACE_WITH_BUILDER);
54 }
55
56 /**
57 * Returns the generated java file information.
58 *
59 * @return generated java file information
60 */
61 @Override
Bharat saraswale50edca2016-08-05 01:58:25 +053062 public JavaFileInfoTranslator getJavaFileInfo() {
Gaurav Agrawalf5766422016-03-23 19:04:17 +053063 if (javaFileInfo == null) {
Bharat saraswale3175d32016-08-31 17:50:11 +053064 throw new TranslatorException("missing java info in java datamodel node " +
65 getName() + " in " +
66 getLineNumber() + " at " +
67 getCharPosition()
68 + " in " + getFileName());
Gaurav Agrawalf5766422016-03-23 19:04:17 +053069 }
Bharat saraswale50edca2016-08-05 01:58:25 +053070 return (JavaFileInfoTranslator) javaFileInfo;
Gaurav Agrawalf5766422016-03-23 19:04:17 +053071 }
72
73 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +053074 * Sets the java file info object.
Gaurav Agrawalf5766422016-03-23 19:04:17 +053075 *
76 * @param javaInfo java file info object
77 */
78 @Override
Bharat saraswale50edca2016-08-05 01:58:25 +053079 public void setJavaFileInfo(JavaFileInfoTranslator javaInfo) {
Gaurav Agrawalf5766422016-03-23 19:04:17 +053080 javaFileInfo = javaInfo;
81 }
82
83 /**
Gaurav Agrawalf5766422016-03-23 19:04:17 +053084 * Returns the temporary file handle.
85 *
86 * @return temporary file handle
87 */
88 @Override
89 public TempJavaCodeFragmentFiles getTempJavaCodeFragmentFiles() {
Gaurav Agrawalf5766422016-03-23 19:04:17 +053090 return tempFileHandle;
91 }
92
93 /**
Bharat saraswal63f26fb2016-04-05 15:13:44 +053094 * Sets temporary file handle.
Gaurav Agrawalf5766422016-03-23 19:04:17 +053095 *
96 * @param fileHandle temporary file handle
97 */
98 @Override
99 public void setTempJavaCodeFragmentFiles(TempJavaCodeFragmentFiles fileHandle) {
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530100 tempFileHandle = fileHandle;
101 }
102
103 /**
104 * Prepare the information for java code generation corresponding to YANG
Bharat saraswale2bc60d2016-04-16 02:28:25 +0530105 * input info.
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530106 *
janani b1c6acc42016-04-15 16:18:30 +0530107 * @param yangPlugin YANG plugin config
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530108 * @throws TranslatorException translator operation fail
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530109 */
110 @Override
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530111 public void generateCodeEntry(YangPluginConfig yangPlugin) throws TranslatorException {
112 try {
Bharat saraswal5cd9e9c2016-05-26 23:48:38 +0530113 generateCodeOfAugmentableNode(this, yangPlugin);
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530114 } catch (IOException e) {
115 throw new TranslatorException(
Bharat saraswale3175d32016-08-31 17:50:11 +0530116 "Failed to prepare generate code entry for input node " +
117 getName() + " in " +
118 getLineNumber() + " at " +
119 getCharPosition()
120 + " in " + getFileName() + " " + e.getLocalizedMessage());
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530121 }
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530122 }
123
124 /**
Bharat saraswale2bc60d2016-04-16 02:28:25 +0530125 * Creates a java file using the YANG input info.
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530126 *
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530127 * @throws TranslatorException translator operation fail
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530128 */
129 @Override
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530130 public void generateCodeExit() throws TranslatorException {
131 try {
Bharat saraswalc2d3be12016-06-16 00:29:12 +0530132 getTempJavaCodeFragmentFiles().generateJavaFile(GENERATE_INTERFACE_WITH_BUILDER, this);
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530133 } catch (IOException e) {
Bharat saraswale3175d32016-08-31 17:50:11 +0530134 throw new TranslatorException("Failed to generate code for input node " +
135 getName() + " in " +
136 getLineNumber() + " at " +
137 getCharPosition()
138 + " in " + getFileName() + " " + e.getLocalizedMessage());
Bharat saraswal4aaab4d2016-05-17 14:19:38 +0530139 }
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530140 }
Bharat saraswal5cd9e9c2016-05-26 23:48:38 +0530141
Gaurav Agrawalf5766422016-03-23 19:04:17 +0530142}