2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang2sources.spi;
11 import java.io.IOException;
12 import java.util.Collection;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.opendaylight.yangtools.plugin.generator.api.FileGenerator;
17 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
18 import org.opendaylight.yangtools.yang.model.api.Module;
21 * Maven 3.1.x and newer uses SLF4J internally, which means we do not need to pass a logger instance around.
23 * @deprecated Use {@link FileGenerator} instead.
26 public interface BasicCodeGenerator {
27 enum ImportResolutionMode {
29 * Standard, RFC6020 and RFC7950 compliant mode. Imports are satisfied by exact revision match (if specified),
30 * or by latest available revision.
32 REVISION_EXACT_OR_LATEST(FileGenerator.ImportResolutionMode.REVISION_EXACT_OR_LATEST),
34 * Semantic version based mode. Imports which specify a semantic version (via the OpenConfig extension) will
35 * be satisfied by module which exports the latest compatible revision. Imports which do not specify semantic
36 * version will be resolved just as they would be via {@link #REVISION_EXACT_OR_LATEST}.
38 SEMVER_LATEST(FileGenerator.ImportResolutionMode.SEMVER_LATEST);
40 private final FileGenerator.@NonNull ImportResolutionMode fileGeneratorMode;
42 ImportResolutionMode(final FileGenerator.@NonNull ImportResolutionMode fileGeneratorMode) {
43 this.fileGeneratorMode = fileGeneratorMode;
47 * Return {@link FileGenerator.ImportResolutionMode} equivalent of this mode.
49 * @return {@link FileGenerator.ImportResolutionMode} equivalent of this mode
51 public final FileGenerator.@NonNull ImportResolutionMode toFileGeneratorMode() {
52 return fileGeneratorMode;
57 * Generate sources from provided {@link EffectiveModelContext}.
60 * parsed from YANG files
61 * @param outputBaseDir
62 * expected output directory for generated sources configured by
64 * @param currentModules
65 * YANG modules parsed from yangFilesRootDir
66 * @param moduleResourcePathResolver
67 * Function converting a local module to the packaged resource path
68 * @return collection of files that were generated from schema context
70 Collection<File> generateSources(EffectiveModelContext context, File outputBaseDir, Set<Module> currentModules,
71 ModuleResourceResolver moduleResourcePathResolver) throws IOException;
74 * Provided map contains all configuration that was set in pom for code
75 * generator in additionalConfiguration tag.
77 void setAdditionalConfig(Map<String, String> additionalConfiguration);
80 * Provided folder is marked as resources and its content will be packaged
81 * in resulting jar. Feel free to add necessary resources.
83 void setResourceBaseDir(File resourceBaseDir);
86 * Indicate import resolution mode this code generator requires. Default implementation indicates
87 * {@link ImportResolutionMode#REVISION_EXACT_OR_LATEST}.
89 * @return Required import resolution mode, null if the code generator does not care.
91 // FIXME: This is not really extensible, we should be returning a collection of acceptable modes, or have some sort
92 // of two-step negotiation protocol:
93 // - Optional<ImportResolutionMode> suggestImportResolutionMode();
94 // - boolean isImportResolutionModeAcceptable(ImportResolutionMode);
95 // Let's go with something hacky until we figure out exact requirements.
96 default ImportResolutionMode getImportResolutionMode() {
97 return ImportResolutionMode.REVISION_EXACT_OR_LATEST;