Package io.jenkins.plugins.configsplice.engine

Enum Class ErrorCode

java.lang.Object
java.lang.Enum<ErrorCode>
io.jenkins.plugins.configsplice.engine.ErrorCode
All Implemented Interfaces:
Serializable, Comparable<ErrorCode>, Constable
public enum ErrorCode extends Enum<ErrorCode>
User-facing error categories from SRS section 15.3.

Every failure surfaced to a Jenkins build is classified by one of these codes. The code is the stable part of the contract; the accompanying message is explanatory and must always be value-free (SRS section 12.5): it may name files, property paths and offsets, but never current values, replacement values, credential IDs or source excerpts.

  • Enum Constant Details

    • PATH_SYNTAX

      public static final ErrorCode PATH_SYNTAX

    • XML_PATH_UNSUPPORTED

      public static final ErrorCode XML_PATH_UNSUPPORTED
      No longer reachable from a step invocation.

      Since SRS section 8.7 added generic XML paths, every XML path is either a shorthand or a generic path, so nothing is left to be "unsupported". Retained because the code is part of the documented contract of section 15.3 and is still produced by DotNetPathParser when that parser is called directly with a non-shorthand path.

    • TARGET_GROUP_OVERLAP

      public static final ErrorCode TARGET_GROUP_OVERLAP

    • FILE_NOT_FOUND

      public static final ErrorCode FILE_NOT_FOUND

    • PATH_MISSING

      public static final ErrorCode PATH_MISSING

    • PATH_AMBIGUOUS

      public static final ErrorCode PATH_AMBIGUOUS

    • NON_SCALAR

      public static final ErrorCode NON_SCALAR

    • TYPE_INVALID

      public static final ErrorCode TYPE_INVALID

    • CREDENTIAL_TYPE_ACK_REQUIRED

      public static final ErrorCode CREDENTIAL_TYPE_ACK_REQUIRED

    • DUPLICATE_JSON_KEY

      public static final ErrorCode DUPLICATE_JSON_KEY

    • CREDENTIAL_UNAVAILABLE

      public static final ErrorCode CREDENTIAL_UNAVAILABLE

    • UNSUPPORTED_ENCODING

      public static final ErrorCode UNSUPPORTED_ENCODING

    • WORKSPACE_ESCAPE

      public static final ErrorCode WORKSPACE_ESCAPE

    • PARSE_FAILED

      public static final ErrorCode PARSE_FAILED

    • SOURCE_CHANGED

      public static final ErrorCode SOURCE_CHANGED

    • WRITE_FAILED

      public static final ErrorCode WRITE_FAILED

  • Method Details

    • values

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

    • wireName

      public String wireName()
      Returns the wire form used in logs and documentation, e.g. CONFIG_SUBSTITUTION_PATH_SYNTAX.