net.sf.mmm.util.nls.api

Interface NlsMessageFormatter

All Superinterfaces:

NlsFormatter<Void>

All Known Implementing Classes:

AbstractNlsMessageFormatter, NlsMessageFormatterImpl

public interface NlsMessageFormatter
extends NlsFormatter<Void>

This is the interface for a formatter of a message-text. It is a simplified view on something like MessageFormat.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	format(Void nothing, Locale locale, Map<String,Object> arguments, NlsTemplateResolver resolver, Appendable buffer) This method formats the underlying pattern by filling in the given arguments and writing the result into the given buffer.
void	visit(Visitor<String> staticTextVisitor, Visitor<NlsArgument> dynamicArgumentVisitor) Visits the child elements of this NlsMessageFormatter.

Methods inherited from interface net.sf.mmm.util.nls.api.NlsFormatter

format

Method Detail

format

void format(Void nothing,
            Locale locale,
            Map<String,Object> arguments,
            NlsTemplateResolver resolver,
            Appendable buffer)
     throws IOException

This method formats the underlying pattern by filling in the given arguments and writing the result into the given buffer. This method formats the given object according to the given locale.

Specified by:

format in interface NlsFormatter<Void>

Parameters:

nothing - has to be null. Only for generic compatibility.

locale - is the locale used for localized formatting.

arguments - is the Map of arguments.

resolver - is the NlsTemplateResolver.

buffer - is where to append the formatted object.

Throws:

IOException - if the given Appendable caused such exception.

visit

void visit(Visitor<String> staticTextVisitor,
           Visitor<NlsArgument> dynamicArgumentVisitor)

Visits the child elements of this NlsMessageFormatter.

Parameters:

staticTextVisitor - a Visitor for the static text segments.

dynamicArgumentVisitor - a Visitor for the NlsArguments.