Package com.helixframework.api.contract.error

Class ErrorResponse.Builder

java.lang.Object
com.helixframework.api.contract.error.ErrorResponse.Builder
Enclosing class:
ErrorResponse
public static class ErrorResponse.Builder extends Object
Builds instances of ErrorResponse.

  • Method Details

    • withId

      public ErrorResponse.Builder withId(String id)
      Sets the error identifier.
      Parameters:
      id - error identifier
      Returns:
      builder

    • withCode

      public ErrorResponse.Builder withCode(String code)
      Sets the application error code.
      Parameters:
      code - application error code
      Returns:
      builder

    • withStatus

      public ErrorResponse.Builder withStatus(int status)
      Sets the HTTP status.
      Parameters:
      status - HTTP status
      Returns:
      builder

    • withTimestamp

      public ErrorResponse.Builder withTimestamp(String timestamp)
      Sets the timestamp of when the error occurred.
      Parameters:
      timestamp - timestamp
      Returns:
      builder

    • withMessage

      public ErrorResponse.Builder withMessage(String message)
      Sets the error message.
      Parameters:
      message - error message
      Returns:
      builder

    • withAttribute

      public ErrorResponse.Builder withAttribute(String key, Object value)
      Adds the supplied attribute to the error.
      Parameters:
      key - attribute key
      value - attribute value
      Returns:
      builder

    • withAttributes

      public ErrorResponse.Builder withAttributes(Map<String,Object> attributes)
      Adds the supplied attributes to the error.
      Parameters:
      attributes - attributes
      Returns:
      builder

    • withSubError

      public ErrorResponse.Builder withSubError(String message)
      Adds a sub-level error message to the error.
      Parameters:
      message - field error message
      Returns:
      builder

    • withSubError

      public ErrorResponse.Builder withSubError(String name, String message)
      Adds a sub-level error message to the error.
      Parameters:
      name - field name
      message - field error message
      Returns:
      builder

    • withSubError

      public ErrorResponse.Builder withSubError(String code, String name, String message)
      Adds a sub-level error message to the error.
      Parameters:
      code - field error code
      name - field name
      message - field error message
      Returns:
      builder

    • withSubError

      public ErrorResponse.Builder withSubError(String object, String name, Object rejectedValue, String message)
      Adds a sub-level error message to the error.
      Parameters:
      object - object with error
      name - field name
      rejectedValue - rejected field value
      message - field error message
      Returns:
      builder

    • withSubError

      public ErrorResponse.Builder withSubError(String code, String object, String name, Object rejectedValue, String message)
      Adds a sub-level error message to the error.
      Parameters:
      code - field error code
      object - object with error
      name - field name
      rejectedValue - rejected field value
      message - field error message
      Returns:
      builder

    • withSubErrors

      public ErrorResponse.Builder withSubErrors(List<ErrorResponse.SubError> subErrors)
      Adds a collection of sub-level error messages to the error.
      Parameters:
      subErrors - sub-level error messages
      Returns:
      builder

    • withDebug

      public ErrorResponse.Builder withDebug(ErrorResponse.Debug debug)
      Adds debug information to the error.
      Parameters:
      debug - debug info
      Returns:
      builder

    • build

      public ErrorResponse build()
      Builds a new instance of ErrorResponse.
      Returns:
      error response