au.org.consumerdatastandards.holder.model.Error Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of data-holder Show documentation
CDS sample data holder
The newest version!
package au.org.consumerdatastandards.holder.model;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.Objects;

@ApiModel
public class Error {

    /**
     * The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
     */
    private String code;

    /**
     * A human-readable explanation specific to this occurrence of the problem.
     */
    private String detail;

    /**
     * Additional data for customised error codes
     */
    private MetaError meta;

    /**
     * A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
     */
    private String title;

    public Error() {}

    public Error(String title, String code, String detail) {
        this.title = title;
        this.code = code;
        this.detail = detail;
    }

    public Error code(String code) {
        this.code = code;
        return this;
    }

    @ApiModelProperty(required = true, value = "The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN")
    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public Error detail(String detail) {
        this.detail = detail;
        return this;
    }

    @ApiModelProperty(required = true, value = "A human-readable explanation specific to this occurrence of the problem")
    public String getDetail() {
        return detail;
    }

    public void setDetail(String detail) {
        this.detail = detail;
    }

    public Error meta(MetaError meta) {
        this.meta = meta;
        return this;
    }

    @ApiModelProperty(value = "Additional data for customised error codes")
    public MetaError getMeta() {
        return meta;
    }

    public void setMeta(MetaError meta) {
        this.meta = meta;
    }

    public Error title(String title) {
        this.title = title;
        return this;
    }

    @ApiModelProperty(required = true, value = "A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code")
    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Error responseErrorListErrors = (Error) o;
        return Objects.equals(this.code, responseErrorListErrors.code) &&
            Objects.equals(this.detail, responseErrorListErrors.detail) &&
            Objects.equals(this.meta, responseErrorListErrors.meta) &&
            Objects.equals(this.title, responseErrorListErrors.title);
    }

    @Override
    public int hashCode() {
        return Objects.hash(
            code,
            detail,
            meta,
            title);
    }

    @Override
    public String toString() {
        return "class ErrorV2 {\n" +
            "   code: " + toIndentedString(code) + "\n" + 
            "   detail: " + toIndentedString(detail) + "\n" + 
            "   meta: " + toIndentedString(meta) + "\n" + 
            "   title: " + toIndentedString(title) + "\n" + 
            "}";
    }

    /**
     * Convert the given object to string with each line indented by 4 spaces
     * (except the first line).
     */
    private String toIndentedString(Object o) {
        if (o == null) {
            return "null";
        }
        return o.toString().replace("\n", "\n    ");
    }
}