net.sf.mmm.util.lang.base

Class AbstractFormatter<V>

java.lang.Object

net.sf.mmm.util.lang.base.AbstractFormatter<V>

Type Parameters:

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

All Implemented Interfaces:

Formatter<V>

Direct Known Subclasses:

AbstractLocalizableFormatter, AbstractVersionIdentifierFormatterNumber, AbstractVersionIdentifierFormatterString, BooleanFormatter, ComposedFormatter, DefaultVersionIdentifierFormatter, EnumEnumDefinition.EnumDefaultFormatter, EnumEnumDefinition.EnumTypeFormatter, FormatterProvider.FormatFormatter, FormatterProvider.Iso8601Formatter, FormatterToString, StaticFormatter, VersionIdentifierFormatterVersionSegments

public abstract class AbstractFormatter<V>
extends Object
implements Formatter<V>

This is the abstract base implementation of the Formatter interface.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractFormatter() The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	doFormat(V value, Appendable buffer)
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.
protected String	formatNull() Returns the (static) string representation for the undefined value null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFormatter

public AbstractFormatter()

The constructor.

Method Detail

format

public String format(V value)

Description copied from interface: Formatter

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

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

Specified by:

format in interface Formatter<V>

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

public void format(V value,
                   Appendable buffer)
            throws RuntimeIoException

Description copied from interface: Formatter

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

Specified by:

format in interface Formatter<V>

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.

formatNull

protected String formatNull()

Returns the (static) string representation for the undefined value null.

Returns:

the null string.

doFormat

protected abstract void doFormat(V value,
                                 Appendable buffer)
                          throws IOException

Parameters:

value - is the value to format (not null).

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

Throws:

IOException - if caused by append.

See Also:

format(Object, Appendable)