Package de.haumacher.msgbuf.generator

Interface GeneratorPlugin

All Known Implementing Classes:

XmlStreamingPlugin

public interface GeneratorPlugin

Plug-in to the MessageGenerator.

Method Summary

Modifier and Type	Method	Description
default void	addInterfaces(Map<String,Option> options, MessageDef def, List<String> generalizations)	Adds interfaces to the generated type.
default GeneratorPlugin	andThen(GeneratorPlugin next)	Joins this GeneratorPlugin with the given one.
default void	init(Map<String,Option> options)	Initializes the plug-in with file options.
default FileGenerator	messageImplContents(Map<String,Option> options, MessageDef def)	Creates a FileGenerator that is expanded within the implementation class.
default FileGenerator	messageInterfaceContents(Map<String,Option> options, MessageDef def)	Creates a FileGenerator that is expanded within the interface class.
static GeneratorPlugin	none()	GeneratorPlugin that does not generate any output.

Method Detail

init

default void init(Map<String,Option> options)

Initializes the plug-in with file options.

Parameters:

options - The options of the current file to translate.

addInterfaces

default void addInterfaces(Map<String,Option> options,
                           MessageDef def,
                           List<String> generalizations)

Adds interfaces to the generated type.

Parameters:

options - The options from the top-level definition file.

def - The MessageDef that is being translated.

generalizations - The generalization list to extend.

messageInterfaceContents

default FileGenerator messageInterfaceContents(Map<String,Option> options,
                                               MessageDef def)

Creates a FileGenerator that is expanded within the interface class.

Parameters:

options - The options from the top-level definition file.

def - The MessageDef that is being translated.

messageImplContents

default FileGenerator messageImplContents(Map<String,Option> options,
                                          MessageDef def)

Creates a FileGenerator that is expanded within the implementation class.

Parameters:

options - The options from the top-level definition file.

def - The MessageDef that is being translated.

none

static GeneratorPlugin none()

GeneratorPlugin that does not generate any output.

andThen

default GeneratorPlugin andThen(GeneratorPlugin next)

Joins this GeneratorPlugin with the given one.