net.sf.mmm.util.lang.api

Interface Formatter<V>

Type Parameters:

V - is the generic type of the actual value to format.

All Known Subinterfaces:

LocalizableFormatter<V>, VersionIdentifierFormatter

All Known Implementing Classes:

AbstractFormatter, AbstractLocalizableFormatter, AbstractVersionIdentifierFormatterNumber, AbstractVersionIdentifierFormatterString, BooleanFormatter, ComposedFormatter, ComposedLocalizableFormatter, ComposedVersionIdentifierFormatter, DefaultVersionIdentifierFormatter, EnumEnumDefinition.EnumDefaultFormatter, EnumEnumDefinition.EnumTypeFormatter, FormatterProvider.FormatFormatter, FormatterProvider.Iso8601Formatter, FormatterToString, StaticFormatter, VersionIdentifierFormatterLabel, VersionIdentifierFormatterPhase, VersionIdentifierFormatterPhaseAlias, VersionIdentifierFormatterPhaseNumber, VersionIdentifierFormatterPhaseValue, VersionIdentifierFormatterRevision, VersionIdentifierFormatterSnapshot, VersionIdentifierFormatterTimestamp, VersionIdentifierFormatterVersionSegments

public interface Formatter<V>

This is the interface for a formatter that allows to format a given object of a generic type.
Unlike Formatter this variant concentrates on an API rather than an implementation.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
String	format(V value) This method formats the given value.
void	format(V value, Appendable buffer) This method formats the given value and directly appends to the given buffer.

Method Detail

format

String format(V value)

This method formats the given value.
This is a shorthand of the following code:

 StringBuilder buffer = new StringBuilder();
 format(value, buffer);
 return buffer.toString();
 

Parameters:

value - is the value to format. May be null.

Returns:

the formatted value. If the given value is null, a legal implementation will return "null" or "".

format

void format(V value,
            Appendable buffer)
     throws RuntimeIoException

This method formats the given value and directly appends to the given buffer.

Parameters:

value - is the value to format. May be null.

buffer - is the Appendable to append the formatted value to.

Throws:

RuntimeIoException - if append caused a IOException.