Package com.pdftools.ocr

Enum PageProcessingMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PageProcessingMode>
    public enum PageProcessingMode
extends java.lang.Enum<PageProcessingMode>

    The mode for processing pages in OCR

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADD_RESULTS
      Do not trigger OCR processing of pages.
      ALL
      Process all pages that are not empty.
      IF_NO_TEXT
      Process all pages that contain content but no text.
      NONE
      Do not process pages.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PageProcessingMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PageProcessingMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • IF_NO_TEXT

        public static final PageProcessingMode IF_NO_TEXT
        Process all pages that contain content but no text.

      • ADD_RESULTS

        public static final PageProcessingMode ADD_RESULTS
        Do not trigger OCR processing of pages. But if pages are OCR processed due to another OCR mode, add results as OCR text to pages.

    • Method Detail

      • values

        public static PageProcessingMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (PageProcessingMode c : PageProcessingMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static PageProcessingMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null