Interface Formatter

All Known Implementing Classes:
SimpleFormatters.FixedString, SimpleFormatters.GetVar, SimpleFormatters.Part, SimpleFormatters.PartLen, SimpleFormatters.PartSeq

public interface Formatter
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.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    arranges (some of) the pieces of text found in st or m in an implementation dependend manner and appends them to out.
  • Method Details

    • format

      void format(StringBuilder out, TextStore st, Map<Object,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