Package com.pdftools.pdf

Enum XfaType

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

    The XFA type of a PDF document

    See Document.getXfa() to get the XFA type of a PDF document.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static XfaType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static XfaType[] 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

      • NO_XFA

        public static final XfaType NO_XFA

        No XFA document

        The document is not an XFA document but a regular PDF document.

      • XFA_NEEDS_RENDERING

        public static final XfaType XFA_NEEDS_RENDERING

        XFA document

        The document is an XFA document. The document cannot be processed by many components, so it is recommended to convert it to a PDF document beforehand.

      • XFA_RENDERED

        public static final XfaType XFA_RENDERED

        Rendered XFA document

        The document is a "rendered" XFA document where the PDF pages' content has been generated from the XFA form. Such documents can be processed as regular PDF documents. However, there is no guarantee that the generated pages accurately reflect the XFA document.

    • Method Detail

      • values

        public static XfaType[] 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 (XfaType c : XfaType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static XfaType 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