com.blackducksoftware.integration.hub.request.HubPagedRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hub-common-rest Show documentation

null

There is a newer version: 12.0.4

/**
 * Hub Common Rest
 *
 * Copyright (C) 2017 Black Duck Software, Inc.
 * http://www.blackducksoftware.com/
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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.blackducksoftware.integration.hub.request;

import static com.blackducksoftware.integration.hub.RestConstants.QUERY_LIMIT;
import static com.blackducksoftware.integration.hub.RestConstants.QUERY_OFFSET;

import java.util.Map;

import com.blackducksoftware.integration.hub.rest.RestConnection;

/**
 * This should be used to communicate to the Hub REST endpoints that can return many items across pages of data. These
 * are the endpoints that have the limit and offset query parameters.
 */
public class HubPagedRequest extends HubRequest {
    public int limit = 10;

    public int offset = 0;

    public HubPagedRequest(final RestConnection restConnection) {
        super(restConnection);
    }

    @Override
    protected void populateQueryParameters() {
        super.populateQueryParameters();

        // if limit is not provided, the default is 10
        if (limit <= 0) {
            limit = 10;
        }
        addQueryParameter(QUERY_LIMIT, String.valueOf(limit));

        // if offset is not provided, the default is 0
        addQueryParameter(QUERY_OFFSET, String.valueOf(offset));
    }

    @Override
    public HubPagedRequest addQueryParameter(final String queryParameterName, final String queryParameterValue) {
        super.addQueryParameter(queryParameterName, queryParameterValue);
        return this;
    }

    @Override
    public HubPagedRequest addQueryParameters(final Map queryParameters) {
        super.addQueryParameters(queryParameters);
        return this;
    }

}