com.groupdocs.parser.options

Class LoadOptions

java.lang.Object

com.groupdocs.parser.options.LoadOptions

public class LoadOptions
extends Object

Provides the options which are used to open a file.

An instance of this class is used as parameter in Parser class constructors:

• Parser.Parser(java.io.InputStream, LoadOptions)
• Parser.Parser(String, LoadOptions)

See the usage examples there.

Learn more:

• Loading specific file formats
• Password-protected documents

Constructor Summary

Constructors

Constructor and Description
LoadOptions() Initializes a new instance of the LoadOptions class with empty Password, FileFormat equal to FileFormat.Unknown and default encodings.
LoadOptions(Duration timeout) Initializes a new instance of the LoadOptions class with timeout.
LoadOptions(FileFormat fileFormat) Initializes a new instance of the LoadOptions class with empty Password and default encodings.
LoadOptions(FileFormat fileFormat, String password) Initializes a new instance of the LoadOptions class with default encodings.
LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset) Initializes a new instance of the LoadOptions class with custom encodings.
LoadOptions(FileFormat fileFormat, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout) Initializes a new instance of the LoadOptions fully customized class.
LoadOptions(FileType fileType) Initializes a new instance of the LoadOptions class with empty Password and default encodings.
LoadOptions(FileType fileType, String password) Initializes a new instance of the LoadOptions class with password and default encodings.
LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset) Initializes a new instance of the LoadOptions class with custom encodings.
LoadOptions(FileType fileType, String password, Charset charset, Charset defaultAnsiCharset, Duration timeout) Initializes a new instance of the LoadOptions fully customized class.
LoadOptions(String password) Initializes a new instance of the LoadOptions class with FileFormat equal to FileFormat.Unknown and default encodings.

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Gets the encoding of the document.
Charset	getDefaultAnsiCharset() Gets the default ANSI encoding which is used for encoding detection.
FileFormat	getFileFormat() Gets the file format.
FileType	getFileType() Gets the file type.
String	getPassword() Gets the password.
Duration	getTimeout() Gets the value that represents the number of milliseconds to wait.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadOptions

public LoadOptions(Duration timeout)

Initializes a new instance of the LoadOptions class with timeout.

Parameters:

timeout - The Duration that represents the number of milliseconds to wait.

LoadOptions

public LoadOptions()

Initializes a new instance of the LoadOptions class with empty Password, FileFormat equal to FileFormat.Unknown and default encodings.

LoadOptions

public LoadOptions(String password)

Initializes a new instance of the LoadOptions class with FileFormat equal to FileFormat.Unknown and default encodings.

Parameters:

password - The password to open the password-protected file.

LoadOptions

public LoadOptions(FileFormat fileFormat)

Initializes a new instance of the LoadOptions class with empty Password and default encodings.

Parameters:

fileFormat - The format of the file.

LoadOptions

public LoadOptions(FileFormat fileFormat,
                   String password)

Initializes a new instance of the LoadOptions class with default encodings.

Parameters:

fileFormat - The format of the file.

password - The password to open the password-protected file.

LoadOptions

public LoadOptions(FileFormat fileFormat,
                   String password,
                   Charset charset,
                   Charset defaultAnsiCharset)

Initializes a new instance of the LoadOptions class with custom encodings.

Parameters:

fileFormat - The format of the file.

password - The password to open the password-protected file.

charset - The encoding of the document.

defaultAnsiCharset - The default ANSI encoding which is used for encoding detection.

LoadOptions

public LoadOptions(FileFormat fileFormat,
                   String password,
                   Charset charset,
                   Charset defaultAnsiCharset,
                   Duration timeout)

Initializes a new instance of the LoadOptions fully customized class.

Parameters:

fileFormat - The format of the file.

password - The password to open the password-protected file.

charset - The encoding of the document.

defaultAnsiCharset - The default ANSI encoding which is used for encoding detection.

timeout - The Duration that represents the number of milliseconds to wait.

LoadOptions

public LoadOptions(FileType fileType)

Initializes a new instance of the LoadOptions class with empty Password and default encodings.

Parameters:

fileType - The type of the file.

LoadOptions

public LoadOptions(FileType fileType,
                   String password)

Initializes a new instance of the LoadOptions class with password and default encodings.

Parameters:

fileType - The type of the file.

password - The password to open the password-protected file.

LoadOptions

public LoadOptions(FileType fileType,
                   String password,
                   Charset charset,
                   Charset defaultAnsiCharset)

Initializes a new instance of the LoadOptions class with custom encodings.

Parameters:

fileType - The type of the file.

password - The password to open the password-protected file.

charset - The encoding of the document.

defaultAnsiCharset - The default ANSI encoding which is used for encoding detection.

LoadOptions

public LoadOptions(FileType fileType,
                   String password,
                   Charset charset,
                   Charset defaultAnsiCharset,
                   Duration timeout)

Initializes a new instance of the LoadOptions fully customized class.

Parameters:

fileType - The type of the file.

password - The password to open the password-protected file.

charset - The encoding of the document.

defaultAnsiCharset - The default ANSI encoding which is used for encoding detection.

timeout - The Duration that represents the number of milliseconds to wait.

Method Detail

getFileFormat

public FileFormat getFileFormat()

Gets the file format.

Returns:

FileFormat enumeration that contains a file format.

getFileType

public FileType getFileType()

Gets the file type.

Returns:

FileFormat enumeration that contains a file type.

getPassword

public String getPassword()

Gets the password.

Returns:

A string value that represents a password to open the password-protected file.

getCharset

public Charset getCharset()

Gets the encoding of the document.

Returns:

An instance of Charset class that represents the document encoding; null if it isn't set.

getDefaultAnsiCharset

public Charset getDefaultAnsiCharset()

Gets the default ANSI encoding which is used for encoding detection.

Returns:

An instance of Charset class that represents the document encoding; null if it isn't set.

getTimeout

public Duration getTimeout()

Gets the value that represents the number of milliseconds to wait.

Returns:

An instance of Duration that represents the number of milliseconds to wait.