monq.jfa

Interface Formatter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PrintfFormatter, SimpleFormatters.FixedString, SimpleFormatters.GetVar, SimpleFormatters.Part, SimpleFormatters.PartLen, SimpleFormatters.PartSeq

public interface Formatter
extends java.io.Serializable

defines the interface to classes which rearrange text parts stored in a TextStore and/or in a java.util.Map append them to a StringBuilder.

Hint:Typically a TextSplitter and a Formatter are used in tandem and communicate via a TextStore.

Version:

$Revision: 1.7 $, $Date: 2005-07-08 13:01:26 $

Author:

© 2003, 2004 Harald Kirsch

Method Summary

Modifier and Type	Method and Description
void	format(java.lang.StringBuilder out, TextStore st, java.util.Map<java.lang.Object,java.lang.Object> m) arranges (some of) the pieces of text found in st or m in an implementation dependend manner and appends them to out.

Method Detail

format

void format(java.lang.StringBuilder out,
            TextStore st,
            java.util.Map<java.lang.Object,java.lang.Object> m)
     throws CallbackException

arranges (some of) the pieces of text found in st or m in an implementation dependend manner and appends them to out. Depending on the implementation, both, st and m or even both may be allowed to be null.

Postcondition: This method may not change the content of dest other than by appending to it.

Throws:

CallbackException