com.groupdocs.comparison.options.save

Class SaveOptions

java.lang.Object

com.groupdocs.comparison.options.save.SaveOptions

public class SaveOptions
extends Object

Allows specifying additional options when saving a document.

Example usage:

 try (Comparer comparer = new Comparer(sourceFile)) {
    comparer.add(targetFile);

    final SaveOptions saveOptions = new SaveOptions();
    saveOptions.setPassword("passw");

    comparer.compare(resultFile, saveOptions);
 }
 

See Also:

Comparer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SaveOptions.Builder A SaveOptions builder.

Constructor Summary

Constructors

Constructor and Description
SaveOptions() Initializes a new instance of the SaveOptions class.

Method Summary

Modifier and Type	Method and Description
MetadataType	getCloneMetadataType() Gets a strategy of processing metadata saving result document.
FileAuthorMetadata	getFileAuthorMetadata() Gets a metadata object that will be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.
String	getFolderPath() Gets a folder path to which result images will be saved.
String	getPassword() Gets a password for result document.
void	setCloneMetadataType(MetadataType value) Sets a stragegy of processing metadata saving result document.
void	setFileAuthorMetadata(FileAuthorMetadata value) Sets a metadata object that should be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.
void	setFolderPath(Path value) Sets a folder path to which result images should be saved.
void	setFolderPath(String value) Sets a folder path to which result images should be saved.
void	setPassword(String value) Sets a password for result document.

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveOptions

public SaveOptions()

Initializes a new instance of the SaveOptions class.

Method Detail

getCloneMetadataType

public final MetadataType getCloneMetadataType()

Gets a strategy of processing metadata saving result document.

Possible values are in enum MetadataType

Returns:

the stragegy of processing metadata

getFileAuthorMetadata

public final FileAuthorMetadata getFileAuthorMetadata()

Gets a metadata object that will be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.

Returns:

the metadata object

getFolderPath

public final String getFolderPath()

Gets a folder path to which result images will be saved.

Used for Imaging Comparison only.

Returns:

the folder path to save result images

getPassword

public final String getPassword()

Gets a password for result document.

Returns:

the password

setCloneMetadataType

public final void setCloneMetadataType(MetadataType value)

Sets a stragegy of processing metadata saving result document.

Possible values are in enum MetadataType

Parameters:

value - The stragegy of processing metadata

setFileAuthorMetadata

public final void setFileAuthorMetadata(FileAuthorMetadata value)

Sets a metadata object that should be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.

Parameters:

value - The metadata object

setFolderPath

public final void setFolderPath(Path value)

Sets a folder path to which result images should be saved.

Used for Imaging Comparison only.

Parameters:

value - The folder path to save result images

setFolderPath

public final void setFolderPath(String value)

Sets a folder path to which result images should be saved.

Used for Imaging Comparison only.

Parameters:

value - The folder path to save result images

setPassword

public final void setPassword(String value)

Sets a password for result document.

Parameters:

value - The password