org.dmd.concinnity.server.generated.dsd

Interface ConcinnityModuleGeneratorInterface

All Known Implementing Classes:

ConcinnityModuleConfigLoader, ConcinnityModuleGenUtility

public interface ConcinnityModuleGeneratorInterface

Method Summary

Modifier and Type	Method and Description
void	displayHelp() Called if the help flag is found anywhere on the commandline.
void	generate(ConcinnityModule module, ConfigLocation location, ConcinnityModuleDefinitionManager definitions) Derived classes should overload this method to perform artifact generation.
void	generate(ConcinnityModuleDefinitionManager definitions) Derived classes should overload this method to perform artifact generation when no target module has been specified on the commandline.
void	objectResolutionComplete(ConcinnityModule module, ConfigLocation location, ConcinnityModuleDefinitionManager definitions) Called after object resolution has completely successfully.
void	parsingComplete(ConcinnityModule module, ConfigLocation location, ConcinnityModuleDefinitionManager definitions) Called prior to the object resolution phase so that derived classes can perform intermediate processing such as generation of internal types.

Method Detail

parsingComplete

void parsingComplete(ConcinnityModule module,
                     ConfigLocation location,
                     ConcinnityModuleDefinitionManager definitions)
              throws ResultException

Called prior to the object resolution phase so that derived classes can perform intermediate processing such as generation of internal types.

Parameters:

module - the module that was just parsed

location - the module's location

definitions - the current set of definitions

Throws:

ResultException - if there are problems

objectResolutionComplete

void objectResolutionComplete(ConcinnityModule module,
                              ConfigLocation location,
                              ConcinnityModuleDefinitionManager definitions)
                       throws ResultException

Called after object resolution has completely successfully. This allows for application of business logic not defined as part of rules etc.

Parameters:

module - the module that was just parsed

location - the module's location

definitions - the current set of definitions

Throws:

ResultException - if there are problems

generate

void generate(ConcinnityModule module,
              ConfigLocation location,
              ConcinnityModuleDefinitionManager definitions)
       throws ResultException,
              IOException

Derived classes should overload this method to perform artifact generation.

Parameters:

module - the module for which generation is being performed

location - where the module was found

definitions - the current set of definitions

Throws:

ResultException - if there are problems

IOException - if IO problems

generate

void generate(ConcinnityModuleDefinitionManager definitions)
       throws ResultException,
              IOException

Derived classes should overload this method to perform artifact generation when no target module has been specified on the commandline. This is useful when doing things like generating documentation where you want to load and resolve objects across many modules.

Parameters:

definitions - the current set of definitions

Throws:

ResultException - is there are problems

IOException - if IO problems

displayHelp

void displayHelp()

Called if the help flag is found anywhere on the commandline.