Package com.saperion.connector.options

Class Options

  • public class Options
extends java.lang.Object
    A class that contains the options that are used to generate a rendition like
    • target format
    • timeout
    • engine specific additional options
    This class implements a builder-pattern. To create a new Options instance use newOptions(TargetFormat).

    • Field Detail

      • DEFAULT_TARGET

        public static final TargetFormat DEFAULT_TARGET

      • DEFAULT_TIMEOUT

        public static final TimeOut DEFAULT_TIMEOUT

    • Constructor Detail

      • Options

        protected Options()
        Instantiates a new options.

    • Method Detail

      • renderWholeDocument

        public boolean renderWholeDocument()
        Returns:
        true, if whole document should be rendered

      • getPaging

        public Paging getPaging()
        Returns:
        the page or pages to be rendered

      • getTargetFormat

        public TargetFormat getTargetFormat()
        Returns:
        the format to render to

      • getRedactions

        public RedactionMode getRedactions()
        Returns:
        the redaction-mode settings

      • getTimeOut

        public TimeOut getTimeOut()
        Returns:
        timeout for the render-process

      • getAdditionalOptions

        public AdditionalOptions getAdditionalOptions()
        Gets the additional options.
        Returns:
        the additional options

      • getPageToRender

        public int getPageToRender()
        Convenience method to find out the number of the page to be rendered. If only one single page is requested, the page number is returned. For all other cases, -1 is returned.
        Returns:
        number of page to render, or -1 if more than one page or the whole document will be rendered

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • newOptions

        public static Options.BuilderChain newOptions​(TargetFormat target)
        Creates a new options instance with the specified target format.
        Parameters:
        target - the target format
        Returns:
        the builder chain that can be used to complete the creation of the options instance