net.sf.mmm.util.lang.base

Class AbstractLocalizableFormatter<V>

java.lang.Object

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

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

Type Parameters:

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

All Implemented Interfaces:

Formatter<V>, LocalizableFormatter<V>

Direct Known Subclasses:

ComposedLocalizableFormatter

public abstract class AbstractLocalizableFormatter<V>
extends AbstractFormatter<V>
implements LocalizableFormatter<V>

This is the abstract base implementation of the LocalizableFormatter interface.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractLocalizableFormatter() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doFormat(V value, Appendable buffer)
protected abstract void	doFormat(V value, Appendable buffer, Locale locale)
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.
void	format(V value, Appendable buffer, Locale locale) This method formats the given value for the given locale and directly appends to the given buffer.
String	format(V value, Locale locale) This method formats the given value for the given locale.
protected Locale	getDefaultLocale() This method gets the default locale used if none is provided.

Methods inherited from class net.sf.mmm.util.lang.base.AbstractFormatter

formatNull

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLocalizableFormatter

public AbstractLocalizableFormatter()

The constructor.

Method Detail

getDefaultLocale

protected Locale getDefaultLocale()

This method gets the default locale used if none is provided. Will return Locale.getDefault(). May be overridden to change.

Returns:

the default locale.

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>

Overrides:

format in class AbstractFormatter<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 String format(V value,
                     Locale locale)

Description copied from interface: LocalizableFormatter

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

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

Specified by:

format in interface LocalizableFormatter<V>

Parameters:

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

locale - is the Locale.

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)

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>

Overrides:

format in class AbstractFormatter<V>

Parameters:

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

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

format

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

Description copied from interface: LocalizableFormatter

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

Specified by:

format in interface LocalizableFormatter<V>

Parameters:

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

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

locale - is the Locale to use.

Throws:

RuntimeIoException - if append caused a IOException.

doFormat

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

Parameters:

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

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

locale - is the Locale.

Throws:

IOException - if caused by append.

See Also:

format(Object, Appendable, Locale)

doFormat

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

Specified by:

doFormat in class AbstractFormatter<V>

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:

AbstractFormatter.format(Object, Appendable)