br.com.modoagil.asr.rest.support.ResponseBuilder.java Source code

Introduction

Here is the source code for br.com.modoagil.asr.rest.support.ResponseBuilder.java

Source

/*
 *     Copyright 2014 Modo ?gil
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package br.com.modoagil.asr.rest.support;

import java.util.LinkedList;
import java.util.List;

import org.springframework.http.HttpStatus;

import br.com.modoagil.asr.model.support.AbstractEntity;
import br.com.modoagil.util.ReflectionUtil;

/**
 * Builder para construo de objetos para retorno dos endpoints REST
 *
 * @created 18/12/2014
 * @author Bruno Csar Ribeiro e Silva - <a href="mailto:bruno@brunocesar.com">bruno@brunocesar.com</a>
 * @see Response
 */
public class ResponseBuilder<E extends AbstractEntity> {

    private final Response<E> response;

    public ResponseBuilder() {
        this.response = new Response<E>();
    }

    /**
     * Ajusta a mensagem de reposta com a propriedade {@code success}
     *
     * @param success
     *            {@code true} se obteve sucesso no processamento da requisio, {@code false}, caso contrrio
     * @return {@link ResponseBuilder}
     */
    public ResponseBuilder<E> success(final Boolean success) {
        ReflectionUtil.setField(this.response, "success", success);
        return this;
    }

    /**
     * Ajusta a mensagem de reposta com a propriedade {@code data}
     *
     * @param data
     *            dados das entidades a serem retornados na resposta
     * @return {@link ResponseBuilder}
     */
    public ResponseBuilder<E> data(final List<E> data) {
        ReflectionUtil.setField(this.response, "data", data);
        return this;
    }

    /**
     * Ajusta a mensagem de reposta com a propriedade {@code data}
     *
     * @param data
     *            dado da entidade a ser retornado na resposta
     * @return {@link ResponseBuilder}
     */
    public ResponseBuilder<E> data(final E data) {
        final List<E> dataList = new LinkedList<E>();
        if (data != null) {
            dataList.add(data);
            ReflectionUtil.setField(this.response, "data", dataList);
        }
        return this;
    }

    /**
     * Ajusta a mensagem de reposta com a propriedade {@code count}
     *
     * @param count
     *            dados das entidades a serem retornados na resposta
     * @return {@link ResponseBuilder}
     */
    public ResponseBuilder<E> count(final Long count) {
        ReflectionUtil.setField(this.response, "count", count);
        return this;
    }

    /**
     * Ajusta a mensagem de reposta com a propriedade {@code status}
     *
     * @param message
     *            mensagem a ser includa na resposta.  o retorno do processamento
     * @return {@link ResponseBuilder}
     */
    public ResponseBuilder<E> message(final String message) {
        ReflectionUtil.setField(this.response, "message", message);
        return this;
    }

    /**
     * Ajusta a mensagem de reposta com a propriedade {@code status}
     *
     * @param status
     *            {@link HttpStatus}
     * @return {@link Response}
     */
    public ResponseBuilder<E> status(final HttpStatus status) {
        ReflectionUtil.setField(this.response, "status",
                status == null ? HttpStatus.EXPECTATION_FAILED.value() : status.value());
        return this;
    }

    public Response<E> build() {
        return this.response;
    }

}