org.opendaylight.yangtools.yang2sources.spi

Interface BasicCodeGenerator

public interface BasicCodeGenerator

Maven 3.1.x and newer uses SLF4J internally, which means we do not need to pass a logger instance around.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BasicCodeGenerator.ImportResolutionMode

Method Summary

Modifier and Type	Method and Description
Collection<File>	generateSources(SchemaContext context, File outputBaseDir, Set<Module> currentModules, Function<Module,Optional<String>> moduleResourcePathResolver) Generate sources from provided SchemaContext.
default BasicCodeGenerator.ImportResolutionMode	getImportResolutionMode() Indicate import resolution mode this code generator requires.
void	setAdditionalConfig(Map<String,String> additionalConfiguration) Provided map contains all configuration that was set in pom for code generator in additionalConfiguration tag.
void	setResourceBaseDir(File resourceBaseDir) Provided folder is marked as resources and its content will be packaged in resulting jar.

Method Detail

generateSources

Collection<File> generateSources(SchemaContext context,
                                 File outputBaseDir,
                                 Set<Module> currentModules,
                                 Function<Module,Optional<String>> moduleResourcePathResolver)
                          throws IOException

Generate sources from provided SchemaContext.

Parameters:

context - parsed from YANG files

outputBaseDir - expected output directory for generated sources configured by user

currentModules - YANG modules parsed from yangFilesRootDir

moduleResourcePathResolver - Function converting a local module to the packaged resource path

Returns:

collection of files that were generated from schema context

Throws:

IOException

setAdditionalConfig

void setAdditionalConfig(Map<String,String> additionalConfiguration)

Provided map contains all configuration that was set in pom for code generator in additionalConfiguration tag.

setResourceBaseDir

void setResourceBaseDir(File resourceBaseDir)

Provided folder is marked as resources and its content will be packaged in resulting jar. Feel free to add necessary resources.

getImportResolutionMode

default BasicCodeGenerator.ImportResolutionMode getImportResolutionMode()

Indicate import resolution mode this code generator requires. Default implementation indicates BasicCodeGenerator.ImportResolutionMode.REVISION_EXACT_OR_LATEST.

Returns:

Required import resolution mode, null if the code generator does not care.