fr.cnes.sirius.patrius.utils

Enum StringTablePrinter.StringAlign

java.lang.Object

java.lang.Enum<StringTablePrinter.StringAlign>

fr.cnes.sirius.patrius.utils.StringTablePrinter.StringAlign

All Implemented Interfaces:

Serializable, Comparable<StringTablePrinter.StringAlign>

Enclosing class:

StringTablePrinter

public static enum StringTablePrinter.StringAlign
extends Enum<StringTablePrinter.StringAlign>

Text alignment enumerate.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER Align the text at the center.
LEFT Align the text on the left.
RIGHT Align the text on the right.

Method Summary

Modifier and Type	Method and Description
protected abstract String	internalPadding(String value, int valueLength, int width) Returns the provided String with spaces to match the expected width (internal method without verification).
String	pad(String value, int width) Returns the provided String with spaces to match the expected width.
static StringTablePrinter.StringAlign	valueOf(String name) Returns the enum constant of this type with the specified name.
static StringTablePrinter.StringAlign[]	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 StringTablePrinter.StringAlign LEFT

Align the text on the left.

RIGHT

public static final StringTablePrinter.StringAlign RIGHT

Align the text on the right.

CENTER

public static final StringTablePrinter.StringAlign CENTER

Align the text at the center.

Method Detail

values

public static StringTablePrinter.StringAlign[] 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 (StringTablePrinter.StringAlign c : StringTablePrinter.StringAlign.values())
    System.out.println(c);

Returns:

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

valueOf

public static StringTablePrinter.StringAlign 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

pad

public String pad(String value,
                  int width)

Returns the provided String with spaces to match the expected width.

Parameters:

value - The String to pad

width - The final length of the String to reach

Returns:

the String with expected length of characters

Throws:

IllegalStateException - if the provided String exceeds the provided target width

internalPadding

protected abstract String internalPadding(String value,
                                          int valueLength,
                                          int width)

Returns the provided String with spaces to match the expected width (internal method without verification).

Parameters:

value - The String to pad

valueLength - The String length

width - The final length of the String to reach

Returns:

the String with expected length of characters