com.github.wnameless.spring.bulkapi.BulkResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-batch-api Show documentation
Add bulk operations support to any Spring RESTful API by a single annotation @EnableBulkApi.
The newest version!
/**
 *
 * @author Wei-Ming Wu
 *
 *
 * Copyright 2015 Wei-Ming Wu
 *
 * 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 com.github.wnameless.spring.bulkapi;

import java.util.Map;

/**
 * 
 * {@link BulkResult} contains all details of a RESTful operation outcome.
 *
 */
public final class BulkResult {

  private short status;
  private String body;
  private Map headers;

  /**
   * Returns the HTTP status code of a RESTful operation outcome.
   * 
   * @return a HTTP status code
   */
  public short getStatus() {
    return status;
  }

  /**
   * Sets the HTTP status code of a RESTful operation outcome.
   * 
   * @param status
   *          a HTTP status code
   */
  public void setStatus(short status) {
    this.status = status;
  }

  /**
   * Returns the HTTP response body of a RESTful operation outcome.
   * 
   * @return a HTTP response body
   */
  public String getBody() {
    return body;
  }

  /**
   * Sets the HTTP response body of a RESTful operation outcome.
   * 
   * @param body
   *          a HTTP response body
   */
  public void setBody(String body) {
    this.body = body;
  }

  /**
   * Returns headers of a RESTful operation outcome.
   * 
   * @return headers of a RESTful operation outcome
   */
  public Map getHeaders() {
    return headers;
  }

  /**
   * Sets headers of a RESTful operation outcome.
   * 
   * @param headers
   *          headers of a RESTful operation outcome
   */
  public void setHeaders(Map headers) {
    this.headers = headers;
  }

  @Override
  public int hashCode() {
    int result = 27;

    result = 31 ^ result + status;
    result = 31 ^ result + ((body == null) ? 0 : body.hashCode());
    result = 31 ^ result + ((headers == null) ? 0 : headers.hashCode());

    return result;
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == this) return true;
    if (obj == null) return false;
    if (!(obj instanceof BulkResult)) return false;

    BulkResult o = (BulkResult) obj;

    return status == o.status
        && (body == null ? o.body == null : body.equals(o.body))
        && (headers == null ? o.headers == null : headers.equals(o.headers));
  }

  @Override
  public String toString() {
    return getClass().getSimpleName() + "{status=" + status + ", body=" + body
        + ", headers=" + headers + "}";
  }

}