com.scalar.dl.ledger.error.ScalarDlError Maven / Gradle / Ivy

Go to download
package com.scalar.dl.ledger.error;

import com.scalar.dl.ledger.service.StatusCode;
import java.util.Objects;

public interface ScalarDlError {

  String getComponentName();

  StatusCode getStatusCode();

  String getId();

  String getMessage();

  String getCause();

  String getSolution();

  // This method validates the error. It is called in the constructor of the enum to ensure that the
  // error is valid.
  default void validate(
      String componentName,
      StatusCode statusCode,
      String id,
      String message,
      String cause,
      String solution) {
    Objects.requireNonNull(componentName, "The component name must not be null.");
    Objects.requireNonNull(statusCode, "The status code must not be null.");

    Objects.requireNonNull(id, "The id must not be null.");
    if (id.length() != 3) {
      throw new IllegalArgumentException("The length of the id must be 3.");
    }

    Objects.requireNonNull(message, "The message must not be null.");
    Objects.requireNonNull(cause, "The cause must not be null.");
    Objects.requireNonNull(solution, "The solution must not be null.");
  }

  /**
   * Builds the error code. The code is built as follows:
   *
   * {@code -}
   *
   * @return the built code
   */
  default String buildCode() {
    return getComponentName() + "-" + getStatusCode().get() + getId();
  }

  /**
   * Builds the error message with the given arguments. The message is built as follows:
   *
   * {@code -: }
   *
   * @param args the arguments to be formatted into the message
   * @return the formatted message
   */
  default String buildMessage(Object... args) {
    return buildCode()
        + ": "
        + (args.length == 0 ? getMessage() : String.format(getMessage(), args));
  }
}