org.oxerr.viagogo.model.request.PagedRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gogokit-model Show documentation

There is a newer version: 6.5.1

package org.oxerr.viagogo.model.request;

import java.beans.Transient;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.stream.Collectors;

import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.oxerr.viagogo.model.Link;

public abstract class PagedRequest implements Serializable {

	public interface Sort {

		String getCode();

	}

	private static final long serialVersionUID = 2023112401L;

	/**
	 * Specifies which page of data to retrieve.
	 */
	private Integer page;

	/**
	 * Set custom page sizes on response.
	 */
	private Integer pageSize;

	/**
	 * Filters the response to only return items that have been updated since
	 * the given timestamp.
	 */
	private Instant updatedSince;

	/**
	 * Determines the ordering of items.
	 * A comma-separated string.
	 */
	private String sort;

	protected PagedRequest() {
	}

	protected PagedRequest(Link link) {
		this.setPage(link.getFirstAsInteger("page"));
		this.setPageSize(link.getFirstAsInteger("page_size"));
		this.setUpdatedSince(link.getFirstAsInstant("updated_since"));
		this.setSort(link.getFirstAsString("sort"));
	}

	public Integer getPage() {
		return page;
	}

	public void setPage(Integer page) {
		this.page = page;
	}

	public Integer getPageSize() {
		return pageSize;
	}

	public void setPageSize(Integer pageSize) {
		this.pageSize = pageSize;
	}

	public Instant getUpdatedSince() {
		return updatedSince;
	}

	public void setUpdatedSince(Instant updatedSince) {
		this.updatedSince = updatedSince;
	}

	public String getSort() {
		return sort;
	}

	public void setSort(String sort) {
		this.sort = sort;
	}

	@Transient
	public void setSort(Sort... sorts) {
		this.setSort(Arrays.stream(sorts).map(Sort::getCode).collect(Collectors.joining(",")));
	}

	@Override
	public int hashCode() {
		return HashCodeBuilder.reflectionHashCode(this);
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		if (!(obj instanceof PagedRequest)) {
			return false;
		}
		PagedRequest rhs = (PagedRequest) obj;
		return EqualsBuilder.reflectionEquals(this, rhs);
	}

}