Klasse DebuggingOutletWrapper
java.lang.Object
org.apache.torque.generator.outlet.DebuggingOutletWrapper
- Alle implementierten Schnittstellen:
Outlet
An outlet wrapper which adds debug information to the outlet.
- Version:
- $Id: $
-
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoid
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.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.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.void
setInputClass
(String className) Sets the class name of the input root object in the delegate.void
setInputElementName
(String inputName) Sets the name of the input root element in the delegate.setMergepointMapping
(MergepointMapping mergepointMapping) Sets an mergepoint mapping in the delegate.
-
Konstruktordetails
-
DebuggingOutletWrapper
Constructor.- Parameter:
delegate
- the wrapped outlet, not null.
-
-
Methodendetails
-
getName
Returns the name of the delegate. -
addMergepointMapping
Adds the mergepoint mapping to the delegate.- Angegeben von:
addMergepointMapping
in SchnittstelleOutlet
- Parameter:
mergepointMapping
- the mergepoint mapping to add, not null.- Löst aus:
NullPointerException
- if mergepointMapping is null.ConfigurationException
- if an mergepointMapping for the given name already exists.
-
setMergepointMapping
Sets an mergepoint mapping in the delegate.- Angegeben von:
setMergepointMapping
in SchnittstelleOutlet
- Parameter:
mergepointMapping
- the mergepointMapping to add, not null.- Gibt zurück:
- the replaced mergepoint mapping, not null.
- Löst aus:
NullPointerException
- if mergepointMapping is null.
-
getMergepointMapping
Retrieves the mergepoint mapping for the given mergepoint name from the delegate and returns it.- Angegeben von:
getMergepointMapping
in SchnittstelleOutlet
- Parameter:
name
- the name of the mergepoint mapping.- Gibt zurück:
- 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.- Angegeben von:
getMergepointMappings
in SchnittstelleOutlet
- Gibt zurück:
- the map of mergepoint mappings, not null.
-
setInputElementName
Sets the name of the input root element in the delegate.- Angegeben von:
setInputElementName
in SchnittstelleOutlet
- Parameter:
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.- Angegeben von:
getInputElementName
in SchnittstelleOutlet
- Gibt zurück:
- 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.- Angegeben von:
setInputClass
in SchnittstelleOutlet
- Parameter:
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.- Angegeben von:
getInputClass
in SchnittstelleOutlet
- Gibt zurück:
- 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.- Angegeben von:
beforeExecute
in SchnittstelleOutlet
- Parameter:
controllerState
- the current controller state, not null.- Löst aus:
GeneratorException
- if adjusting the controller state fails.
-
afterExecute
Calls the afterExecute method in the delegate.- Angegeben von:
afterExecute
in SchnittstelleOutlet
- Parameter:
controllerState
- the current controller state, not null.- Löst aus:
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.- Angegeben von:
execute
in SchnittstelleOutlet
- Parameter:
controllerState
- the current controller state, not null.- Gibt zurück:
- the result of the generation plus possibly debugging information.
- Löst aus:
GeneratorException
- if adjusting the controller state fails.
-
getCommentAtStart
Returns the debug information to be added at the start of the outlet's output.- Parameter:
controllerState
- The current controller state, not null.- Gibt zurück:
- the debug information, not null.
-
getCommentAtEnd
Returns the debug information to be added at the end of the outlet's output.- Parameter:
controllerState
- The current controller state, not null.- Gibt zurück:
- the debug information, not null.
-