Enum Class ParsingIntent

java.lang.Object
java.lang.Enum<ParsingIntent>
org.apache.tika.parser.ParsingIntent
All Implemented Interfaces:
Serializable, Comparable<ParsingIntent>, Constable

public enum ParsingIntent extends Enum<ParsingIntent>
Parsing intent, set in the ParseContext before detection.

WILL_PARSE signals detectors that parsing will follow, so they may prepare durable state for the parser (e.g. salvage a corrupted ZIP into the open container). Set automatically by AutoDetectParser.

Consumers must compare against a specific constant, never test for mere presence, so that new intents can be added without changing their behavior.

  • Enum Constant Details

    • WILL_PARSE

      public static final ParsingIntent WILL_PARSE
      Parsing will follow detection.
  • Method Details

    • values

      public static ParsingIntent[] 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 ParsingIntent 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