Enum Class PDFMergerUtility.DocumentMergeMode

java.lang.Object
java.lang.Enum<PDFMergerUtility.DocumentMergeMode>
org.apache.pdfbox.multipdf.PDFMergerUtility.DocumentMergeMode
All Implemented Interfaces:
Serializable, Comparable<PDFMergerUtility.DocumentMergeMode>, Constable
Enclosing class:
PDFMergerUtility

public static enum PDFMergerUtility.DocumentMergeMode extends Enum<PDFMergerUtility.DocumentMergeMode>
The mode to use when merging documents:
  • OPTIMIZE_RESOURCES_MODE Optimizes resource handling such as closing documents early. Not all document elements are merged compared to the PDFBOX_LEGACY_MODE. Currently supported are:
    • Page content and resources
  • PDFBOX_LEGACY_MODE Keeps all files open until the merge has been completed. This is currently necessary to merge documents containing a Structure Tree.
    This is the standard mode for PDFBox 2.0.
  • Enum Constant Details

  • Constructor Details

    • DocumentMergeMode

      private DocumentMergeMode()
  • Method Details

    • values

      public static PDFMergerUtility.DocumentMergeMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PDFMergerUtility.DocumentMergeMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null