Class DebuggingOutletWrapper
java.lang.Object
org.apache.torque.generator.outlet.DebuggingOutletWrapper
- All Implemented Interfaces:
Outlet
An outlet wrapper which adds debug information to the outlet.
- Version:
- $Id: $
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddMergepointMapping(MergepointMapping mergepointMapping) Adds the mergepoint mapping to the delegate.voidafterExecute(ControllerState controllerState) Calls the afterExecute method in the delegate.voidbeforeExecute(ControllerState controllerState) Calls the beforeExecute method in the delegate.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 StringgetCommentAtEnd(ControllerState controllerState) Returns the debug information to be added at the end of the outlet's output.protected StringgetCommentAtStart(ControllerState controllerState) Returns the debug information to be added at the start of the outlet's output.Returns the class name of the input root object from the delegate.Returns the name of the input root element from the delegate.getMergepointMapping(String name) Retrieves the mergepoint mapping for the given mergepoint name from the delegate and returns it.Returns the map of all mergepoint mappings in the delegate, keyed by their name.getName()Returns the name of the delegate.voidsetInputClass(String className) Sets the class name of the input root object in the delegate.voidsetInputElementName(String inputName) Sets the name of the input root element in the delegate.setMergepointMapping(MergepointMapping mergepointMapping) Sets an mergepoint mapping in the delegate.
-
Constructor Details
-
DebuggingOutletWrapper
Constructor.- Parameters:
delegate- the wrapped outlet, not null.
-
-
Method Details
-
getName
Returns the name of the delegate. -
addMergepointMapping
Adds the mergepoint mapping to the delegate.- Specified by:
addMergepointMappingin interfaceOutlet- Parameters:
mergepointMapping- the mergepoint mapping to add, not null.- Throws:
NullPointerException- if mergepointMapping is null.ConfigurationException- if an mergepointMapping for the given name already exists.
-
setMergepointMapping
Sets an mergepoint mapping in the delegate.- Specified by:
setMergepointMappingin interfaceOutlet- Parameters:
mergepointMapping- the mergepointMapping to add, not null.- Returns:
- the replaced mergepoint mapping, not null.
- Throws:
NullPointerException- if mergepointMapping is null.
-
getMergepointMapping
Retrieves the mergepoint mapping for the given mergepoint name from the delegate and returns it.- Specified by:
getMergepointMappingin interfaceOutlet- Parameters:
name- the name of the mergepoint mapping.- Returns:
- the mergepoint mapping for the given name, or null if no mergepoint mapping exists for this name.
-
getMergepointMappings
Returns the map of all mergepoint mappings in the delegate, keyed by their name.- Specified by:
getMergepointMappingsin interfaceOutlet- Returns:
- the map of mergepoint mappings, not null.
-
setInputElementName
Sets the name of the input root element in the delegate.- Specified by:
setInputElementNamein interfaceOutlet- Parameters:
inputName- the name of the root element of the source, or null to accept any input name.
-
getInputElementName
Returns the name of the input root element from the delegate.- Specified by:
getInputElementNamein interfaceOutlet- Returns:
- the name of the root element of the source, or null if any input name is accepted.
-
setInputClass
Sets the class name of the input root object in the delegate.- Specified by:
setInputClassin interfaceOutlet- Parameters:
className- the class name of the root object of the source, or null to accept any object class.
-
getInputClass
Returns the class name of the input root object from the delegate.- Specified by:
getInputClassin interfaceOutlet- Returns:
- the class name of the root object of the source, or null if any object class is accepted.
-
beforeExecute
Calls the beforeExecute method in the delegate.- Specified by:
beforeExecutein interfaceOutlet- Parameters:
controllerState- the current controller state, not null.- Throws:
GeneratorException- if adjusting the controller state fails.
-
afterExecute
Calls the afterExecute method in the delegate.- Specified by:
afterExecutein interfaceOutlet- Parameters:
controllerState- the current controller state, not null.- Throws:
GeneratorException- if adjusting the controller state fails.
-
execute
Executes the delegate generation and adds debugging output before and after the generated content, if the result is a String result.- Specified by:
executein interfaceOutlet- Parameters:
controllerState- the current controller state, not null.- Returns:
- the result of the generation plus possibly debugging information.
- Throws:
GeneratorException- if adjusting the controller state fails.
-
getCommentAtStart
Returns the debug information to be added at the start of the outlet's output.- Parameters:
controllerState- The current controller state, not null.- Returns:
- the debug information, not null.
-
getCommentAtEnd
Returns the debug information to be added at the end of the outlet's output.- Parameters:
controllerState- The current controller state, not null.- Returns:
- the debug information, not null.
-