summaryrefslogtreecommitdiffstats
path: root/yang-compiler/src/main/java/org/onap/modeling/yangkit/compiler/plugin/YangCompilerPlugin.java
blob: c4d2366c5c2971212a246ebbafb49e4a61d78689 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*
Copyright 2023 Huawei Technologies

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.onap.modeling.yangkit.compiler.plugin;

import com.google.gson.JsonElement;

import java.util.List;

import org.onap.modeling.yangkit.compiler.YangCompiler;
import org.onap.modeling.yangkit.compiler.YangCompilerException;
import org.yangcentral.yangkit.model.api.schema.YangSchemaContext;


public interface YangCompilerPlugin {
    /**
     * get parameter from build option.
     * @param name parameter name
     * @param value parameter value
     * @return return yang compiler plugin parameter
     * @throws YangCompilerException yang compiler exception
     */
    default YangCompilerPluginParameter getParameter(String name, JsonElement value)
            throws YangCompilerException {
        YangCompilerPluginParameter yangCompilerPluginParameter = new YangCompilerPluginParameter() {
            @Override
            public String getName() {
                return name;
            }

            @Override
            public Object getValue()  {
                String formatStr = value.getAsString();
                return formatStr;

            }

        };
        return yangCompilerPluginParameter;
    }

    /**
     * the definition of run method.
     * @param schemaContext yang schema context
     * @param yangCompiler yang compiler instance
     * @param parameters parameters
     * @throws YangCompilerException if error occurs, the exception will be thrown.
     */
    void run(YangSchemaContext schemaContext, YangCompiler yangCompiler, List<YangCompilerPluginParameter> parameters)
            throws YangCompilerException;

}