Class JavadocOutlet
java.lang.Object
org.apache.torque.generator.outlet.OutletImpl
org.apache.torque.generator.outlet.java.JavadocOutlet
- All Implemented Interfaces:
Outlet
An outlet for creating correctly formatted javadoc.
- Version:
- $Id: JavadocOutlet.java 1855923 2019-03-20 16:19:39Z gk $
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute(ControllerState controllerState) Generates the output for this template into the Generated object.intvoidvoidsetLineBreak(String lineBreak) voidsetMaxLineLength(int maxLineLength) voidsetRemovableWrapCharacters(String removableWrapCharacters) voidsetWrapAfterCharacters(String wrapAfterCharacters) Methods inherited from class org.apache.torque.generator.outlet.OutletImpl
addMergepointMapping, afterExecute, beforeExecute, getInputClass, getInputElementName, getMergepointMapping, getMergepointMappings, getName, getVariable, mergepoint, setInputClass, setInputElementName, setMergepointMapping, setVariable, setVariable, toString
-
Field Details
-
BODY_MERGEPOINT_NAME
The name of the mergepoint which output is used as javadoc body.- See Also:
-
ATTRIBUTES_MERGEPOINT_NAME
The name of the mergepoint which contains the javadoc attributes.- See Also:
-
-
Constructor Details
-
JavadocOutlet
Constructor.- Parameters:
qualifiedName- the qualified name of the outlet, not null.
-
-
Method Details
-
execute
Description copied from interface:OutletGenerates the output for this template into the Generated object.- Specified by:
executein interfaceOutlet- Specified by:
executein classOutletImpl- Parameters:
controllerState- the current controller state, not null.- Returns:
- the output of the Outlet.
- Throws:
GeneratorException- if generation fails.
-
getLineBreak
-
setLineBreak
-
getMaxLineLength
public int getMaxLineLength() -
setMaxLineLength
public void setMaxLineLength(int maxLineLength) -
getIndent
-
setIndent
-
getRemovableWrapCharacters
-
setRemovableWrapCharacters
-
getWrapAfterCharacters
-
setWrapAfterCharacters
-