io.bretty.console.table

Enum Alignment

java.lang.Object

java.lang.Enum<Alignment>

io.bretty.console.table.Alignment

All Implemented Interfaces:

Serializable, Comparable<Alignment>

public enum Alignment
extends Enum<Alignment>

The Alignment enum represents the alignment options of a String with a given width

Author:

Nathaniel

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER The center alignment
LEFT The left alignment
RIGHT The right alignment

Method Summary

Modifier and Type	Method and Description
abstract String	format(String input, int width, char pad) Format a String as the given alignment.
static Alignment	valueOf(String name) Returns the enum constant of this type with the specified name.
static Alignment[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final Alignment LEFT

The left alignment

RIGHT

public static final Alignment RIGHT

The right alignment

CENTER

public static final Alignment CENTER

The center alignment

Method Detail

values

public static Alignment[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Alignment c : Alignment.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Alignment valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

format

public abstract String format(String input,
                              int width,
                              char pad)

Format a String as the given alignment. If the input String is longer than the result width, it will be truncated. If the input String is shorter than the result width, char p will be used for padding.

Parameters:

input - The string to be formatted

width - The width of the result String

pad - Used for padding

Returns:

The result String