com.aspose.words

Class ComparerContext

java.lang.Object

com.aspose.words.ProcessorContext

com.aspose.words.ComparerContext

public class ComparerContext
extends ProcessorContext

Document comparer context

Examples:

Shows how to simple compare documents using context.

 
 // There is a several ways to compare documents:
 String firstDoc = getMyDir() + "Table column bookmarks.docx";
 String secondDoc = getMyDir() + "Table column bookmarks.doc";

 ComparerContext comparerContext = new ComparerContext();
 comparerContext.getCompareOptions().setIgnoreCaseChanges(true);
 comparerContext.setAuthor("Author");
 comparerContext.setDateTime(new Date());

 Comparer.create(comparerContext)
         .from(firstDoc)
         .from(secondDoc)
         .to(getArtifactsDir() + "LowCode.CompareContextDocuments.docx")
         .execute();
 
 

Shows how to compare documents from the stream using context.

 
 // There is a several ways to compare documents from the stream:
 try (FileInputStream firstStreamIn = new FileInputStream(getMyDir() + "Table column bookmarks.docx")) {
     try (FileInputStream secondStreamIn = new FileInputStream(getMyDir() + "Table column bookmarks.doc")) {
         ComparerContext comparerContext = new ComparerContext();
         comparerContext.getCompareOptions().setIgnoreCaseChanges(true);
         comparerContext.setAuthor("Author");
         comparerContext.setDateTime(new Date());

         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.CompareContextStreamDocuments.docx")) {
             Comparer.create(comparerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 
 

Constructor Summary

Constructors

Constructor and Description
ComparerContext() Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	getAcceptRevisions() Indicates whether to accept revisions in the documents before comparing them.
java.lang.String	getAuthor() The author to be assigned to revisions created during document comparison.
CompareOptions	getCompareOptions() Options used upon comparing documents.
java.util.Date	getDateTime() The date and time assigned to revisions created during document comparison.
void	setAcceptRevisions(boolean value) Indicates whether to accept revisions in the documents before comparing them.
void	setAuthor(java.lang.String value) The author to be assigned to revisions created during document comparison.
void	setDateTime(java.util.Date value) The date and time assigned to revisions created during document comparison.

Methods inherited from class com.aspose.words.ProcessorContext

getFontSettings, getLayoutOptions, getWarningCallback, setFontSettings, setWarningCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparerContext

public ComparerContext()

Initializes a new instance of this class.

Method Detail

getAuthor

public java.lang.String getAuthor()

The author to be assigned to revisions created during document comparison.

Returns:

The corresponding String value.

setAuthor

public void setAuthor(java.lang.String value)

The author to be assigned to revisions created during document comparison.

Parameters:

value - The corresponding String value.

getDateTime

public java.util.Date getDateTime()

The date and time assigned to revisions created during document comparison.

Returns:

The corresponding Date value.

setDateTime

public void setDateTime(java.util.Date value)

The date and time assigned to revisions created during document comparison.

Parameters:

value - The corresponding Date value.

getAcceptRevisions

public boolean getAcceptRevisions()

Indicates whether to accept revisions in the documents before comparing them. If the compared documents contain revisions and this flag is set to false, the processor will reject revisions. Default is true.

Returns:

The corresponding boolean value.

setAcceptRevisions

public void setAcceptRevisions(boolean value)

Indicates whether to accept revisions in the documents before comparing them. If the compared documents contain revisions and this flag is set to false, the processor will reject revisions. Default is true.

Parameters:

value - The corresponding boolean value.

getCompareOptions

public CompareOptions getCompareOptions()

Options used upon comparing documents.

Examples:

Shows how to simple compare documents using context.

 
 // There is a several ways to compare documents:
 String firstDoc = getMyDir() + "Table column bookmarks.docx";
 String secondDoc = getMyDir() + "Table column bookmarks.doc";

 ComparerContext comparerContext = new ComparerContext();
 comparerContext.getCompareOptions().setIgnoreCaseChanges(true);
 comparerContext.setAuthor("Author");
 comparerContext.setDateTime(new Date());

 Comparer.create(comparerContext)
         .from(firstDoc)
         .from(secondDoc)
         .to(getArtifactsDir() + "LowCode.CompareContextDocuments.docx")
         .execute();
 
 

Shows how to compare documents from the stream using context.

 
 // There is a several ways to compare documents from the stream:
 try (FileInputStream firstStreamIn = new FileInputStream(getMyDir() + "Table column bookmarks.docx")) {
     try (FileInputStream secondStreamIn = new FileInputStream(getMyDir() + "Table column bookmarks.doc")) {
         ComparerContext comparerContext = new ComparerContext();
         comparerContext.getCompareOptions().setIgnoreCaseChanges(true);
         comparerContext.setAuthor("Author");
         comparerContext.setDateTime(new Date());

         try (FileOutputStream streamOut = new FileOutputStream(getArtifactsDir() + "LowCode.CompareContextStreamDocuments.docx")) {
             Comparer.create(comparerContext)
                     .from(firstStreamIn)
                     .from(secondStreamIn)
                     .to(streamOut, SaveFormat.DOCX)
                     .execute();
         }
     }
 }
 
 

Returns:

The corresponding CompareOptions value.