blob: ed0d0271a68c52ebe8f342f4636434af2d833017 [file] [log] [blame]
Vinod Kumar S67e7be62016-02-11 20:13:28 +05301/*
2 * Copyright 2016 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
17package org.onosproject.yangutils.translator;
18
Bharat saraswal870c56f2016-02-20 21:57:16 +053019import java.io.IOException;
20
Vinod Kumar S67e7be62016-02-11 20:13:28 +053021/**
22 * Abstraction of an entity which provides Code generator functionalities.
23 */
24public interface CodeGenerator {
25
26 /**
27 * Traverse the schema of application and generate corresponding code.
Bharat saraswal870c56f2016-02-20 21:57:16 +053028 *
Bharat saraswal2f00b4b2016-03-04 20:08:09 +053029 * @param codeGenDir code generation directory
Vinod Kumar Sc4216002016-03-03 19:55:30 +053030 * @throws IOException when fails to translate the data model tree
Vinod Kumar S67e7be62016-02-11 20:13:28 +053031 */
Bharat saraswal2f00b4b2016-03-04 20:08:09 +053032 void generateJavaCodeEntry(String codeGenDir) throws IOException;
Vinod Kumar S67e7be62016-02-11 20:13:28 +053033
34 /**
35 * Traverse the schema of application and generate corresponding code.
Bharat saraswal870c56f2016-02-20 21:57:16 +053036 *
Vinod Kumar Sc4216002016-03-03 19:55:30 +053037 * @throws IOException when fails to generate java code
Vinod Kumar S67e7be62016-02-11 20:13:28 +053038 */
Bharat saraswal870c56f2016-02-20 21:57:16 +053039 void generateJavaCodeExit() throws IOException;
Vinod Kumar S67e7be62016-02-11 20:13:28 +053040
41}