com.groupdocs.merger.domain.options

Class TextSplitOptions

java.lang.Object

com.groupdocs.merger.domain.options.TextSplitOptions

All Implemented Interfaces:

IOptions, ITextSplitOptions

public class TextSplitOptions
extends Object
implements ITextSplitOptions

Provides options for the document text splitting.

Constructor Summary

Constructors

Constructor and Description
TextSplitOptions(int[] lineNumbers) Initializes a new instance of the TextSplitOptions class.
TextSplitOptions(int mode, int[] lineNumbers) Initializes a new instance of the TextSplitOptions class.
TextSplitOptions(SplitStreamFactory splitStreamFactory, int[] lineNumbers) Initializes a new instance of the TextSplitOptions class.
TextSplitOptions(SplitStreamFactory splitStreamFactory, int mode, int[] lineNumbers) Initializes a new instance of the TextSplitOptions class.
TextSplitOptions(String filePathFormat, int[] lineNumbers) Initializes a new instance of the TextSplitOptions class.
TextSplitOptions(String filePathFormat, int mode, int[] lineNumbers) Initializes a new instance of the TextSplitOptions class.

Method Summary

Modifier and Type	Method and Description
int[]	getLineNumbers() Line numbers for text splitting.
int	getMode() Mode for text splitting.
String	getPathByIndex(int index, String extension) Gets the full file path of splitted document by index with 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 java.lang.Object

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

Constructor Detail

TextSplitOptions

public TextSplitOptions(int[] lineNumbers)

Initializes a new instance of the TextSplitOptions class.

Parameters:

lineNumbers - Line numbers for text splitting.

TextSplitOptions

public TextSplitOptions(int mode,
                        int[] lineNumbers)

Initializes a new instance of the TextSplitOptions class.

Parameters:

mode - Mode for text splitting.

lineNumbers - Line numbers for text splitting.

TextSplitOptions

public TextSplitOptions(SplitStreamFactory splitStreamFactory,
                        int[] lineNumbers)

Initializes a new instance of the TextSplitOptions class.

Parameters:

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

lineNumbers - Line numbers for text splitting.

TextSplitOptions

public TextSplitOptions(SplitStreamFactory splitStreamFactory,
                        int mode,
                        int[] lineNumbers)

Initializes a new instance of the TextSplitOptions class.

Parameters:

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

mode - Mode for text splitting.

lineNumbers - Line numbers for text splitting.

TextSplitOptions

public TextSplitOptions(String filePathFormat,
                        int[] lineNumbers)

Initializes a new instance of the TextSplitOptions class.

Parameters:

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

lineNumbers - Line numbers for text splitting.

TextSplitOptions

public TextSplitOptions(String filePathFormat,
                        int mode,
                        int[] lineNumbers)

Initializes a new instance of the TextSplitOptions class.

Parameters:

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

mode - Mode for text splitting.

lineNumbers - Line numbers for text splitting.

Method Detail

getLineNumbers

public final int[] getLineNumbers()

Line numbers for text splitting.

Specified by:

getLineNumbers in interface ITextSplitOptions

getMode

public final int getMode()

Mode for text splitting.

Specified by:

getMode in interface ITextSplitOptions

getPathByIndex

public final String getPathByIndex(int index,
                                   String extension)

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

Specified by:

getPathByIndex in interface ITextSplitOptions

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 ITextSplitOptions

validate

public final void validate(FileType fileType)
                    throws Exception

Validates the split options.

Specified by:

validate in interface ITextSplitOptions

Parameters:

fileType - The file type of FileType class.

Throws:

Exception