main.java.com.cloudant.client.api.views.PaginatedRequestBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudant-client Show documentation

Official Cloudant client for Java

There is a newer version: 2.20.1

/*
 * Copyright (c) 2015 IBM Corp. All rights reserved.
 *
 * Licensed 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.cloudant.client.api.views;

/**
 * Interface for building a paginated {@link ViewRequest}.
 * 
 * Example usage:
 * 
 *  * {@code
 *
 * ViewRequest paginatedRequest =
 * //get a builder for the "foo" view of the "example" design doc
 * db.getViewRequestBuilder("example","foo")
 *
 *      //create a new paginated request expecting String keys and values
 *      .newPaginatedRequest(Key.Type.STRING, String.class)
 *
 *      //set the number of rows for each page
 *      .rowsPerPage(12)
 *
 *      //set any other required parameters
 *      .startKey("bar")
 *
 *      //build the paginated request
 *      .build();
 * }
 * 
 *
 * @param  the type of key emitted by the view,fixed by the
 *            {@link com.cloudant.client.api.views.Key.Type}supplied to the
 *            {@link ViewRequestBuilder}
 * @param  the type of value emitted by the view,specified when supplied to the
 *            {@link ViewRequestBuilder}
 * @since 2.0.0
 */
public interface PaginatedRequestBuilder extends
        SingleRequestBuilder>,
        SettableViewParameters.Paginated>,
        SettableViewParameters.Reduceable> {
}