LoadOptions Leave feedback

Inheritance: java.lang.Object

public class LoadOptions

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

public LoadOptions(Duration timeout)

Initializes a new instance of the LoadOptions class with timeout .

Parameters:

public LoadOptions()

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

public LoadOptions(String password)

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

Parameters:

public LoadOptions(FileFormat fileFormat)

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

Parameters:

public LoadOptions(FileFormat fileFormat, String password)

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

Parameters:

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

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

Parameters:

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

Initializes a new instance of the LoadOptions fully customized class.

Parameters:

public LoadOptions(FileType fileType)

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

Parameters:

public LoadOptions(FileType fileType, String password)

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

Parameters:

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

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

Parameters:

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

Initializes a new instance of the LoadOptions fully customized class.

Parameters:

public FileFormat getFileFormat()

Gets the file format.

Returns: FileFormat - FileFormat enumeration that contains a file format.

public FileType getFileType()

Gets the file type.

Returns: FileType - FileFormat enumeration that contains a file type.

public String getPassword()

Gets the password.

Returns: java.lang.String - A string value that represents a password to open the password-protected file.

public Charset getCharset()

Gets the encoding of the document.

Returns: java.nio.charset.Charset - An instance of Charset class that represents the document encoding; null if it isn’t set.

public Charset getDefaultAnsiCharset()

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

Returns: java.nio.charset.Charset - An instance of Charset class that represents the document encoding; null if it isn’t set.

public Duration getTimeout()

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

Returns: java.time.Duration - An instance of Duration that represents the number of milliseconds to wait.