Package com.pd4ml.pdf.cos.path

Enum COSPath.RootKind

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<COSPath.RootKind>
    Enclosing class:
    COSPath
    public static enum COSPath.RootKind
extends java.lang.Enum<COSPath.RootKind>
    Where a path's navigation starts.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      OBJECT_REF
      Start at a specific, explicitly named indirect object.
      TRAILER
      Start at the document's trailer dictionary.

    • Method Summary

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

      • TRAILER

        public static final COSPath.RootKind TRAILER
        Start at the document's trailer dictionary.

      • OBJECT_REF

        public static final COSPath.RootKind OBJECT_REF
        Start at a specific, explicitly named indirect object.

    • Method Detail

      • values

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

      • valueOf

        public static COSPath.RootKind 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