Package com.commercetools.api.models.error

Interface CircularDependencyError

All Superinterfaces:
ErrorObject
public interface CircularDependencyError extends ErrorObject

Returned when a circular reference is detected among Extension dependencies.

Example to create an instance using the builder pattern 

     CircularDependencyError circularDependencyError = CircularDependencyError.builder()
             .message("{message}")
             .build()

  • Field Details

    • CIRCULAR_DEPENDENCY

      static final String CIRCULAR_DEPENDENCY
      discriminator value for CircularDependencyError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      "Circular dependency detected: [ext-1, ext-2, ext-1]"

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • setMessage

      void setMessage(String message)

      "Circular dependency detected: [ext-1, ext-2, ext-1]"

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • of

      static CircularDependencyError of()
      factory method
      Returns:
      instance of CircularDependencyError

    • of

      static CircularDependencyError of(CircularDependencyError template)
      factory method to create a shallow copy CircularDependencyError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      CircularDependencyError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

      @Nullable static CircularDependencyError deepCopy(@Nullable CircularDependencyError template)
      factory method to create a deep copy of CircularDependencyError
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CircularDependencyErrorBuilder builder()
      builder factory method for CircularDependencyError
      Returns:
      builder

    • builder

      static CircularDependencyErrorBuilder builder(CircularDependencyError template)
      create builder for CircularDependencyError instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCircularDependencyError

      default <T> T withCircularDependencyError(Function<CircularDependencyError,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<CircularDependencyError> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference