com.xmlmind.xmleditapp.cmd.diff

Class Revisions

java.lang.Object

com.xmlmind.xmleditapp.cmd.diff.Revisions

public final class Revisions
extends Object

Revision history of a document. Value of element property DiffSupport.REVISIONS_PROPERTY.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Revisions.Delta The binary delta between revision #revisionNumber+1 and revision #revisionNumber.

Field Summary

Fields

Modifier and Type	Field and Description
Revisions.Delta[]	deltas
byte[]	previousRevisionContent
Date	previousRevisionDate
String	previousRevisionEditor

Method Summary

Modifier and Type	Method and Description
Date	getCurrentRevisionDate() Returns the date of the current revision (that is, the revision corresponding to the document being edited).
String	getCurrentRevisionEditor(CommandEnv env) Returns the ID of the current user of the application.
String	getCurrentRevisionEditor(Document doc) Returns the creator of the current revision (that is, the revision corresponding to the document being edited).
int	getCurrentRevisionNumber() Returns the number of the current revision (that is, the revision corresponding to the document being edited).
byte[]	getRevision(int revisionNumber, ProgressMonitor progressMonitor) Returns the content of revision #revisionNumber.
static byte[]	toBytes(Document doc) Not part of the public, documented, API: returns the UTF-8 bytes corresponding to a normalized XML form of specified document.

Methods inherited from class java.lang.Object

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

Field Detail

previousRevisionDate

public final Date previousRevisionDate

previousRevisionEditor

public final String previousRevisionEditor

previousRevisionContent

public final byte[] previousRevisionContent

deltas

public final Revisions.Delta[] deltas

Method Detail

getCurrentRevisionNumber

public int getCurrentRevisionNumber()

Returns the number of the current revision (that is, the revision corresponding to the document being edited).

getCurrentRevisionDate

public Date getCurrentRevisionDate()

Returns the date of the current revision (that is, the revision corresponding to the document being edited).

getCurrentRevisionEditor

public String getCurrentRevisionEditor(Document doc)

Returns the creator of the current revision (that is, the revision corresponding to the document being edited).

Parameters:

doc - the document being edited used as a context

getCurrentRevisionEditor

public String getCurrentRevisionEditor(CommandEnv env)

Returns the ID of the current user of the application.

Parameters:

env - the environment info needed to execute commands

toBytes

public static byte[] toBytes(Document doc)

Not part of the public, documented, API: returns the UTF-8 bytes corresponding to a normalized XML form of specified document. This normalized XML form is the one which is used to compute binary deltas between revisions.

getRevision

public byte[] getRevision(int revisionNumber,
                          ProgressMonitor progressMonitor)
                   throws IndexOutOfBoundsException,
                          IOException

Returns the content of revision #revisionNumber. Rebuilds this content if needed to.

Parameters:

revisionNumber - number of the revision

progressMonitor - a progress monitor allowing to provide the user with a feedback while the content of the revision is rebuilt out of binary deltas. May be null.

Returns:

the content of revision #revisionNumber

Throws:

IndexOutOfBoundsException - if revisionNumber < 1 || revisionNumber >= currentRevisionNumber

IOException - if, for any reason, the binary deltas cannot be used to rebuild the content of the revision