1 files changed, 65 insertions, 0 deletions
diff --git a/yang-compiler/src/main/java/org/onap/modeling/yangkit/compiler/plugin/YangCompilerPlugin.java b/yang-compiler/src/main/java/org/onap/modeling/yangkit/compiler/plugin/YangCompilerPlugin.java
new file mode 100644
index 0000000..c4d2366
--- /dev/null
+++ b/yang-compiler/src/main/java/org/onap/modeling/yangkit/compiler/plugin/YangCompilerPlugin.java
@@ -0,0 +1,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;
+
+}