com.groupdocs.comparison.options.load

Class LoadOptions

java.lang.Object

com.groupdocs.comparison.options.load.LoadOptions

public class LoadOptions
extends Object

Allows specifying additional options when loading a document.

Example usage:

 final LoadOptions loadOptions = new LoadOptions();
 loadOptions.setPassword("passw");
 loadOptions.setFileType(FileType.PDF);

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

    comparer.compare(resultFile);
 }
 

See Also:

Comparer

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
LoadOptions() Initializes a new instance of the LoadOptions class.
LoadOptions(boolean isLoadText) Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare, not path.
LoadOptions(boolean isLoadText, String password) Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare and a password to load document.
LoadOptions(FileType fileType) Initializes a new instance of the LoadOptions class with a type of a file.
LoadOptions(String password) Initializes a new instance of the LoadOptions class with a password to load document.

Method Summary

Modifier and Type	Method and Description
FileType	getFileType() Gets a type of a file that is loading.
List<String>	getFontDirectories() Gets a list of directories where font files to load a document are placed.
String	getPassword() Gets a password that will be used to load a document.
boolean	isLoadText() Gets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).
void	setFileType(FileType value) Sets a type of a file that is loading.
void	setFontDirectories(List<String> value) Sets a list of directories where font files to load a document are placed.
void	setLoadText(boolean value) Sets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).
void	setPassword(String value) Sets a password that should be used to load a document.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadOptions

public LoadOptions()

Initializes a new instance of the LoadOptions class.

LoadOptions

public LoadOptions(boolean isLoadText)

Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare, not path.

Parameters:

isLoadText - The flag which means that input string is a text to compare, not path

LoadOptions

public LoadOptions(boolean isLoadText,
                   String password)

Initializes a new instance of the LoadOptions class with a flag which means that input string is a text to compare and a password to load document.

Parameters:

isLoadText - The flag which means that input string is a text to compare, not path

password - The password to load document

LoadOptions

public LoadOptions(FileType fileType)

Initializes a new instance of the LoadOptions class with a type of a file.

Parameters:

fileType - The type of the file

LoadOptions

public LoadOptions(String password)

Initializes a new instance of the LoadOptions class with a password to load document.

Parameters:

password - The password to load document

Method Detail

getFileType

public FileType getFileType()

Gets a type of a file that is loading.

Returns:

the type of the file

getFontDirectories

public List<String> getFontDirectories()

Gets a list of directories where font files to load a document are placed.

Returns:

the list of directories with font files

getPassword

public final String getPassword()

Gets a password that will be used to load a document.

Returns:

the password to load the document

isLoadText

public boolean isLoadText()

Gets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).

Returns:

true if input string is a text to compare, otherwise false

setFileType

public void setFileType(FileType value)

Sets a type of a file that is loading.

Parameters:

value - The type of the file

setFontDirectories

public void setFontDirectories(List<String> value)

Sets a list of directories where font files to load a document are placed.

Parameters:

value - The list of directories with font files

setLoadText

public void setLoadText(boolean value)

Sets a flag that indicates that the string passed to Comparer constructor or to Comparer.add(String) method is comparison text, not file paths (For Text Comparison only).

Parameters:

value - true if input string is a text to compare, otherwise false

setPassword

public final void setPassword(String value)

Sets a password that should be used to load a document.

Parameters:

value - The password to load the document