Top Description Fields Constructors Methods
org.jooq

public final Class TXTFormat

extends Object
Class Inheritance
Imports
org.jetbrains.annotations.NotNull

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

Modifier and TypeField and Description
public static final TXTFormat
pack-priv final boolean
pack-priv final boolean
pack-priv final boolean
pack-priv final boolean
pack-priv final int
pack-priv final int
pack-priv final int
pack-priv final boolean
pack-priv final boolean

Constructor Summary

AccessConstructor and Description
public
private
TXTFormat(int maxRows, int minColWidth, int maxColWidth, boolean horizontalTableBorder, boolean horizontalHeaderBorder, boolean horizontalCellBorder, boolean verticalTableBorder, boolean verticalCellBorder, boolean intersectLines)

Method Summary

Modifier and TypeMethod and Description
public @NotNull TXTFormat
horizontalCellBorder(boolean newHorizontalCellBorder)

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

public boolean
horizontalCellBorder()

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

public @NotNull TXTFormat
horizontalHeaderBorder(boolean newHorizontalHeaderBorder)

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

public boolean
horizontalHeaderBorder()

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

public @NotNull TXTFormat
horizontalTableBorder(boolean newHorizontalTableBorder)

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

public boolean
horizontalTableBorder()

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

public @NotNull TXTFormat
intersectLines(boolean newIntersectLines)

Whether horizontal and vertical lines should be intersected with a '+' symbol.

public boolean
intersectLines()

Whether horizontal and vertical lines should be intersected with a '+' symbol.

public @NotNull TXTFormat
maxColWidth(int newMaxColWidth)

The minimum column width, defaulting to no limit.

public int
maxColWidth()

The maximum column width, defaulting to no limit.

public @NotNull TXTFormat
maxRows(int newMaxRows)

The maximum number of rows to be included in the format, defaulting to all rows.

public int
maxRows()

The maximum number of rows to be included in the format, defaulting to all rows.

public @NotNull TXTFormat
minColWidth(int newMinColWidth)

The minimum column width, defaulting to 4

public int
minColWidth()

The minimum column width, defaulting to 4

public @NotNull TXTFormat
verticalCellBorder(boolean newVerticalCellBorder)

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

public boolean
verticalCellBorder()

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

public @NotNull TXTFormat
verticalTableBorder(boolean newVerticalTableBorder)

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

public boolean
verticalTableBorder()

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULTback to summary
public static final TXTFormat DEFAULT
horizontalCellBorderback to summary
pack-priv final boolean horizontalCellBorder
horizontalHeaderBorderback to summary
pack-priv final boolean horizontalHeaderBorder
horizontalTableBorderback to summary
pack-priv final boolean horizontalTableBorder
intersectLinesback to summary
pack-priv final boolean intersectLines
maxColWidthback to summary
pack-priv final int maxColWidth
maxRowsback to summary
pack-priv final int maxRows
minColWidthback to summary
pack-priv final int minColWidth
verticalCellBorderback to summary
pack-priv final boolean verticalCellBorder
verticalTableBorderback to summary
pack-priv final boolean verticalTableBorder

Constructor Detail

TXTFormatback to summary
public TXTFormat()
TXTFormatback to summary
private TXTFormat(int maxRows, int minColWidth, int maxColWidth, boolean horizontalTableBorder, boolean horizontalHeaderBorder, boolean horizontalCellBorder, boolean verticalTableBorder, boolean verticalCellBorder, boolean intersectLines)

Method Detail

horizontalCellBorderback to summary
public @NotNull TXTFormat horizontalCellBorder(boolean newHorizontalCellBorder)

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

Annotations
@NotNull
horizontalCellBorderback to summary
public boolean horizontalCellBorder()

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

horizontalHeaderBorderback to summary
public @NotNull TXTFormat horizontalHeaderBorder(boolean newHorizontalHeaderBorder)

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

Annotations
@NotNull
horizontalHeaderBorderback to summary
public boolean horizontalHeaderBorder()

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

horizontalTableBorderback to summary
public @NotNull TXTFormat horizontalTableBorder(boolean newHorizontalTableBorder)

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

Annotations
@NotNull
horizontalTableBorderback to summary
public boolean horizontalTableBorder()

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

intersectLinesback to summary
public @NotNull TXTFormat intersectLines(boolean newIntersectLines)

Whether horizontal and vertical lines should be intersected with a '+' symbol.

Annotations
@NotNull
intersectLinesback to summary
public boolean intersectLines()

Whether horizontal and vertical lines should be intersected with a '+' symbol.

maxColWidthback to summary
public @NotNull TXTFormat maxColWidth(int newMaxColWidth)

The minimum column width, defaulting to no limit.

Annotations
@NotNull
maxColWidthback to summary
public int maxColWidth()

The maximum column width, defaulting to no limit.

maxRowsback to summary
public @NotNull TXTFormat maxRows(int newMaxRows)

The maximum number of rows to be included in the format, defaulting to all rows.

Annotations
@NotNull
maxRowsback to summary
public int maxRows()

The maximum number of rows to be included in the format, defaulting to all rows.

minColWidthback to summary
public @NotNull TXTFormat minColWidth(int newMinColWidth)

The minimum column width, defaulting to 4

Annotations
@NotNull
minColWidthback to summary
public int minColWidth()

The minimum column width, defaulting to 4

verticalCellBorderback to summary
public @NotNull TXTFormat verticalCellBorder(boolean newVerticalCellBorder)

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

Annotations
@NotNull
verticalCellBorderback to summary
public boolean verticalCellBorder()

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

verticalTableBorderback to summary
public @NotNull TXTFormat verticalTableBorder(boolean newVerticalTableBorder)

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

Annotations
@NotNull
verticalTableBorderback to summary
public boolean verticalTableBorder()

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