SaveOptions

Inheritance: java.lang.Object

public class SaveOptions

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);
 }
 

Constructors

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

Methods

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

SaveOptions()

public SaveOptions()

Initializes a new instance of the SaveOptions class.

getCloneMetadataType()

public final MetadataType getCloneMetadataType()

Gets a strategy of processing metadata saving result document.

Possible values are in enum MetadataType

Returns: MetadataType - the stragegy of processing metadata

setCloneMetadataType(MetadataType value)

public final void setCloneMetadataType(MetadataType value)

Sets a stragegy of processing metadata saving result document.

Possible values are in enum MetadataType

Parameters:

Parameter	Type	Description
value	MetadataType	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: FileAuthorMetadata - the metadata object

setFileAuthorMetadata(FileAuthorMetadata value)

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:

Parameter	Type	Description
value	FileAuthorMetadata	The metadata object

getPassword()

public final String getPassword()

Gets a password for result document.

Returns: java.lang.String - the password

setPassword(String value)

public final void setPassword(String value)

Sets a password for result document.

Parameters:

Parameter	Type	Description
value	java.lang.String	The password

getFolderPath()

public final String getFolderPath()

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

Used for Imaging Comparison only.

Returns: java.lang.String - the folder path to save result images

setFolderPath(String value)

public final void setFolderPath(String value)

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

Used for Imaging Comparison only.

Parameters:

Parameter	Type	Description
value	java.lang.String	The folder path to save result images

setFolderPath(Path value)

public final void setFolderPath(Path value)

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

Used for Imaging Comparison only.

Parameters:

Parameter	Type	Description
value	java.nio.file.Path	The folder path to save result images