Package org.xwiki.extension.xar.job.diff

Class DocumentUnifiedDiff

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,List<org.xwiki.diff.display.UnifiedDiffBlock<String,Character>>>

org.xwiki.extension.xar.job.diff.EntityUnifiedDiff<DocumentVersionReference>

org.xwiki.extension.xar.job.diff.DocumentUnifiedDiff

All Implemented Interfaces:

Serializable, Cloneable, Map<String,List<org.xwiki.diff.display.UnifiedDiffBlock<String,Character>>>

public class DocumentUnifiedDiff
extends EntityUnifiedDiff<DocumentVersionReference>

Holds the differences, in unified format, between two versions of a document.

Since:

7.0RC1

Version:

$Id: e00a094dacc05afb89566769cf8bca38501d7a2c $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
DocumentUnifiedDiff(DocumentVersionReference previousReference, DocumentVersionReference nextReference)	Creates a new instance to hold the differences between the specified document versions.

Method Summary

Modifier and Type	Method	Description
List<EntityUnifiedDiff<AttachmentReference>>	getAttachmentDiffs()
List<EntityUnifiedDiff<ClassPropertyReference>>	getClassPropertyDiffs()
List<EntityUnifiedDiff<ObjectReference>>	getObjectDiffs()

Methods inherited from class org.xwiki.extension.xar.job.diff.EntityUnifiedDiff

getNextReference, getPreviousReference, getReference, getType

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

DocumentUnifiedDiff

public DocumentUnifiedDiff(DocumentVersionReference previousReference,
                           DocumentVersionReference nextReference)

Creates a new instance to hold the differences between the specified document versions.

Parameters:

previousReference - the reference to the previous version of the document

nextReference - the reference to the next version of the document

Method Detail

getClassPropertyDiffs

public List<EntityUnifiedDiff<ClassPropertyReference>> getClassPropertyDiffs()

Returns:

the list of class properties that have differences between the two versions of the document

getAttachmentDiffs

public List<EntityUnifiedDiff<AttachmentReference>> getAttachmentDiffs()

Returns:

the list of attachments that have differences between the two versions of the document

getObjectDiffs

public List<EntityUnifiedDiff<ObjectReference>> getObjectDiffs()

Returns:

the list of objects that have differences between the two versions of the document