com.atlassian.confluence.diff

Class ContextBlockMarkingDiffPostProcessor

java.lang.Object

com.atlassian.confluence.diff.ContextBlockMarkingDiffPostProcessor

All Implemented Interfaces:

DiffPostProcessor

public class ContextBlockMarkingDiffPostProcessor
extends Object
implements DiffPostProcessor

A DiffPostProcessor that will mark blocks of content around the diff to aid the identification of context.

This is a fairly dumb attempt at providing context but is better than having no option but to present full content.

Constructor Summary

Constructors

Constructor and Description
ContextBlockMarkingDiffPostProcessor(String diffTargetBlockClass, String diffContextBlockClass)

Method Summary

Methods

Modifier and Type	Method and Description
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

ContextBlockMarkingDiffPostProcessor

public ContextBlockMarkingDiffPostProcessor(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.