com.helger.commons.format

Interface IFormatter

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractFormatterString, FormatterBracket, FormatterMinLengthAddLeading, FormatterMinLengthAddTrailing, FormatterStringPrefix, FormatterStringPrefixAndSuffix, FormatterStringSkipPrefix, FormatterStringSkipPrefixAndSuffix, FormatterStringSkipSuffix, FormatterStringSuffix

public interface IFormatter
extends Serializable

A simple formatter interface that may be used to format arbitrary objects to a string.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getFormattedValue(Object aValue) Convert the passed value to a formatted string according to the pattern.

Method Detail

getFormattedValue

@Nonnull
String getFormattedValue(@Nullable
                                   Object aValue)

Convert the passed value to a formatted string according to the pattern.

Parameters:

aValue - The source value to be formatted. May be null.

Returns:

The formatted string. Never null.

Throws:

IllegalArgumentException - if the formatter does not understand the object