com.groupdocs.merger.domain.options

Class LoadOptions

java.lang.Object

com.groupdocs.merger.domain.options.LoadOptions

All Implemented Interfaces:

ILoadOptions, IOptions

public class LoadOptions
extends Object
implements ILoadOptions

Provides options for the document loading.

Constructor Summary

Constructors

Constructor and Description
LoadOptions(FileType fileType) Initializes new instance of LoadOptions class.
LoadOptions(FileType iniFileType, FileType fileType) Initializes new instance of LoadOptions class.
LoadOptions(FileType iniFileType, FileType fileType, String password) Initializes new instance of LoadOptions class.
LoadOptions(FileType iniFileType, FileType fileType, String password, Charset encoding) Initializes new instance of LoadOptions class.
LoadOptions(FileType fileType, String password) Initializes new instance of LoadOptions class.
LoadOptions(FileType fileType, String password, Charset encoding) Initializes new instance of LoadOptions class.
LoadOptions(String password) Initializes new instance of LoadOptions class.
LoadOptions(String password, Charset encoding) Initializes new instance of LoadOptions class.
LoadOptions(String extension, FileType fileType, String password, Charset encoding) Initializes new instance of LoadOptions class.

Method Summary

Modifier and Type	Method and Description
Charset	getEncoding() The encoding used when opening text-based files such as FileType.CSV or FileType.TXT.
String	getExtension() The extension of the file to init.
String	getPassword() The password for opening password-protected file.
FileType	getType() The type of the file to load.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadOptions

public LoadOptions(FileType fileType)

Initializes new instance of LoadOptions class.

Parameters:

fileType - The type of the file to load.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

LoadOptions

public LoadOptions(FileType iniFileType,
                   FileType fileType)

Initializes new instance of LoadOptions class.

Parameters:

iniFileType - The type of the file to init.

fileType - The type of the file to load.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when iniFileType is null.

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

LoadOptions

public LoadOptions(FileType iniFileType,
                   FileType fileType,
                   String password)

Initializes new instance of LoadOptions class.

Parameters:

iniFileType - The type of the file to init.

fileType - The type of the file to load.

password - The password for opening password-protected file.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when iniFileType is null.

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

LoadOptions

public LoadOptions(FileType iniFileType,
                   FileType fileType,
                   String password,
                   Charset encoding)

Initializes new instance of LoadOptions class.

Parameters:

iniFileType - The type of the file to init.

fileType - The type of the file to load.

password - The password for opening password-protected file.

encoding - The encoding used when opening text-based files such as FileType.CSV or FileType.TXT.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when iniFileType is null.

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

com.aspose.ms.System.ArgumentNullException - Thrown when encoding is null.

LoadOptions

public LoadOptions(FileType fileType,
                   String password)

Initializes new instance of LoadOptions class.

Parameters:

fileType - The type of the file to load.

password - The password for opening password-protected file.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

LoadOptions

public LoadOptions(FileType fileType,
                   String password,
                   Charset encoding)

Initializes new instance of LoadOptions class.

Parameters:

fileType - The type of the file to load.

password - The password for opening password-protected file.

encoding - The encoding used when opening text-based files such as FileType.CSV or FileType.TXT.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

com.aspose.ms.System.ArgumentNullException - Thrown when encoding is null.

LoadOptions

public LoadOptions(String password)

Initializes new instance of LoadOptions class.

Parameters:

password - The password for opening password-protected file.

LoadOptions

public LoadOptions(String password,
                   Charset encoding)

Initializes new instance of LoadOptions class.

Parameters:

password - The password for opening password-protected file.

encoding - The encoding used when opening text-based files such as FileType.CSV or FileType.TXT.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when encoding is null.

LoadOptions

public LoadOptions(String extension,
                   FileType fileType,
                   String password,
                   Charset encoding)

Initializes new instance of LoadOptions class.

Parameters:

extension - The extension of the file to load.

fileType - The type of the file to load.

password - The password for opening password-protected file.

encoding - The encoding used when opening text-based files such as FileType.CSV or FileType.TXT.

Throws:

com.aspose.ms.System.ArgumentNullException - Thrown when fileType is null.

com.aspose.ms.System.ArgumentNullException - Thrown when encoding is null.

Method Detail

getEncoding

public final Charset getEncoding()

The encoding used when opening text-based files such as FileType.CSV or FileType.TXT. Default value is System.Text.Encoding.Default(Charset).

Specified by:

getEncoding in interface ILoadOptions

getExtension

public final String getExtension()

The extension of the file to init.

Specified by:

getExtension in interface ILoadOptions

getPassword

public final String getPassword()

The password for opening password-protected file.

Specified by:

getPassword in interface ILoadOptions

getType

public final FileType getType()

The type of the file to load.

Specified by:

getType in interface ILoadOptions