org.ghost4j.modifier

Interface Modifier

All Known Subinterfaces:

RemoteModifier

All Known Implementing Classes:

AbstractModifier, AbstractRemoteModifier, SafeAppenderModifier

public interface Modifier

Interface defining a modifier used to edit / modify a document.

Author:

Gilles Grousset (gi.grousset@gmail.com)

Method Summary

Methods

Modifier and Type	Method and Description
Document	modify(Document source, Map<String,Serializable> parameters) Modify a document with optional parameters

Method Detail

modify

Document modify(Document source,
              Map<String,Serializable> parameters)
                throws ModifierException,
                       DocumentException,
                       IOException

Modify a document with optional parameters

Parameters:

source - Document to modify

parameters - Modifier parameters

Returns:

Modifier version of the document

Throws:

ModifierException

DocumentException

IOException