001/**
002 * Copyright (c) 2010-2019 Mark Allen, Norbert Bartels.
003 *
004 * Permission is hereby granted, free of charge, to any person obtaining a copy
005 * of this software and associated documentation files (the "Software"), to deal
006 * in the Software without restriction, including without limitation the rights
007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008 * copies of the Software, and to permit persons to whom the Software is
009 * furnished to do so, subject to the following conditions:
010 *
011 * The above copyright notice and this permission notice shall be included in
012 * all copies or substantial portions of the Software.
013 *
014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
020 * THE SOFTWARE.
021 */
022package com.restfb.batch;
023
024import static java.util.Collections.unmodifiableList;
025
026import com.restfb.Facebook;
027import com.restfb.util.ReflectionUtils;
028
029import java.util.ArrayList;
030import java.util.List;
031
032/**
033 * Encapsulates a discrete part of an entire
034 * <a href="https://developers.facebook.com/docs/reference/api/batch/" target="_blank">Facebook Batch API</a> response.
035 * 
036 * @author <a href="http://restfb.com">Mark Allen</a>
037 * @since 1.6.5
038 */
039public class BatchResponse {
040  @Facebook
041  private Integer code;
042
043  @Facebook
044  private String body;
045
046  @Facebook
047  private List<BatchHeader> headers = new ArrayList<>();
048
049  /**
050   * "Magic" no-argument constructor so we can reflectively make instances of this class with DefaultJsonMapper, but
051   * normal client code cannot.
052   */
053  protected BatchResponse() {}
054
055  /**
056   * Creates a batch response with the given HTTP response status code, headers, and JSON body.
057   * 
058   * @param code
059   *          HTTP status code.
060   * @param headers
061   *          HTTP headers.
062   * @param body
063   *          JSON body.
064   */
065  public BatchResponse(Integer code, List<BatchHeader> headers, String body) {
066    this.code = code;
067    this.body = body;
068
069    if (headers != null) {
070      this.headers.addAll(headers);
071    }
072  }
073
074  @Override
075  public int hashCode() {
076    return ReflectionUtils.hashCode(this);
077  }
078
079  @Override
080  public boolean equals(Object that) {
081    return ReflectionUtils.equals(this, that);
082  }
083
084  @Override
085  public String toString() {
086    return ReflectionUtils.toString(this);
087  }
088
089  /**
090   * The HTTP status code for this response.
091   * 
092   * @return The HTTP status code for this response.
093   */
094  public Integer getCode() {
095    return code;
096  }
097
098  /**
099   * The HTTP response body JSON.
100   * 
101   * @return The HTTP response body JSON.
102   */
103  public String getBody() {
104    return body;
105  }
106
107  /**
108   * The HTTP response headers.
109   * 
110   * @return The HTTP response headers.
111   */
112  public List<BatchHeader> getHeaders() {
113    return unmodifiableList(headers);
114  }
115}