Package com._1c.g5.v8.dt.bsl.documentation.comment

Class BslDocCommentSerializer.Builder

java.lang.Object
com._1c.g5.v8.dt.bsl.documentation.comment.BslDocCommentSerializer.Builder
Enclosing class:
BslDocCommentSerializer
public static final class BslDocCommentSerializer.Builder extends Object
The configuration builder of serializer

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public BslDocCommentSerializer build()
      Builds new serializer with build configuration.
      Returns:
      the bsl doc comment serializer

    • sectionSpace

      public BslDocCommentSerializer.Builder sectionSpace(int sectionSpace)
      Sets the line numbers of space between sections. Default is 2.
      Parameters:
      sectionSpace - the section space, must be more then 0.
      Returns:
      the builder

    • ignoreLineNumbers

      public BslDocCommentSerializer.Builder ignoreLineNumbers()
      Set Ignore line numbers of the model and make defaul line fomatting.
      Returns:
      the builder

    • oldFormat

      public BslDocCommentSerializer.Builder oldFormat()
      Sets the string presentation must be in old format
      Returns:
      the builder

    • newFormat

      public BslDocCommentSerializer.Builder newFormat()
      Sets the string presentation must be in new format.
      Returns:
      the builder

    • alignFields

      public BslDocCommentSerializer.Builder alignFields()
      Align fields of type definition field extention to the parent element indentaion.
      Returns:
      the builder

    • alignFields

      public BslDocCommentSerializer.Builder alignFields(boolean alignFields)
      Sets that it need to align fieldsof type section to type name position.
      Parameters:
      alignFields - true, if need to align fields, otherwise start field from begin of line
      Returns:
      the builder

    • linkInBrackets

      public BslDocCommentSerializer.Builder linkInBrackets()
      Sets the link need to serialize in brackets.
      Returns:
      the builder

    • lineSeparator

      public BslDocCommentSerializer.Builder lineSeparator(String lineSeparator)
      Sets the line separator.
      Parameters:
      lineSeparator - the new line separator, cannot be null.
      Returns:
      the builder

    • setScriptVariant

      public BslDocCommentSerializer.Builder setScriptVariant(boolean isRussian)
      Sets the script variant of documentation comment model presentation.
      Parameters:
      isRussian - true if it need Russian, otherwise is English
      Returns:
      the builder

    • setScriptVariant

      public BslDocCommentSerializer.Builder setScriptVariant(ScriptVariant variant)
      Sets the script variant of documentation comment model presentation.
      Parameters:
      variant - the script variant, cannot be null.
      Returns:
      the builder

    • setOldFormat

      public BslDocCommentSerializer.Builder setOldFormat(boolean oldFormat)
      Sets the string presentation must be in old format or in new format.
      Parameters:
      oldFormat - true if string presentation must be in old format, false in new format