public class

ContextBlockMarkingDiffPostProcessor

extends Object
implements DiffPostProcessor
java.lang.Object
   ↳ com.atlassian.confluence.diff.ContextBlockMarkingDiffPostProcessor

Class Overview

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.

Summary

Public Constructors
ContextBlockMarkingDiffPostProcessor(String diffTargetBlockClass, String diffContextBlockClass)
Public Methods
Document process(Document document)

Perform some process on the supplied JDOM Document.

[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.diff.DiffPostProcessor

Public Constructors

public ContextBlockMarkingDiffPostProcessor (String diffTargetBlockClass, String diffContextBlockClass)

Public Methods

public Document process (Document document)

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.

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.