2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * Copyright (C) 2017 Amdocs
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
20 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
23 package org.openecomp.appc.yang;
25 import org.openecomp.appc.yang.exception.YANGGenerationException;
27 import java.io.OutputStream;
30 * The Interface YANGGenerator - provides method to generate YANG file from TOSCA.
32 public interface YANGGenerator {
35 * Generate YANG from TOSCA.
36 * if any exceptional Type is coming in the input tosca as a part of configuration parameter property, YANGGenerationException will be thrown.
37 * This API is not supporting below mentioned built-in Types:
38 * bits, decimal64, enumeration, identityref, leafref, union
40 * @param uniqueID - Set as module name in the yang, mandatory, cannot be null or empty
41 * @param tosca - TOSCA String from which the YANG is to be generated, mandatory, cannot be null or empty
42 * @param stream - The outputStream to which the generated yang is written, mandatory, cannot be null
43 * @throws YANGGenerationException - Thrown when any error occurred during method execution, the origin can be found from ex.getCause() or ex.getMessage()
46 void generateYANG(String uniqueID, String tosca, OutputStream stream) throws YANGGenerationException;