RevisionInfo

Inheritance: java.lang.Object

public class RevisionInfo

Represents a revision in the document.

A revision encapsulates information about revision change made to the document. This class provides methods to retrieve information about the revision, such as its type, content, author, and so on.

Example usage:


 try (RevisionHandler revisionHandler = new RevisionHandler(sourceFile)) {
     List revisionList = revisionHandler.getRevisions();

     for (RevisionInfo revisionInfo : revisionList) {
         System.out.println("Revision Type: " + revisionInfo.getType());
         System.out.println("Text: " + revisionInfo.getText());
         System.out.println("Author: " + revisionInfo.getAuthor());
     }
 }
 

Constructors

Constructor Description
RevisionInfo()

Methods

Method Description
getAction() Gets the action associated with the revision (accept or reject).
setAction(RevisionAction value) Sets the value associated with the revision (accept or reject).
getText() Gets the text content of the revision.
setText(String value) Sets the value content of the revision.
getAuthor() Gets the author of the revision.
setAuthor(String value) Sets the value of the revision.
getType() Gets the type of the revision, depending on the type the Action (accept or reject) logic changes.
setType(RevisionType value) Sets the value of the revision, depending on the value the Action (accept or reject) logic changes.

RevisionInfo()

public RevisionInfo()

getAction()

public RevisionAction getAction()

Gets the action associated with the revision (accept or reject). This field allows you to influence the display of the revision.

Returns: RevisionAction - the action associated with the revision.

setAction(RevisionAction value)

public void setAction(RevisionAction value)

Sets the value associated with the revision (accept or reject). This field allows you to influence the display of the revision.

Parameters:

Parameter Type Description
value RevisionAction The value associated with the revision.

getText()

public String getText()

Gets the text content of the revision.

Returns: java.lang.String - the text content of the revision.

setText(String value)

public void setText(String value)

Sets the value content of the revision.

Parameters:

Parameter Type Description
value java.lang.String The value content of the revision.

getAuthor()

public String getAuthor()

Gets the author of the revision.

Returns: java.lang.String - the author of the revision.

setAuthor(String value)

public void setAuthor(String value)

Sets the value of the revision.

Parameters:

Parameter Type Description
value java.lang.String The value of the revision.

getType()

public RevisionType getType()

Gets the type of the revision, depending on the type the Action (accept or reject) logic changes.

Returns: RevisionType - the type of the revision.

setType(RevisionType value)

public void setType(RevisionType value)

Sets the value of the revision, depending on the value the Action (accept or reject) logic changes.

Parameters:

Parameter Type Description
value RevisionType The value of the revision.