org.quattor.pan.output
Interface Formatter

All Known Implementing Classes:

DotFormatter, PanFormatter, PanTxtFormatter, TxtFormatter, XmlDBFormatter

public interface Formatter

Author:

duprilot

Method Summary

java.lang.String	getFileExtension() Return the file extension for files written with this formatter.
java.lang.String	getFormatKey() Returns the name of the formatter that will be used to identify it.
void	write(Element root, java.lang.String rootName, java.io.PrintWriter ps) Reads this Tree and writes it in a file within the given context.

Method Detail

getFileExtension

java.lang.String getFileExtension()

Return the file extension for files written with this formatter. The implementation may not return null.

Returns:

String containing the file extension to use

getFormatKey

java.lang.String getFormatKey()

Returns the name of the formatter that will be used to identify it. This key is used as the value for the command line and for the ant task. The returned key must not be null.

Returns:

String identifying this formatter

write

void write(Element root,
           java.lang.String rootName,
           java.io.PrintWriter ps)

Reads this Tree and writes it in a file within the given context.

Parameters:

root - root element of the configuration tree

rootName - name of root element

ps - the PrintStream used to write the file