de.digitalcollections.model.list.ListResponse Maven / Gradle / Ivy

Go to download
package de.digitalcollections.model.list;

import de.digitalcollections.model.list.sorting.Sorting;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;

/**
 * Container for list information.
 *
 * @param  object type of list items
 */
public class ListResponse implements Iterable {

  protected List content;
  protected String executedSearchTerm;
  protected R request;
  protected long total;

  public ListResponse() {
    init();
  }

  /**
   * Constructor with the given content and the given governing {@link ListRequest}.
   *
   * @param content the content of this list, must not be {@literal null}.
   * @param request the request information, can be {@literal null}.
   */
  public ListResponse(List content, R request) {
    this();

    assert content != null : "content must not be null!";
    this.content.addAll(content);
    this.request = request;
    this.total = content.size();
  }

  /**
   * Constructor with the given content and the given governing {@link ListRequest}.
   *
   * @param content the content of this list, must not be {@literal null}.
   * @param request the request information, can be {@literal null}.
   * @param executedSearchTerm finally executed search term based on given search term (e.g. after
   *     escaping special characters etc.)
   */
  public ListResponse(List content, R request, String executedSearchTerm) {
    this(content, request);
    this.executedSearchTerm = executedSearchTerm;
  }

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

    ListResponse that = (ListResponse) obj;
    return (this.total == that.total)
        && Objects.equals(content, that.content)
        && Objects.equals(executedSearchTerm, that.executedSearchTerm)
        && Objects.equals(request, that.request);
  }

  /**
   * @return the content as {@link List}.
   */
  public List getContent() {
    return Collections.unmodifiableList(content);
  }

  public String getExecutedSearchTerm() {
    if (executedSearchTerm == null) {
      // no changes on original searchTerm
      return request != null ? request.getSearchTerm() : null;
    }
    return executedSearchTerm;
  }

  /**
   * @return the request used to get this response
   */
  public R getRequest() {
    return request;
  }

  /**
   * @return the sorting parameters for the {@link ListResponse}.
   */
  public Sorting getSorting() {
    return request == null ? null : request.getSorting();
  }

  /**
   * Returns the total amount of elements.
   *
   * @return the total amount of elements
   */
  public long getTotalElements() {
    return total;
  }

  /**
   * @return whether the {@link ListResponse} has content at all.
   */
  public boolean hasContent() {
    return !content.isEmpty();
  }

  @Override
  public int hashCode() {

    int result = 17;

    result += 31 * (int) (total ^ total >>> 32);
    result += 31 * (request == null ? 0 : request.hashCode());
    result += 31 * content.hashCode();
    result += 31 * (executedSearchTerm == null ? 0 : executedSearchTerm.hashCode());

    return result;
  }

  protected void init() {
    if (content == null) {
      this.content = new ArrayList<>(0);
    }
  }

  @Override
  public Iterator iterator() {
    return content.iterator();
  }

  /**
   * Allows to set the content (needed in case of content has to be converted/casted)
   *
   * @param content list of content/objects
   */
  public void setContent(List content) {
    this.content = content;
  }

  public void setExecutedSearchTerm(String executedSearchTerm) {
    this.executedSearchTerm = executedSearchTerm;
  }

  public void setRequest(R request) {
    this.request = request;
  }

  public void setTotalElements(long totalElements) {
    this.total = totalElements;
  }

  @Override
  public String toString() {

    String contentType = "UNKNOWN";
    List unmodifiableContent = getContent();

    if (!unmodifiableContent.isEmpty()) {
      contentType = unmodifiableContent.get(0).getClass().getName();
    }

    return String.format(
        "List of %s containing %d instances", contentType, unmodifiableContent.size());
  }
}