LoadOptions Leave feedback

Inheritance: java.lang.Object

public class LoadOptions

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

public LoadOptions()

Initializes a new instance of the LoadOptions class.

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:

public LoadOptions(String password)

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

Parameters:

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:

public LoadOptions(FileType fileType)

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

Parameters:

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: boolean - true if input string is a text to compare, otherwise false

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:

public final String getPassword()

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

Returns: java.lang.String - the password to load the document

public final void setPassword(String value)

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

Parameters:

public List<String> getFontDirectories()

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

Returns: java.util.List<java.lang.String> - the list of directories with font files

public void setFontDirectories(List<String> value)

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

Parameters:

public FileType getFileType()

Gets a type of a file that is loading.

Returns: FileType - the type of the file

public void setFileType(FileType value)

Sets a type of a file that is loading.

Parameters:

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().getWhitelistedResources() lets named resources through while it is on.

Returns: boolean - true when external resources are not loaded, which is the default

public void setSkipExternalResources(boolean value)

Sets whether loading of external resources referenced by a document is disabled.

Parameters:

public List<String> getWhitelistedResources()

Gets the resources that are still loaded while #isSkipExternalResources().isSkipExternalResources() is on.

Returns: java.util.List<java.lang.String> - the URL fragments of the allowed resources

public void setWhitelistedResources(List<String> value)

Sets the resources that are still loaded while #isSkipExternalResources().isSkipExternalResources() is on.

Parameters: