Module org.jooq
Package org.jooq

Class TXTFormat

java.lang.Object
org.jooq.TXTFormat
public final class TXTFormat extends Object
A text formatting type, which can be used to configure text imports / exports.

The type is immutable, meaning calls to setters like maxRows(int) do not modify the original reference, but return a new one instead.

Author:
Lukas Eder

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TXTFormat
    DEFAULT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TXTFormat()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    horizontalCellBorder()
    Whether the horizontal cell border (line between data cells) should be displayed.
    @NotNull TXTFormat
    horizontalCellBorder(boolean newHorizontalCellBorder)
    Whether the horizontal cell border (line between data cells) should be displayed.
    boolean
    horizontalHeaderBorder()
    Whether the horizontal header border (line between header and data cells) should be displayed.
    @NotNull TXTFormat
    horizontalHeaderBorder(boolean newHorizontalHeaderBorder)
    Whether the horizontal header border (line between header and data cells) should be displayed.
    boolean
    horizontalTableBorder()
    Whether the horizontal table border (top and bottom line) should be displayed.
    @NotNull TXTFormat
    horizontalTableBorder(boolean newHorizontalTableBorder)
    Whether the horizontal table border (top and bottom line) should be displayed.
    boolean
    intersectLines()
    Whether horizontal and vertical lines should be intersected with a '+' symbol.
    @NotNull TXTFormat
    intersectLines(boolean newIntersectLines)
    Whether horizontal and vertical lines should be intersected with a '+' symbol.
    int
    maxColWidth()
    The maximum column width, defaulting to no limit.
    @NotNull TXTFormat
    maxColWidth(int newMaxColWidth)
    The minimum column width, defaulting to no limit.
    int
    maxRows()
    The maximum number of rows to be included in the format, defaulting to all rows.
    @NotNull TXTFormat
    maxRows(int newMaxRows)
    The maximum number of rows to be included in the format, defaulting to all rows.
    int
    minColWidth()
    The minimum column width, defaulting to 4
    @NotNull TXTFormat
    minColWidth(int newMinColWidth)
    The minimum column width, defaulting to 4
    boolean
    verticalCellBorder()
    Whether the vertical cell borders (lines between data cells) should be displayed.
    @NotNull TXTFormat
    verticalCellBorder(boolean newVerticalCellBorder)
    Whether the vertical cell borders (lines between data cells) should be displayed.
    boolean
    verticalTableBorder()
    Whether the vertical table border (left and right most lines) should be displayed.
    @NotNull TXTFormat
    verticalTableBorder(boolean newVerticalTableBorder)
    Whether the vertical table border (left and right most lines) should be displayed.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT

      public static final TXTFormat DEFAULT

  • Constructor Details

    • TXTFormat

      public TXTFormat()

  • Method Details

    • maxRows

      @NotNull public @NotNull TXTFormat maxRows(int newMaxRows)
      The maximum number of rows to be included in the format, defaulting to all rows.

    • maxRows

      public int maxRows()
      The maximum number of rows to be included in the format, defaulting to all rows.

    • minColWidth

      @NotNull public @NotNull TXTFormat minColWidth(int newMinColWidth)
      The minimum column width, defaulting to 4

    • minColWidth

      public int minColWidth()
      The minimum column width, defaulting to 4

    • maxColWidth

      @NotNull public @NotNull TXTFormat maxColWidth(int newMaxColWidth)
      The minimum column width, defaulting to no limit.

    • maxColWidth

      public int maxColWidth()
      The maximum column width, defaulting to no limit.

    • horizontalTableBorder

      @NotNull public @NotNull TXTFormat horizontalTableBorder(boolean newHorizontalTableBorder)
      Whether the horizontal table border (top and bottom line) should be displayed.

    • horizontalTableBorder

      public boolean horizontalTableBorder()
      Whether the horizontal table border (top and bottom line) should be displayed.

    • horizontalHeaderBorder

      @NotNull public @NotNull TXTFormat horizontalHeaderBorder(boolean newHorizontalHeaderBorder)
      Whether the horizontal header border (line between header and data cells) should be displayed.

    • horizontalHeaderBorder

      public boolean horizontalHeaderBorder()
      Whether the horizontal header border (line between header and data cells) should be displayed.

    • horizontalCellBorder

      @NotNull public @NotNull TXTFormat horizontalCellBorder(boolean newHorizontalCellBorder)
      Whether the horizontal cell border (line between data cells) should be displayed.

    • horizontalCellBorder

      public boolean horizontalCellBorder()
      Whether the horizontal cell border (line between data cells) should be displayed.

    • verticalTableBorder

      @NotNull public @NotNull TXTFormat verticalTableBorder(boolean newVerticalTableBorder)
      Whether the vertical table border (left and right most lines) should be displayed.

    • verticalTableBorder

      public boolean verticalTableBorder()
      Whether the vertical table border (left and right most lines) should be displayed.

    • verticalCellBorder

      @NotNull public @NotNull TXTFormat verticalCellBorder(boolean newVerticalCellBorder)
      Whether the vertical cell borders (lines between data cells) should be displayed.

    • verticalCellBorder

      public boolean verticalCellBorder()
      Whether the vertical cell borders (lines between data cells) should be displayed.

    • intersectLines

      @NotNull public @NotNull TXTFormat intersectLines(boolean newIntersectLines)
      Whether horizontal and vertical lines should be intersected with a '+' symbol.

    • intersectLines

      public boolean intersectLines()
      Whether horizontal and vertical lines should be intersected with a '+' symbol.