Package org.opendaylight.yangtools.plugin.generator.api

API exposed by generator plugins, i.e. pluggable pieces of code which want to create code (and other) files from an EffectiveModelContext.

The primary entry point is FileGeneratorFactory, which needs to be implemented for bootstrapping a particular generator. Such implementations are discovered using normal discovery methods, for example they should always be published as ServiceLoader services.

Interface Summary

Interface	Description
FileGenerator	Interface implemented by plugins which can generate files from a EffectiveModelContext.
FileGeneratorFactory	A ServiceLoader factory for instantiating FileGenerator instances.
GeneratedFile	The contents of a generated file and its GeneratedFileLifecycle.
ModuleResourceResolver	An SPI-level interface to find the schema source for a particular YANG module, as packaged in the final artifact.

Class Summary

Class	Description
AbstractFileGeneratorFactory	Abstract base class for FileGeneratorFactory implementations.
AbstractGeneratedFile	Abstract base class for GeneratedFiles.
AbstractGeneratedTextFile	The contents of a generated file and its GeneratedFileLifecycle.
GeneratedFilePath	A relative path to a generated file.
GeneratedFileType	Type of generated file.

Enum Summary

Enum	Description
FileGenerator.ImportResolutionMode	EffectiveModelContext can be assembled in multiple ways, we hold known modes here.
GeneratedFileLifecycle	Lifecycle policy of a generated file.

Exception Summary

Exception	Description
FileGeneratorException	An exception reporting a problem with file generation.