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.

Method Summary

Modifier and Type	Method and Description
Collection<File>	generateSources(SchemaContext context, File outputBaseDir, Set<Module> currentModules) Deprecated. Implement generateSources(SchemaContext, File, Set, Function) instead.
default Collection<File>	generateSources(SchemaContext context, File outputBaseDir, Set<Module> currentModules, Function<Module,Optional<String>> moduleResourcePathResolver) Generate sources from provided SchemaContext.
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

@Deprecated
Collection<File> generateSources(SchemaContext context,
                                             File outputBaseDir,
                                             Set<Module> currentModules)
                                      throws IOException

Deprecated. Implement generateSources(SchemaContext, File, Set, Function) instead.

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

Returns:

collection of files that were generated from schema context

Throws:

IOException

generateSources

default 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.