com.gooddata.sdk.common.collections.CustomPageRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2004-2019, GoodData(R) Corporation. All rights reserved.
 * This source code is licensed under the BSD-style license found in the
 * LICENSE.txt file in the root directory of this source tree.
 */
package com.gooddata.sdk.common.collections;

import com.gooddata.sdk.common.util.GoodDataToStringBuilder;
import com.gooddata.sdk.common.util.MutableUri;
import org.springframework.web.util.UriComponentsBuilder;

import java.net.URI;

import static com.gooddata.sdk.common.util.Validate.notNull;

/**
 * User defined page request with desired offset and limit.
 */
public class CustomPageRequest implements PageRequest {

    public static final Integer DEFAULT_LIMIT = 100;

    private String offset;
    private int limit;

    /**
     * Creates new page request with default values.
     */
    public CustomPageRequest() {
        this(null, DEFAULT_LIMIT);
    }

    /**
     * Creates new page request with provided values.
     *
     * @param offset page offset (position in the collection)
     * @param limit  maximal number of returned elements (on a page)
     */
    public CustomPageRequest(final int offset, final int limit) {
        this(String.valueOf(offset), limit);
    }

    /**
     * Creates new page request with provided values.
     *
     * @param offset page offset (position in the collection)
     * @param limit  maximal number of returned elements (on a page)
     */
    public CustomPageRequest(final String offset, final int limit) {
        this.offset = offset;
        this.limit = limit;
    }

    /**
     * Creates new page request with limit and no offset (usually for the first page).
     *
     * @param limit maximal number of returned elements (on a page)
     */
    public CustomPageRequest(final int limit) {
        this(null, limit);
    }

    public String getOffset() {
        return offset;
    }

    public void setOffset(final String offset) {
        this.offset = offset;
    }

    public int getLimit() {
        return limit;
    }

    /**
     * Returns the limit value or the {@link #DEFAULT_LIMIT} if the limit is lower than or equal to zero.
     *
     * @return sanitized limit
     */
    public int getSanitizedLimit() {
        return limit > 0 ? limit : DEFAULT_LIMIT;
    }

    /**
     * Returns the {@link #getSanitizedLimit()} if lower than the given maximum or the maximum value.
     *
     * @param max maximum value
     * @return sanitized limit
     */
    public int getSanitizedLimit(final int max) {
        final int limit = getSanitizedLimit();
        return limit < max ? limit : max;
    }

    public void setLimit(final int limit) {
        this.limit = limit;
    }

    @Override
    public URI getPageUri(final MutableUri mutableUri) {
        notNull(mutableUri, "mutableUri");
        return updateWithPageParams(mutableUri.copy()).toUri();
    }

    @Override
    public MutableUri updateWithPageParams(final MutableUri mutableUri) {
        if (offset != null) {
            mutableUri.replaceQueryParam("offset", offset);
        }
        mutableUri.replaceQueryParam("limit", limit);
        return mutableUri;
    }

    @Override
    public String toString() {
        return GoodDataToStringBuilder.defaultToString(this);
    }

    protected boolean canEqual(final Object o) {
        return o instanceof CustomPageRequest;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) return true;
        if (!(o instanceof CustomPageRequest)) return false;

        final CustomPageRequest that = (CustomPageRequest) o;
        if (!(that.canEqual(this))) return false;

        if (limit != that.limit) return false;
        return offset != null ? offset.equals(that.offset) : that.offset == null;
    }

    @Override
    public int hashCode() {
        int result = offset != null ? offset.hashCode() : 0;
        result = 31 * result + limit;
        return result;
    }
}