Apache Commons Text 1.15.0 · org.apache.commons.text.FormattableUtils

Modifier and Type	Field and Description
private static final String	SIMPLEST_FORMAT A format that simply outputs the value as a string.

Access	Constructor and Description
public	FormattableUtils() `FormattableUtils` instances should NOT be constructed in standard programming.

Method Summary

Modifier and Type	Method and Description
public static Formatter	Returns: The `formatter` instance, not null. append(final CharSequence the string to handle, not null. seq, final Formatter the destination formatter, not null. formatter, final int the flags for formatting, see `Formattable`. flags, final int the width of the output, see `Formattable`. width, final int the precision of the output, see `Formattable`. precision) Handles the common `Formattable` operations of truncate-pad-append, with no ellipsis on precision overflow, and padding width underflow with spaces.
public static Formatter	Returns: The `formatter` instance, not null. append(final CharSequence the string to handle, not null. seq, final Formatter the destination formatter, not null. formatter, final int the flags for formatting, see `Formattable`. flags, final int the width of the output, see `Formattable`. width, final int the precision of the output, see `Formattable`. precision, final char the pad character to use. padChar) Handles the common `Formattable` operations of truncate-pad-append, with no ellipsis on precision overflow.
public static Formatter	Returns: The `formatter` instance, not null. append(final CharSequence the string to handle, not null. seq, final Formatter the destination formatter, not null. formatter, final int the flags for formatting, see `Formattable`. flags, final int the width of the output, see `Formattable`. width, final int the precision of the output, see `Formattable`. precision, final char the pad character to use. padChar, final CharSequence the ellipsis to use when precision dictates truncation, null or empty causes a hard truncation. truncateEllipsis) Handles the common `Formattable` operations of truncate-pad-append.
public static Formatter	Returns: The `formatter` instance, not null append(final CharSequence the string to handle, not null. seq, final Formatter the destination formatter, not null. formatter, final int the flags for formatting, see `Formattable`. flags, final int the width of the output, see `Formattable`. width, final int the precision of the output, see `Formattable`. precision, final CharSequence the ellipsis to use when precision dictates truncation, null or empty causes a hard truncation.. ellipsis) Handles the common `Formattable` operations of truncate-pad-append, padding width underflow with spaces.
public static String	Returns: The resulting string, not null. toString(final Formattable the instance to convert to a string, not null. formattable) Gets the default formatted representation of the specified `Formattable`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

SIMPLEST_FORMAT	back to summary
private static final String SIMPLEST_FORMAT A format that simply outputs the value as a string.

FormattableUtils	back to summary
public FormattableUtils() `FormattableUtils` instances should NOT be constructed in standard programming. Instead, the methods of the class should be invoked statically. This constructor is public to permit tools that require a JavaBean instance to operate.

Method Detail

append back to summary

append	back to summary
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision) Handles the common `Formattable` operations of truncate-pad-append, with no ellipsis on precision overflow, and padding width underflow with spaces. Parameters seq:CharSequence the string to handle, not null. formatter:Formatter the destination formatter, not null. flags:int the flags for formatting, see `Formattable`. width:int the width of the output, see `Formattable`. precision:int the precision of the output, see `Formattable`. Returns:Formatter The `formatter` instance, not null.

public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision)

Handles the common Formattable operations of truncate-pad-append, with no ellipsis on precision overflow, and padding width underflow with spaces.

Parameters

seq:CharSequence: the string to handle, not null.
formatter:Formatter: the destination formatter, not null.
flags:int: the flags for formatting, see Formattable.
width:int: the width of the output, see Formattable.
precision:int: the precision of the output, see Formattable.

Returns:Formatter

The formatter instance, not null.

append back to summary

append	back to summary
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision, final char padChar) Handles the common `Formattable` operations of truncate-pad-append, with no ellipsis on precision overflow. Parameters seq:CharSequence the string to handle, not null. formatter:Formatter the destination formatter, not null. flags:int the flags for formatting, see `Formattable`. width:int the width of the output, see `Formattable`. precision:int the precision of the output, see `Formattable`. padChar:char the pad character to use. Returns:Formatter The `formatter` instance, not null.

public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision, final char padChar)

Handles the common Formattable operations of truncate-pad-append, with no ellipsis on precision overflow.

Parameters

seq:CharSequence: the string to handle, not null.
formatter:Formatter: the destination formatter, not null.
flags:int: the flags for formatting, see Formattable.
width:int: the width of the output, see Formattable.
precision:int: the precision of the output, see Formattable.
padChar:char: the pad character to use.

Returns:Formatter

The formatter instance, not null.

append back to summary

append	back to summary
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision, final char padChar, final CharSequence truncateEllipsis) Handles the common `Formattable` operations of truncate-pad-append. Parameters seq:CharSequence the string to handle, not null. formatter:Formatter the destination formatter, not null. flags:int the flags for formatting, see `Formattable`. width:int the width of the output, see `Formattable`. precision:int the precision of the output, see `Formattable`. padChar:char the pad character to use. truncateEllipsis:CharSequence the ellipsis to use when precision dictates truncation, null or empty causes a hard truncation. Returns:Formatter The `formatter` instance, not null. Exceptions IllegalArgumentException: if `ellipsis.length() > precision`, given that `ellipsis` is not null and `precision >= 0`.

public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision, final char padChar, final CharSequence truncateEllipsis)

Handles the common Formattable operations of truncate-pad-append.

Parameters

seq:CharSequence: the string to handle, not null.
formatter:Formatter: the destination formatter, not null.
flags:int: the flags for formatting, see Formattable.
width:int: the width of the output, see Formattable.
precision:int: the precision of the output, see Formattable.
padChar:char: the pad character to use.
truncateEllipsis:CharSequence: the ellipsis to use when precision dictates truncation, null or empty causes a hard truncation.

Returns:Formatter

The formatter instance, not null.

Exceptions

IllegalArgumentException:: if ellipsis.length() > precision, given that ellipsis is not null and precision >= 0.

append back to summary

append	back to summary
public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision, final CharSequence ellipsis) Handles the common `Formattable` operations of truncate-pad-append, padding width underflow with spaces. Parameters seq:CharSequence the string to handle, not null. formatter:Formatter the destination formatter, not null. flags:int the flags for formatting, see `Formattable`. width:int the width of the output, see `Formattable`. precision:int the precision of the output, see `Formattable`. ellipsis:CharSequence the ellipsis to use when precision dictates truncation, null or empty causes a hard truncation.. Returns:Formatter The `formatter` instance, not null Exceptions IllegalArgumentException: if `ellipsis.length() > precision`, given that `ellipsis` is not null and `precision >= 0`.

public static Formatter append(final CharSequence seq, final Formatter formatter, final int flags, final int width, final int precision, final CharSequence ellipsis)

Handles the common Formattable operations of truncate-pad-append, padding width underflow with spaces.

Parameters

seq:CharSequence: the string to handle, not null.
formatter:Formatter: the destination formatter, not null.
flags:int: the flags for formatting, see Formattable.
width:int: the width of the output, see Formattable.
precision:int: the precision of the output, see Formattable.
ellipsis:CharSequence: the ellipsis to use when precision dictates truncation, null or empty causes a hard truncation..

Returns:Formatter

The formatter instance, not null

Exceptions

IllegalArgumentException:: if ellipsis.length() > precision, given that ellipsis is not null and precision >= 0.

toString back to summary

toString	back to summary
public static String toString(final Formattable formattable) Gets the default formatted representation of the specified `Formattable`. Parameters formattable:Formattable the instance to convert to a string, not null. Returns:String The resulting string, not null.

public static String toString(final Formattable formattable)

Gets the default formatted representation of the specified Formattable.

Parameters

formattable:Formattable: the instance to convert to a string, not null.

Returns:String

The resulting string, not null.

public Class FormattableUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail