com.groupdocs.merger.domain.options

Class SplitOptions

    • 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

      • getFilePathInfo

        public final com.groupdocs.merger.domain.result.filepath.SplitFilePathInfo getFilePathInfo()

        The output file path info.

      • 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.