Enum PathFormatSelection

java.lang.Object
java.lang.Enum<PathFormatSelection>
dev.metaschema.core.metapath.format.PathFormatSelection
All Implemented Interfaces:
Serializable, Comparable<PathFormatSelection>

public enum PathFormatSelection extends Enum<PathFormatSelection>
Enumeration of path format selection options for validation output.

This enum allows users to control how node paths are formatted in validation messages and other output. The selection can be explicit (forcing a specific format) or automatic (selecting based on document format).

See Also:
  • Enum Constant Details

    • AUTO

      public static final PathFormatSelection AUTO
      Auto-select the path format based on document format.

      When this option is selected:

      • JSON documents use JSON Pointer format (RFC 6901)
      • YAML documents use JSON Pointer format (RFC 6901)
      • XML documents use XPath 3.1 EQName format

      This is the default selection when no explicit format is specified.

    • METAPATH

      public static final PathFormatSelection METAPATH
      Always use Metapath format regardless of document type.

      Produces paths like: /root/assembly[1]/field[1]/@flag

    • XPATH

      public static final PathFormatSelection XPATH
      Always use XPath 3.1 EQName format regardless of document type.

      Produces namespace-qualified paths like: /Q{http://example.com}root/Q{http://example.com}assembly[1]

    • JSON_POINTER

      public static final PathFormatSelection JSON_POINTER
      Always use RFC 6901 JSON Pointer format regardless of document type.

      Produces paths like: /root/assemblies/0/id

  • Method Details

    • values

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

      public static PathFormatSelection valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null