Class JavadocOutlet

java.lang.Object
org.apache.torque.generator.outlet.OutletImpl
org.apache.torque.generator.outlet.java.JavadocOutlet
All Implemented Interfaces:
Outlet

public class JavadocOutlet extends OutletImpl
An outlet for creating correctly formatted javadoc.
Version:
$Id: JavadocOutlet.java 1855923 2019-03-20 16:19:39Z gk $
  • Field Details

    • BODY_MERGEPOINT_NAME

      public static final String BODY_MERGEPOINT_NAME
      The name of the mergepoint which output is used as javadoc body.
      See Also:
    • ATTRIBUTES_MERGEPOINT_NAME

      public static final String ATTRIBUTES_MERGEPOINT_NAME
      The name of the mergepoint which contains the javadoc attributes.
      See Also:
  • Constructor Details

    • JavadocOutlet

      public JavadocOutlet(QualifiedName qualifiedName)
      Constructor.
      Parameters:
      qualifiedName - the qualified name of the outlet, not null.
  • Method Details

    • execute

      public OutletResult execute(ControllerState controllerState) throws GeneratorException
      Description copied from interface: Outlet
      Generates the output for this template into the Generated object.
      Specified by:
      execute in interface Outlet
      Specified by:
      execute in class OutletImpl
      Parameters:
      controllerState - the current controller state, not null.
      Returns:
      the output of the Outlet.
      Throws:
      GeneratorException - if generation fails.
    • getLineBreak

      public String getLineBreak()
    • setLineBreak

      public void setLineBreak(String lineBreak)
    • getMaxLineLength

      public int getMaxLineLength()
    • setMaxLineLength

      public void setMaxLineLength(int maxLineLength)
    • getIndent

      public String getIndent()
    • setIndent

      public void setIndent(String indent)
    • getRemovableWrapCharacters

      public String getRemovableWrapCharacters()
    • setRemovableWrapCharacters

      public void setRemovableWrapCharacters(String removableWrapCharacters)
    • getWrapAfterCharacters

      public String getWrapAfterCharacters()
    • setWrapAfterCharacters

      public void setWrapAfterCharacters(String wrapAfterCharacters)