compiler/api/src/main/java/org/onosproject/yang/compiler/api/YangCompilerService.java

/*
 * Copyright 2016-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onosproject.yang.compiler.api;

import java.io.IOException;

/**
 * Representation of an entity that provides YANG compilation service.
 */
public interface YangCompilerService {

    /**
     * Compiles YANG files and generates the required code with serialized
     * metadata.
     *
     * @param param YANG compilation parameters
     * @return compiled output
     * @throws IOException           a violation in IO rule
     * @throws YangCompilerException a violation in YANG compilation rule
     */
    YangCompiledOutput compileYangFiles(YangCompilationParam param)
            throws IOException, YangCompilerException;
}