Enum Class PipesResult.RESULT_STATUS

java.lang.Object
java.lang.Enum<PipesResult.RESULT_STATUS>
org.apache.tika.pipes.api.PipesResult.RESULT_STATUS
All Implemented Interfaces:
Serializable, Comparable<PipesResult.RESULT_STATUS>, Constable
Enclosing class:
PipesResult

public static enum PipesResult.RESULT_STATUS extends Enum<PipesResult.RESULT_STATUS>
  • Enum Constant Details

  • Method Details

    • values

      public static PipesResult.RESULT_STATUS[] 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 PipesResult.RESULT_STATUS 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
    • getCategory

      public PipesResult.CATEGORY getCategory()
      Gets the high-level category for this result status.
      Returns:
      the category (FATAL, INITIALIZATION_FAILURE, TASK_EXCEPTION, PROCESS_CRASH, or SUCCESS)
    • isFatal

      public boolean isFatal()
      Checks if this status represents a fatal error.

      Fatal errors mean the system cannot continue and must be fixed and restarted.

      Returns:
      true if this is a fatal error
    • isInitializationFailure

      public boolean isInitializationFailure()
      Checks if this status represents an initialization failure.

      Initialization failures occur when a component (fetcher, emitter, client) fails to start. These might be transient (e.g., network issues) or require configuration fixes.

      Returns:
      true if a component failed to initialize
    • isTaskException

      public boolean isTaskException()
      Checks if this status represents a task-level exception.

      Task exceptions indicate this specific task failed, but other tasks may succeed. Processing can continue with the next task.

      Returns:
      true if this task failed
    • isProcessCrash

      public boolean isProcessCrash()
      Checks if this status represents a process crash (OOM, timeout, etc.).

      Process crashes are system-level failures where the forked process terminated abnormally. The process will be auto-restarted and processing can continue.

      Returns:
      true if the forked process crashed
    • isSuccess

      public boolean isSuccess()
      Checks if this status represents successful processing.

      Success includes normal completion as well as cases where processing completed with warnings (e.g., PARSE_SUCCESS_WITH_EXCEPTION).

      Returns:
      true if processing completed successfully (possibly with warnings)
    • lookup

      public static PipesResult.RESULT_STATUS lookup(int b)
    • getByte

      public byte getByte()