com.groupdocs.comparison.options.save

Class SaveOptions.Builder

java.lang.Object

com.groupdocs.comparison.options.save.SaveOptions.Builder

Enclosing class:

SaveOptions

public static class SaveOptions.Builder
extends Object

A SaveOptions builder.

Constructor Summary

Constructors

Constructor and Description
Builder() Instantiates a new Builder object.

Method Summary

Modifier and Type	Method and Description
SaveOptions	build() Returns the object that was created and configured along with the builder.
SaveOptions.Builder	setCloneMetadataType(MetadataType value) Sets a stragegy of processing metadata saving result document.
SaveOptions.Builder	setFileAuthorMetadata(FileAuthorMetadata value) Sets a metadata object that should be set into result document when setCloneMetadataType(MetadataType) is set to MetadataType.FILE_AUTHOR.
SaveOptions.Builder	setFolderPath(String value) Sets a folder path to which result images should be saved.
SaveOptions.Builder	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

Builder

public Builder()

Instantiates a new Builder object.

Method Detail

build

public final SaveOptions build()

Returns the object that was created and configured along with the builder.

Returns:

the compare options object

setCloneMetadataType

public SaveOptions.Builder 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 SaveOptions.Builder 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 SaveOptions.Builder 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 SaveOptions.Builder setPassword(String value)

Sets a password for result document.

Parameters:

value - The password