com.atlassian.confluence.diff
Class StripToContextDiffPostProcessor

java.lang.Object
  com.atlassian.confluence.diff.StripToContextDiffPostProcessor

All Implemented Interfaces:

DiffPostProcessor

public class StripToContextDiffPostProcessor
extends Object
implements DiffPostProcessor

A DiffPostProcessor that will return a document containing only the blocks of content that are either containing a diff or are context for a diff. If there are no such blocks found then it is assumed that the prerequisite ContextBlockMarkingDiffPostProcessor failed and therefore the Document will not be touched allow the display of full content.

Constructor Summary

StripToContextDiffPostProcessor(String diffTargetBlockClass, String diffContextBlockClass)

Method Summary

org.jdom.Document

process(org.jdom.Document document) Perform some process on the supplied JDOM Document.

Methods inherited from class java.lang.Object

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

Constructor Detail

StripToContextDiffPostProcessor

public StripToContextDiffPostProcessor(String diffTargetBlockClass,
                                       String diffContextBlockClass)

Method Detail

process

public org.jdom.Document process(org.jdom.Document document)

Description copied from interface: DiffPostProcessor

Perform some process on the supplied JDOM Document. The result of the process should be self contained with any exceptions being caught and a Document returned.

It is expected that an implementation will make changes to the supplied Document parameter although this is not necessary since the result of the call is the input to the next stage.

Specified by:

process in interface DiffPostProcessor

Parameters:

document - the Document from a previous step in the Diff generation process.

Returns:

the Document to be supplied to the next step in the Diff generation process. This must not be null.