com.topologi.diffx.format
Interface DiffXFormatter

All Known Subinterfaces:

XMLDiffXFormatter

All Known Implementing Classes:

ShortStringFormatter, SmartXMLFormatter, StrictXMLFormatter

public interface DiffXFormatter

An interface for formatting the output of the Diff-X algorithm.

Version:

15 December 2004

Author:

Christophe Lauret

Method Summary

void	delete(DiffXEvent e) Formats the specified deleted event.
void	format(DiffXEvent e) Formats the specified event.
void	insert(DiffXEvent e) Formats the specified inserted event.
void	setConfig(DiffXConfig config) Sets the configuration to use with this formatter.

Method Detail

format

public void format(DiffXEvent e)
            throws IOException,
                   IllegalStateException

Formats the specified event.

Parameters:

e - The event to format

Throws:

IOException - Should an I/O exception occurs whilst formatting.

IllegalStateException - If the formatter is not in a state to run this method.

insert

public void insert(DiffXEvent e)
            throws IOException,
                   IllegalStateException

Formats the specified inserted event.

Parameters:

e - The event to format

Throws:

IOException - Should an I/O exception occurs whilst formatting.

IllegalStateException - If the formatter is not in a state to run this method.

delete

public void delete(DiffXEvent e)
            throws IOException,
                   IllegalStateException

Formats the specified deleted event.

Parameters:

e - The event to format

Throws:

IOException - Should an I/O exception occurs whilst formatting.

IllegalStateException - If the formatter is not in a state to run this method.

setConfig

public void setConfig(DiffXConfig config)

Sets the configuration to use with this formatter.

Parameters:

config - The configuration to use.