io.bretty.console.table

Class ColumnFormatter<T>

java.lang.Object

io.bretty.console.table.ColumnFormatter<T>

Type Parameters:

T -

public abstract class ColumnFormatter<T>
extends Object

The ColumnFormatter class represents a certain format of an logical column in a table. For example, the format can be percentage, currency, plain text, ect.

Author:

Nathaniel

Field Summary

Fields

Modifier and Type	Field and Description
protected Alignment	al
protected int	width

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ColumnFormatter()
protected	ColumnFormatter(Alignment al, int width)

Method Summary

Modifier and Type	Method and Description
static ColumnFormatter<Number>	currency(Alignment al, int width, Precision p, String symbol) Get a built-in ColumnFormatter for currency values.
static ColumnFormatter<Date>	dateTime(Alignment al, int width, DateFormat df) Get a built-in ColumnFormatter for date and time
abstract String	format(T t) Format an object of T type into a String
protected String	formatString(String s, int width)
static <T> String	formatText(ColumnFormatter<T> cf, String s) Format a string using the Alignment and width of an existing ColumnFormatter for any type
Alignment	getAlignment()
int	getWidth()
static ColumnFormatter<Number>	number(Alignment al, int width, Precision p) Get a built-in ColumnFormatter for plain numbers
static ColumnFormatter<Number>	percentage(Alignment al, int width, Precision p) Get a built-in ColumnFormatter for percentage values
static ColumnFormatter<String>	text(Alignment al, int width) Get a built-in ColumnFormatter for plain texts
static <T> ColumnFormatter<String>	text(ColumnFormatter<T> cf) Get a ColumnFormatter object using the Alignment and width of an existing ColumnFormatter of any type

Methods inherited from class java.lang.Object

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

Field Detail

al

protected Alignment al

width

protected int width

Constructor Detail

ColumnFormatter

protected ColumnFormatter()

ColumnFormatter

protected ColumnFormatter(Alignment al,
                          int width)

Method Detail

currency

public static ColumnFormatter<Number> currency(Alignment al,
                                               int width,
                                               Precision p,
                                               String symbol)

Get a built-in ColumnFormatter for currency values.

Parameters:

al - See enum Alignment

width - An integer as the width of the column

p - See enum Precision

symbol - A string as the currency symbol. If the symbol length is greater than 1, there will be a space between the symbol and the number.

Returns:

A ColumnFormatter object

dateTime

public static ColumnFormatter<Date> dateTime(Alignment al,
                                             int width,
                                             DateFormat df)

Get a built-in ColumnFormatter for date and time

Parameters:

al - See enum Alignment

width - An integer as the width of the column

df - See java.text.DateFormat

Returns:

A ColumnFormatter for datetime objects

formatText

public static <T> String formatText(ColumnFormatter<T> cf,
                                    String s)

Format a string using the Alignment and width of an existing ColumnFormatter for any type

Type Parameters:

T - the class of the objects in the column

Parameters:

cf - An existing ColumnFormatter of any type

s - The input String to be formatted

Returns:

The result String

number

public static ColumnFormatter<Number> number(Alignment al,
                                             int width,
                                             Precision p)

Get a built-in ColumnFormatter for plain numbers

Parameters:

al - See enum Alignment

width - An integer as the width of the column

p - See enum Precision

Returns:

A ColumnFormatter for Number objects

percentage

public static ColumnFormatter<Number> percentage(Alignment al,
                                                 int width,
                                                 Precision p)

Get a built-in ColumnFormatter for percentage values

Parameters:

al - See enum Alignment

width - An integer as the width of the column

p - See enum Precision

Returns:

a ColumnFormatter for percentage numbers

text

public static ColumnFormatter<String> text(Alignment al,
                                           int width)

Get a built-in ColumnFormatter for plain texts

Parameters:

al - See enum Alignment

width - An integer as the width of the column

Returns:

a ColumnFormatter for String objects

text

public static <T> ColumnFormatter<String> text(ColumnFormatter<T> cf)

Get a ColumnFormatter object using the Alignment and width of an existing ColumnFormatter of any type

Type Parameters:

T - the class of the column objects

Parameters:

cf - An existing ColumnFormatter

Returns:

a ColumnFormatter for String objects

format

public abstract String format(T t)

Format an object of T type into a String

Parameters:

t - An object of T type

Returns:

A formatted String

formatString

protected String formatString(String s,
                              int width)

getAlignment

public final Alignment getAlignment()

Returns:

the Alignment of this ColumnFormatter

getWidth

public final int getWidth()

Returns:

the width of the ColumnFormatter