SplitOptions Leave feedback

On this page

Inheritance: java.lang.Object, com.groupdocs.merger.domain.options.PageOptions

All Implemented Interfaces: com.groupdocs.merger.domain.options.interfaces.ISplitOptions

public class SplitOptions extends PageOptions implements ISplitOptions

Provides options for the document page splitting.

Constructors

Constructor	Description
SplitOptions(int[] pageNumbers, int splitMode)	Initializes a new instance of the SplitOptions class.
SplitOptions(int splitMode, int startNumber, int endNumber)	Initializes a new instance of the SplitOptions class.
SplitOptions(int splitMode, int startNumber, int endNumber, int mode)	Initializes a new instance of the SplitOptions class.
SplitOptions(String filePathFormat, int[] pageNumbers)	Initializes a new instance of the SplitOptions class.
SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)	Initializes a new instance of the SplitOptions class.
SplitOptions(String filePathFormat, int startNumber, int endNumber)	Initializes a new instance of the SplitOptions class.
SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)	Initializes a new instance of the SplitOptions class.
SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)	Initializes a new instance of the SplitOptions class.
SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)	Initializes a new instance of the SplitOptions class.
SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)	Initializes a new instance of the SplitOptions class.

Methods

Method	Description
getMode()	Gets the mode for page splitting.
validate(FileType fileType)	Validates the split options.
getPathByIndex(int index, String extension)	Gets the full file path of splitted document by index with pre-defined extension.
getSplitStreamFactory()	SplitStreamFactory for create or release output page preview stream.

SplitOptions(int[] pageNumbers, int splitMode)

public SplitOptions(int[] pageNumbers, int splitMode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
pageNumbers	int[]	Page numbers.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).

SplitOptions(int splitMode, int startNumber, int endNumber)

public SplitOptions(int splitMode, int startNumber, int endNumber)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).
startNumber	int	The start page number.
endNumber	int	The end page number.

SplitOptions(int splitMode, int startNumber, int endNumber, int mode)

public SplitOptions(int splitMode, int startNumber, int endNumber, int mode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).
startNumber	int	The start page number.
endNumber	int	The end page number.
mode	int	The range mode.

SplitOptions(String filePathFormat, int[] pageNumbers)

public SplitOptions(String filePathFormat, int[] pageNumbers)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	The file path format e.g. ‘c:/split{0}.doc’ or ‘c:/split{0}.{1}’ with already pre-defined extension.
pageNumbers	int[]	Page numbers.

SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)

public SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	The file path format e.g. ‘c:/split{0}.doc’ or ‘c:/split{0}.{1}’ with already pre-defined extension.
pageNumbers	int[]	Page numbers.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).

SplitOptions(String filePathFormat, int startNumber, int endNumber)

public SplitOptions(String filePathFormat, int startNumber, int endNumber)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	The file path format e.g. ‘c:/split{0}.doc’ or ‘c:/split{0}.{1}’ with already pre-defined extension.
startNumber	int	The start page number.
endNumber	int	The end page number.

SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)

public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	The file path format e.g. ‘c:/split{0}.doc’ or ‘c:/split{0}.{1}’ with already pre-defined extension.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).
startNumber	int	The start page number.
endNumber	int	The end page number.

SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)

public SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	The file path format e.g. ‘c:/split{0}.doc’ or ‘c:/split{0}.{1}’ with already pre-defined extension.
startNumber	int	The start page number.
endNumber	int	The end page number.
mode	java.lang.Integer	The range mode.

SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)

public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	The file path format e.g. ‘c:/split{0}.doc’ or ‘c:/split{0}.{1}’ with already pre-defined extension.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).
startNumber	int	The start page number.
endNumber	int	The end page number.
mode	int	The range mode.

SplitOptions(SplitStreamFactory splitStreamFactory)

public SplitOptions(SplitStreamFactory splitStreamFactory)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.

SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)

public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.
pageNumbers	int[]	Page numbers.

SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)

public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.
pageNumbers	int[]	Page numbers.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).

SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)

public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.
startNumber	int	The start page number.
endNumber	int	The end page number.

SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)

public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).
startNumber	int	The start page number.
endNumber	int	The end page number.

SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)

public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.
startNumber	int	The start page number.
endNumber	int	The end page number.
mode	java.lang.Integer	The range mode.

SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)

public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode)

Initializes a new instance of the SplitOptions class.

Parameters:

Parameter	Type	Description
splitStreamFactory	SplitStreamFactory	The method that instantiates stream used to write output split data.
splitMode	int	The splitting mode of Mode (#getMode.getMode/#setMode(int).setMode(int)).
startNumber	int	The start page number.
endNumber	int	The end page number.
mode	int	The range mode.

getMode()

public final int getMode()

Gets the mode for page splitting.

Returns: int

validate(FileType fileType)

public final void validate(FileType fileType)

Validates the split options.

Parameters:

Parameter	Type	Description
fileType	FileType	The file type of FileType class.

getPathByIndex(int index, String extension)

public final String getPathByIndex(int index, String extension)

Gets the full file path of splitted document by index with pre-defined extension.

Parameters:

Parameter	Type	Description
index	int	Index of splitted document.
extension	java.lang.String	Extension of file.

Returns: java.lang.String - The full file path.

getSplitStreamFactory()

public SplitStreamFactory getSplitStreamFactory()

SplitStreamFactory for create or release output page preview stream.

Returns: SplitStreamFactory

We value your opinion. Your feedback will help us improve our documentation.