LoadOptions (groupdocs-comparison (26.10) API Reference)

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.

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

All Methods Instance Methods Concrete Methods
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.
`List<String>`	`getWhitelistedResources()` Gets the resources that are still loaded while `isSkipExternalResources()` is on.
`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).
`boolean`	`isSkipExternalResources()` Gets whether loading of external resources referenced by a document is disabled.
`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.
`void`	`setSkipExternalResources(boolean value)` Sets whether loading of external resources referenced by a document is disabled.
`void`	`setWhitelistedResources(List<String> value)` Sets the resources that are still loaded while `isSkipExternalResources()` is on.

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
  - getWhitelistedResources
```
public List<String> getWhitelistedResources()
```
    Gets the resources that are still loaded while isSkipExternalResources() is on.
    
    Returns:
    
    the URL fragments of the allowed resources
  - 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
  - isSkipExternalResources
```
public boolean isSkipExternalResources()
```
    Gets whether loading of external resources referenced by a document is disabled.
    
    A document can point at resources outside itself, for example an image given by a remote URL. Loading those means the comparison reaches out to whatever address the document names, so it is off by default; getWhitelistedResources() lets named resources through while it is on.
    
    Returns:
    
    true when external resources are not loaded, which is the default
  - 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
  - setSkipExternalResources
```
public void setSkipExternalResources(boolean value)
```
    Sets whether loading of external resources referenced by a document is disabled.
    
    Parameters:
    
    value - true to leave external resources unloaded, false to allow them
  - setWhitelistedResources
```
public void setWhitelistedResources(List<String> value)
```
    Sets the resources that are still loaded while isSkipExternalResources() is on.
    
    Parameters:
    
    value - The URL fragments of the allowed resources

Class LoadOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LoadOptions

LoadOptions

LoadOptions

LoadOptions

LoadOptions

Method Detail

getFileType

getFontDirectories

getPassword

getWhitelistedResources

isLoadText

isSkipExternalResources

setFileType

setFontDirectories

setLoadText

setPassword

setSkipExternalResources

setWhitelistedResources