blob: 3f660cad2e8515c7c3e7a0bba73c40e0e535dfde [file] [log] [blame]
Bharat saraswal97459962016-02-20 21:57:16 +05301/*
Brian O'Connor0f7908b2016-04-09 01:19:45 -07002 * Copyright 2016-present Open Networking Laboratory
Bharat saraswal97459962016-02-20 21:57:16 +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;
18
19import java.io.IOException;
20
Bharat saraswal97459962016-02-20 21:57:16 +053021/**
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053022 * Abstraction of an entity which provides Code generator functionalities.
Bharat saraswal97459962016-02-20 21:57:16 +053023 */
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053024public interface JavaCodeGenerator {
Bharat saraswal97459962016-02-20 21:57:16 +053025
26 /**
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053027 * Traverse the schema of application and generate corresponding code.
Bharat saraswal97459962016-02-20 21:57:16 +053028 *
Bharat saraswal022dae92016-03-04 20:08:09 +053029 * @param codeGenDir code generation directory
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053030 * @throws IOException when fails to translate the data model tree
Bharat saraswal97459962016-02-20 21:57:16 +053031 */
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053032 void generateCodeEntry(String codeGenDir) throws IOException;
Bharat saraswal97459962016-02-20 21:57:16 +053033
Vinod Kumar S9f26ae52016-03-23 15:30:27 +053034 /**
35 * Traverse the schema of application and generate corresponding code.
36 *
37 * @throws IOException when fails to generate java code
38 */
39 void generateCodeExit() throws IOException;
40
Bharat saraswal97459962016-02-20 21:57:16 +053041}