|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Outlet
Generates String output from the AST.
| Method Summary | |
|---|---|
void |
addMergepointMapping(MergepointMapping mergepointMapping)
Adds an mergepoint mapping to the outlet. |
void |
afterExecute(ControllerState controllerState)
Adjusts the state of the Controller after generation. |
void |
beforeExecute(ControllerState controllerState)
Adjusts the state of the Controller before generation. |
OutletResult |
execute(ControllerState controllerState)
Generates the output for this template into the Generated object. |
String |
getInputElementName()
Returns the name of the input root element. |
MergepointMapping |
getMergepointMapping(String name)
Returns the mergepoint mapping for the given mergepoint name. |
Map<String,MergepointMapping> |
getMergepointMappings()
Returns the map of all mergepoint mappings, keyed by their name. |
QualifiedName |
getName()
Returns the name of the outlet. |
void |
setInputElementName(String inputName)
Sets the name of the input root element. |
MergepointMapping |
setMergepointMapping(MergepointMapping mergepointMapping)
Sets an mergepoint mapping in the outlet. |
| Method Detail |
|---|
QualifiedName getName()
void addMergepointMapping(MergepointMapping mergepointMapping)
throws ConfigurationException
mergepointMapping - the mergepointMapping to add, not null.
NullPointerException - if mergepointMapping is null.
ConfigurationException - if an mergepointMapping
for the given name already exists.MergepointMapping setMergepointMapping(MergepointMapping mergepointMapping)
mergepointMapping - the mergepointMapping to add, not null.
NullPointerException - if mergepointMapping is null.MergepointMapping getMergepointMapping(String name)
name - the name of the mergepoint mapping.
Map<String,MergepointMapping> getMergepointMappings()
void setInputElementName(String inputName)
inputName - the name of the root element of the source,
or null to accept any input name.String getInputElementName()
void beforeExecute(ControllerState controllerState)
throws GeneratorException
controllerState - the current controller state, not null.
GeneratorException - if adjusting the controller state fails.
void afterExecute(ControllerState controllerState)
throws GeneratorException
controllerState - the current controller state, not null.
GeneratorException - if adjusting the controller state fails.
OutletResult execute(ControllerState controllerState)
throws GeneratorException
controllerState - the current controller state, not null.
GeneratorException - if generation fails.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||