com.cerner.beadledom.json.common.model.JsonError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of beadledom-json-common Show documentation

The newest version!

package com.cerner.beadledom.json.common.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import com.google.auto.value.AutoValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.annotation.Nullable;

/**
 * Standard error body for RESTful APIs.
 *
 * @author Brian van de Boogaard
 * @since 2.6
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
    "errors",
    "code",
    "message"})
@AutoValue
@ApiModel(value = "Standard error body")
@JsonDeserialize(builder = JsonError.Builder.class)
public abstract class JsonError {

  @JsonProperty("message")
  @ApiModelProperty(value = "Human readable description of an error")
  public abstract String message();

  @JsonProperty("code")
  @ApiModelProperty(
      value = "HTTP response status code representing the error")
  public abstract int code();

  @Nullable
  @JsonProperty("errors")
  @ApiModelProperty(value = "List of additional error details")
  public abstract List errors();

  public static Builder builder() {
    return new AutoValue_JsonError.Builder();
  }

  @AutoValue.Builder
  @JsonPOJOBuilder(withPrefix = "")
  public abstract static class Builder {

    @JsonCreator
    private static Builder create() {
      return JsonError.builder();
    }

    @JsonProperty("message")
    public abstract Builder message(String value);

    @JsonProperty("code")
    public abstract Builder code(int value);

    @JsonProperty("errors")
    public abstract Builder errors(List value);

    public abstract JsonError build();
  }
}