com.mitchtalmadge.asciidata.table.formats

Class UTF8TableFormat

java.lang.Object

com.mitchtalmadge.asciidata.table.formats.TableFormatAbstract

com.mitchtalmadge.asciidata.table.formats.UTF8TableFormat

public class UTF8TableFormat
extends TableFormatAbstract

The default, UTF-8 based table format for ASCIITable. Uses double pipes in most cases.

Author:

JakeWharton, MitchTalmadge

Constructor Summary

Constructors

Constructor and Description
UTF8TableFormat()

Method Summary

Modifier and Type	Method and Description
char	getBottomEdgeBorderDivider()
char	getBottomLeftCorner()
char	getBottomRightCorner()
char	getCross(boolean underHeaders, boolean emptyData)
char	getHorizontalBorderFill(boolean edge, boolean underHeaders)
char	getLeftEdgeBorderDivider(boolean underHeaders)
char	getRightEdgeBorderDivider(boolean underHeaders)
char	getTopEdgeBorderDivider()
char	getTopLeftCorner()
char	getTopRightCorner()
char	getVerticalBorderFill(boolean edge)

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8TableFormat

public UTF8TableFormat()

Method Detail

getTopLeftCorner

public char getTopLeftCorner()

Specified by:

getTopLeftCorner in class TableFormatAbstract

Returns:

The top left corner of the table. Ex: ╔

getTopRightCorner

public char getTopRightCorner()

Specified by:

getTopRightCorner in class TableFormatAbstract

Returns:

The top right corner of the table. Ex: ╗

getBottomLeftCorner

public char getBottomLeftCorner()

Specified by:

getBottomLeftCorner in class TableFormatAbstract

Returns:

The bottom left corner of the table. Ex: ╚

getBottomRightCorner

public char getBottomRightCorner()

Specified by:

getBottomRightCorner in class TableFormatAbstract

Returns:

The bottom right corner of the table. Ex: ╝

getTopEdgeBorderDivider

public char getTopEdgeBorderDivider()

Specified by:

getTopEdgeBorderDivider in class TableFormatAbstract

Returns:

The character used when dividing columns on the top edge of the table. Ex: ╤

getBottomEdgeBorderDivider

public char getBottomEdgeBorderDivider()

Specified by:

getBottomEdgeBorderDivider in class TableFormatAbstract

Returns:

The character used when dividing columns on the bottom edge of the table. Ex: ╧

getLeftEdgeBorderDivider

public char getLeftEdgeBorderDivider(boolean underHeaders)

Specified by:

getLeftEdgeBorderDivider in class TableFormatAbstract

Parameters:

underHeaders - True if the border is directly between the headers of the table and the first row.

Returns:

The character used when dividing rows on the left edge of the table. Ex: ╠ under the headers, and ╟ everywhere else.

getRightEdgeBorderDivider

public char getRightEdgeBorderDivider(boolean underHeaders)

Specified by:

getRightEdgeBorderDivider in class TableFormatAbstract

Parameters:

underHeaders - True if the border is directly between the headers of the table and the first row.

Returns:

The character used when dividing rows on the right edge of the table. Ex: ╣ under the headers, and ╢ everywhere else.

getHorizontalBorderFill

public char getHorizontalBorderFill(boolean edge,
                                    boolean underHeaders)

Specified by:

getHorizontalBorderFill in class TableFormatAbstract

Parameters:

edge - True if the border is on the top or bottom edge of the table.

underHeaders - True if the border is directly between the headers of the table and the first row.

Returns:

The character used for horizontal stretches in the table. Ex: ═ for edges and under the headers, and ─ everywhere else.

getVerticalBorderFill

public char getVerticalBorderFill(boolean edge)

Specified by:

getVerticalBorderFill in class TableFormatAbstract

Parameters:

edge - True if the border is on the left or right edge of the table.

Returns:

The character used for vertical stretches in the table. Ex: ║ for edges, and │ everywhere else.

getCross

public char getCross(boolean underHeaders,
                     boolean emptyData)

Specified by:

getCross in class TableFormatAbstract

Parameters:

underHeaders - True if the border is directly between the headers of the table and the first row.

emptyData - True if the table has no data. In this case it can be more aesthetically pleasing to use a bottom edge divider to provide a flat surface for the bottom of the border. (The cross will only appear under the headers at this point, so underHeaders is true when emptyData is true).

Returns:

The character used where horizontal and vertical borders intersect. Ex: ╪ under the headers, ╧ when table has no data, and ┼ everywhere else.