com.codemonster.surinam.core.formatter
Class AbstractImplementationBlueprintFormatter

java.lang.Object
  com.codemonster.surinam.core.formatter.AbstractImplementationBlueprintFormatter

All Implemented Interfaces:

BlueprintFormatter

Direct Known Subclasses:

ImplementationBlueprintHTMLFormatter

public abstract class AbstractImplementationBlueprintFormatter
extends Object
implements BlueprintFormatter

This is an abstract class that eases the creation of specific subclass families of Implementation formatters. This will help make implementing specific formatters a bit easier by providing a core implementation for handling a blueprint map, handing off formatting calls for each of the blueprints with the implementation provided by the implementing class. Also, to give individual formatters the ability to control the header and footer sections of a format, we separate those parts into discrete methods.

Constructor Summary

AbstractImplementationBlueprintFormatter()

Method Summary

abstract StringBuilder

formatAll(Map<String,ImplementationBlueprint> map) This is the callback to format all implementation blueprints with a type-safe signature.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codemonster.surinam.core.formatter.BlueprintFormatter

formatBlueprint, formatFooter, formatHeader

Constructor Detail

AbstractImplementationBlueprintFormatter

public AbstractImplementationBlueprintFormatter()

Method Detail

formatAll

public abstract StringBuilder formatAll(Map<String,ImplementationBlueprint> map)

This is the callback to format all implementation blueprints with a type-safe signature.

Parameters:

map - The map of blueprints to format.

Returns:

Returns a StringBuilder object with the formatted output.