io.github.belgif.rest.problem.api.InputValidationProblem Maven / Gradle / Ivy

Go to download
package io.github.belgif.rest.problem.api;

import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

import com.fasterxml.jackson.annotation.JsonSetter;

/**
 * Abstract base class for input validation problems.
 *
 * Maps to InputValidationProblem in belgif/problem/v1/problem-v1.yaml.
 *
 * @see InputValidationIssue
 */
public abstract class InputValidationProblem extends ClientProblem {

    private static final long serialVersionUID = 1L;

    private final List issues = new ArrayList<>();

    /**
     * Deprecated invalid params, for backwards compatibility with supplier services using legacy problem type.
     *
     * @deprecated use {@link #issues}
     */
    @Deprecated
    private final List invalidParams = new ArrayList<>();

    protected InputValidationProblem(URI type, URI href, String title, int status) {
        super(type, href, title, status);
    }

    protected InputValidationProblem(URI type, String title, int status) {
        super(type, title, status);
    }

    protected InputValidationProblem(URI type, URI href, String title, int status, Throwable cause) {
        super(type, href, title, status, cause);
    }

    protected InputValidationProblem(URI type, String title, int status, Throwable cause) {
        super(type, title, status, cause);
    }

    public List getIssues() {
        return Collections.unmodifiableList(issues);
    }

    @JsonSetter
    public void setIssues(List issues) {
        this.issues.clear();
        this.issues.addAll(issues);
    }

    public void setIssues(InputValidationIssue... issues) {
        this.issues.clear();
        this.issues.addAll(Arrays.asList(issues));
    }

    public void addIssue(InputValidationIssue issue) {
        issues.add(issue);
    }

    /**
     * @deprecated use {@link #getIssues()}
     */
    @Deprecated
    public List getInvalidParams() {
        return Collections.unmodifiableList(invalidParams);
    }

    /**
     * @deprecated use {@link #setIssues(List)}
     */
    @JsonSetter
    @Deprecated
    public void setInvalidParams(List invalidParams) {
        this.invalidParams.clear();
        this.invalidParams.addAll(invalidParams);
    }

    /**
     * @deprecated use {@link #setIssues(InputValidationIssue...)}
     */
    @Deprecated
    public void setInvalidParams(InvalidParam... invalidParams) {
        this.invalidParams.clear();
        this.invalidParams.addAll(Arrays.asList(invalidParams));
    }

    /**
     * @deprecated use {@link #addIssue(InputValidationIssue)}
     */
    @Deprecated
    public void addInvalidParam(InvalidParam invalidParam) {
        invalidParams.add(invalidParam);
    }

    @Override
    public String getMessage() {
        StringBuilder message = new StringBuilder(super.getMessage());
        for (InputValidationIssue issue : issues) {
            if (issue.getTitle() != null || issue.getDetail() != null) {
                if (issue.getTitle() != null && issue.getDetail() != null) {
                    message.append("\n- " + issue.getTitle() + ": " + issue.getDetail());
                } else if (issue.getTitle() != null) {
                    message.append("\n- " + issue.getTitle());
                } else if (issue.getDetail() != null) {
                    message.append("\n- " + issue.getDetail());
                }
            } else if (issue.getType() != null) {
                message.append("\n- " + issue.getType());
            }
        }
        return message.toString();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        if (!super.equals(o)) {
            return false;
        }
        InputValidationProblem that = (InputValidationProblem) o;
        return Objects.equals(issues, that.issues) && Objects.equals(invalidParams, that.invalidParams);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), issues, invalidParams);
    }

}