|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.torque.generator.outlet.DebuggingOutletWrapper
public class DebuggingOutletWrapper
An outlet wrapper which adds debug information to the outlet.
Constructor Summary | |
---|---|
DebuggingOutletWrapper(Outlet delegate)
Constructor. |
Method Summary | |
---|---|
void |
addMergepointMapping(MergepointMapping mergepointMapping)
Adds the mergepoint mapping to the delegate. |
void |
afterExecute(ControllerState controllerState)
Calls the afterExecute method in the delegate. |
void |
beforeExecute(ControllerState controllerState)
Calls the beforeExecute method in the delegate. |
OutletResult |
execute(ControllerState controllerState)
Executes the delegate generation and adds debugging output before and after the generated content, if the result is a String result. |
protected String |
getCommentAtEnd(ControllerState controllerState)
Returns the debug information to be added at the end of the outlet's output. |
protected String |
getCommentAtStart(ControllerState controllerState)
Returns the debug information to be added at the start of the outlet's output. |
String |
getInputElementName()
Returns the name of the input root element from the delegate. |
MergepointMapping |
getMergepointMapping(String name)
Retrieves the mergepoint mapping for the given mergepoint name from the delegate and returns it. |
Map<String,MergepointMapping> |
getMergepointMappings()
Returns the map of all mergepoint mappings in the delegate, keyed by their name. |
QualifiedName |
getName()
Returns the name of the delegate. |
void |
setInputElementName(String inputName)
Sets the name of the input root element in the delegate. |
MergepointMapping |
setMergepointMapping(MergepointMapping mergepointMapping)
Sets an mergepoint mapping in the delegate. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DebuggingOutletWrapper(Outlet delegate)
delegate
- the wrapped outlet, not null.Method Detail |
---|
public QualifiedName getName()
getName
in interface Outlet
public void addMergepointMapping(MergepointMapping mergepointMapping) throws ConfigurationException
addMergepointMapping
in interface Outlet
mergepointMapping
- the mergepoint mapping to add, not null.
NullPointerException
- if mergepointMapping is null.
ConfigurationException
- if an mergepointMapping
for the given name already exists.public MergepointMapping setMergepointMapping(MergepointMapping mergepointMapping)
setMergepointMapping
in interface Outlet
mergepointMapping
- the mergepointMapping to add, not null.
NullPointerException
- if mergepointMapping is null.public MergepointMapping getMergepointMapping(String name)
getMergepointMapping
in interface Outlet
name
- the name of the mergepoint mapping.
public Map<String,MergepointMapping> getMergepointMappings()
getMergepointMappings
in interface Outlet
public void setInputElementName(String inputName)
setInputElementName
in interface Outlet
inputName
- the name of the root element of the source,
or null to accept any input name.public String getInputElementName()
getInputElementName
in interface Outlet
public void beforeExecute(ControllerState controllerState) throws GeneratorException
beforeExecute
in interface Outlet
controllerState
- the current controller state, not null.
GeneratorException
- if adjusting the controller state fails.public void afterExecute(ControllerState controllerState) throws GeneratorException
afterExecute
in interface Outlet
controllerState
- the current controller state, not null.
GeneratorException
- if adjusting the controller state fails.public OutletResult execute(ControllerState controllerState) throws GeneratorException
execute
in interface Outlet
controllerState
- the current controller state, not null.
GeneratorException
- if adjusting the controller state fails.protected String getCommentAtStart(ControllerState controllerState)
controllerState
- The current controller state, not null.
protected String getCommentAtEnd(ControllerState controllerState)
controllerState
- The current controller state, not null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |