public interface Outlet
| Modifier and Type | Method and Description |
|---|---|
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 |
getInputClass()
Returns the fully qualified name of the input root class.
|
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 |
setInputClass(String inputClass)
Sets the fully qualified name of the input model root class.
|
void |
setInputElementName(String inputName)
Sets the name of the input root element.
|
MergepointMapping |
setMergepointMapping(MergepointMapping mergepointMapping)
Sets an mergepoint mapping in the outlet.
|
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()
String getInputElementName()
void setInputElementName(String inputName)
inputName - the name of the root element of the source,
or null to accept any input name.String getInputClass()
void setInputClass(String inputClass)
inputClass - the name of the root element of the source,
or null to accept any input name.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.Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.