Module io.helidon.codegen.classmodel
Package io.helidon.codegen.classmodel

Class Javadoc.Builder

java.lang.Object
io.helidon.codegen.classmodel.Javadoc.Builder
All Implemented Interfaces:
Builder<Javadoc.Builder,Javadoc>, Supplier<Javadoc>
Enclosing class:
Javadoc
public static final class Javadoc.Builder extends Object
Fluent API builder for Javadoc.

  • Method Details

    • build

      public Javadoc build()
      Description copied from interface: Builder
      Build the instance from this builder.
      Returns:
      instance of the built type

    • addLine

      public Javadoc.Builder addLine(String line)
      Add text line to the content. New line character is added after this line.
      Parameters:
      line - line to add
      Returns:
      updated builder instance

    • add

      public Javadoc.Builder add(String line)
      Add text line to the content. New line character is not added after this line, so all newly added text will be appended to the same line.
      Parameters:
      line - line to add
      Returns:
      updated builder instance

    • content

      public Javadoc.Builder content(List<String> content)
      Set new content. This method replaces previously created content in this builder.
      Parameters:
      content - content to be set
      Returns:
      updated builder instance

    • addParameter

      public Javadoc.Builder addParameter(String paramName, String description)
      Add parameter tag name and description.
      Parameters:
      paramName - parameter name
      description - parameter description
      Returns:
      updated builder instance

    • addParameter

      public Javadoc.Builder addParameter(String paramName, List<String> description)
      Add parameter tag name and description.
      Parameters:
      paramName - parameter name
      description - parameter description
      Returns:
      updated builder instance

    • addThrows

      public Javadoc.Builder addThrows(String exception, List<String> description)
      Add throws tag name and description.
      Parameters:
      exception - exception name
      description - exception description
      Returns:
      updated builder instance

    • addTag

      public Javadoc.Builder addTag(String tag, String description)
      Add throws tag name and description.
      Parameters:
      tag - tag name
      description - tag description
      Returns:
      updated builder instance

    • addTag

      public Javadoc.Builder addTag(String tag, List<String> description)
      Add throws tag name and description.
      Parameters:
      tag - tag name
      description - tag description
      Returns:
      updated builder instance

    • returnDescription

      public Javadoc.Builder returnDescription(String returnDescription)
      Add return type description.
      Parameters:
      returnDescription - return type description
      Returns:
      updated builder instance

    • returnDescription

      public Javadoc.Builder returnDescription(List<String> returnDescription)
      Add return type description.
      Parameters:
      returnDescription - return type description
      Returns:
      updated builder instance

    • addGenericArgument

      public Javadoc.Builder addGenericArgument(String argument, List<String> description)
      Add generic argument tag name and description.
      Parameters:
      argument - parameter name
      description - parameter description
      Returns:
      updated builder instance

    • addGenericArgument

      public Javadoc.Builder addGenericArgument(String argument, String description)
      Add generic argument tag name and description.
      Parameters:
      argument - parameter name
      description - parameter description
      Returns:
      updated builder instance

    • deprecation

      public Javadoc.Builder deprecation(String deprecation)
      Deprecation description.
      Parameters:
      deprecation - deprecation description
      Returns:
      updated builder instance

    • deprecation

      public Javadoc.Builder deprecation(List<String> deprecation)
      Deprecation description, multiple lines.
      Parameters:
      deprecation - deprecation description
      Returns:
      updated builder instance

    • generate

      public Javadoc.Builder generate(boolean generate)
      Whether to generate this javadoc.
      Parameters:
      generate - generate javadoc
      Returns:
      updated builder instance

    • from

      public Javadoc.Builder from(Javadoc javadoc)
      Populate this builder with content of the already created Javadoc instance.
      Parameters:
      javadoc - already created javadoc instance
      Returns:
      updated builder instance

    • clear

      public Javadoc.Builder clear()
      Remove everything from this builder.
      Returns:
      updated builder instance

    • parse

      public Javadoc.Builder parse(String fullJavadocString)
      Populates this builder with the parsed javadoc data.
      Parameters:
      fullJavadocString - string format javadoc
      Returns:
      updated builder instance

    • parse

      public Javadoc.Builder parse(List<String> fullJavadocLines)
      Populates this builder with the parsed javadoc data.
      Parameters:
      fullJavadocLines - string list format javadoc
      Returns:
      updated builder instance

    • includeImport

      public Javadoc.Builder includeImport(boolean includeImport)
      Whether to include import type information among the imports.
      Parameters:
      includeImport - whether imports should be included
      Returns:
      updated builder instance