com.yahoo.elide.ElideErrorResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elide-core Show documentation
Elide Core
There is a newer version: 7.1.4
/*
 * Copyright 2023, the original author or authors.
 * Licensed under the Apache License, Version 2.0
 * See LICENSE file in project root for terms.
 */
package com.yahoo.elide;

import com.yahoo.elide.ElideErrors.ElideErrorsBuilder;
import com.yahoo.elide.core.exceptions.HttpStatus;

import java.util.function.Consumer;

/**
 * Elide Error Response.
 * 
 * Builder example:
 * 

 * ElideErrorResponse.status(400)
 *     .errors(errors -> errors.error(error -> error.message(message)))
 *     .build();
 * 
 *
 * @param  the body type
 */
public class ElideErrorResponse extends ElideResponse {
    /**
     * Constructor.
     *
     * @param status HTTP response status
     * @param body the body
     */
    public ElideErrorResponse(int status, T body) {
        super(status, body);
    }

    /**
     * Builds a response with this HTTP status code.
     *
     * @param status the HTTP status code
     * @return the builder
     */
    public static ElideErrorResponseBuilder status(int status) {
        return new ElideErrorResponseBuilder(status);
    }

    /**
     * Build a response with 200.
     *
     * @return the builder
     */
    public static ElideErrorResponseBuilder ok() {
        return status(HttpStatus.SC_OK);
    }

    /**
     * Build a response with 200.
     *
     * @param  the body type
     * @param body the body
     * @return the response
     */
    public static  ElideErrorResponse ok(T body) {
        return ok().body(body);
    }

    /**
     * Build a response with 400.
     *
     * @return the builder
     */
    public static ElideErrorResponseBuilder badRequest() {
        return status(HttpStatus.SC_BAD_REQUEST);
    }

    /**
     * Build a response with 400.
     *
     * @param  the body type
     * @param body the body
     * @return the response
     */
    public static  ElideErrorResponse badRequest(T body) {
        return badRequest().body(body);
    }

    /**
     * Builder for building a {@link ElideErrorResponse}.
     */
    public static class ElideErrorResponseBuilder extends ElideResponseBuilder {

        public ElideErrorResponseBuilder(int status) {
            super(status);
        }

        /**
         * Sets the body of the response.
         *
         * @param  the body type
         * @param body the body
         * @return the response
         */
        public  ElideErrorResponse body(T body) {
            return new ElideErrorResponse<>(status, body);
        }

        /**
         * Build the response with no body.
         *
         * @param  the body type
         * @return the response
         */
        public  ElideErrorResponse build() {
            return new ElideErrorResponse<>(status, null);
        }

        /**
         * Sets the body of the response to {@link ElideErrors}.
         *
         * @param errors to customize
         * @return the response
         */
        public ElideErrorResponse errors(Consumer errors) {
            ElideErrors.ElideErrorsBuilder builder = ElideErrors.builder();
            errors.accept(builder);
            return body(builder.build());
        }
    }
}