com.groupdocs.merger.domain.options

Class SplitOptions

java.lang.Object

com.groupdocs.merger.domain.options.PageOptions

com.groupdocs.merger.domain.options.SplitOptions

All Implemented Interfaces:

IOptions, IPageOptions, ISplitOptions

public class SplitOptions
extends PageOptions
implements ISplitOptions

Provides options for the document page splitting.

Constructor Summary

Constructors

Constructor and 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(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.
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.

Method Summary

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

Methods inherited from class com.groupdocs.merger.domain.options.PageOptions

pages

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groupdocs.merger.domain.options.interfaces.IPageOptions

getPages

Constructor Detail

SplitOptions

public SplitOptions(int[] pageNumbers,
                    int splitMode)

Initializes a new instance of the SplitOptions class.

Parameters:

pageNumbers - Page numbers.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

startNumber - The start page number.

endNumber - The end page number.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

startNumber - The start page number.

endNumber - The end page number.

mode - The range mode.

Throws:

Exception

SplitOptions

public SplitOptions(SplitStreamFactory splitStreamFactory)

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

SplitOptions

public SplitOptions(SplitStreamFactory splitStreamFactory,
                    int[] pageNumbers)

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

pageNumbers - Page numbers.

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

pageNumbers - Page numbers.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

startNumber - The start page number.

endNumber - The end page number.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

startNumber - The start page number.

endNumber - The end page number.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

startNumber - The start page number.

endNumber - The end page number.

mode - The range mode.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

splitStreamFactory - The method that instantiates stream used to write output split data.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

startNumber - The start page number.

endNumber - The end page number.

mode - The range mode.

Throws:

Exception

SplitOptions

public SplitOptions(String filePathFormat,
                    int[] pageNumbers)

Initializes a new instance of the SplitOptions class.

Parameters:

filePathFormat - The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.

pageNumbers - Page numbers.

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

filePathFormat - The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.

pageNumbers - Page numbers.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

filePathFormat - The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.

startNumber - The start page number.

endNumber - The end page number.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

filePathFormat - The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

startNumber - The start page number.

endNumber - The end page number.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

filePathFormat - The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.

startNumber - The start page number.

endNumber - The end page number.

mode - The range mode.

Throws:

Exception

SplitOptions

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

Initializes a new instance of the SplitOptions class.

Parameters:

filePathFormat - The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.

splitMode - The splitting mode of Mode(getMode()/setMode(int)).

startNumber - The start page number.

endNumber - The end page number.

mode - The range mode.

Throws:

Exception

Method Detail

getMode

public final int getMode()

Gets the mode for page splitting.

Specified by:

getMode in interface ISplitOptions

getPathByIndex

public final String getPathByIndex(int index,
                                   String extension)

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

Specified by:

getPathByIndex in interface ISplitOptions

Parameters:

index - Index of splitted document.

extension - Extension of file.

Returns:

The full file path.

getSplitStreamFactory

public SplitStreamFactory getSplitStreamFactory()

SplitStreamFactory for create or release output page preview stream.

Specified by:

getSplitStreamFactory in interface ISplitOptions

validate

public final void validate(FileType fileType)
                    throws Exception

Validates the split options.

Specified by:

validate in interface ISplitOptions

Parameters:

fileType - The file type of FileType class.

Throws:

Exception