org.opendaylight.yangtools.yang2sources.spi

Interface CodeGenerator

public interface CodeGenerator

Classes implementing this interface can be submitted to maven-yang-plugin's generate-sources goal.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<File>	generateSources(org.opendaylight.yangtools.yang.model.api.SchemaContext context, File outputBaseDir, Set<org.opendaylight.yangtools.yang.model.api.Module> currentModules) 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	setLog(org.apache.maven.plugin.logging.Log log) Utilize maven logging if necessary
void	setMavenProject(org.apache.maven.project.MavenProject project) Provided maven project object.
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(org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                               File outputBaseDir,
                               Set<org.opendaylight.yangtools.yang.model.api.Module> currentModules)
                                 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

Returns:

collection of files that were generated from schema context

Throws:

IOException

setLog

void setLog(org.apache.maven.plugin.logging.Log log)

Utilize maven logging if necessary

Parameters:

log -

setAdditionalConfig

void setAdditionalConfig(Map<String,String> additionalConfiguration)

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

Parameters:

additionalConfiguration -

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

Parameters:

resourceBaseDir -

setMavenProject

void setMavenProject(org.apache.maven.project.MavenProject project)

Provided maven project object. Any additional information about current maven project can be accessed from it.

Parameters:

project -