com.linkedin.restli.client.FindRequestBuilder Maven / Gradle / Ivy

Go to download
/*
   Copyright (c) 2012 LinkedIn Corp.

   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.linkedin.restli.client;


import com.linkedin.data.schema.PathSpec;
import com.linkedin.data.template.RecordTemplate;
import com.linkedin.restli.common.ResourceSpec;
import com.linkedin.restli.common.RestConstants;

import java.util.Map;


/**
 * REST collection finder request builder.
 *
 * @param  entity type for resource
 *
 * @author Eran Leshem
 */
public class FindRequestBuilder extends
    RestfulRequestBuilder>
{
  private final Class _elementClass;
  private String _name;

  public FindRequestBuilder(String baseUriTemplate,
                            Class elementClass,
                            ResourceSpec resourceSpec,
                            RestliRequestOptions requestOptions)
  {
    super(baseUriTemplate, resourceSpec, requestOptions);
    _elementClass = elementClass;
  }

  public FindRequestBuilder name(String name)
  {
    setParam(RestConstants.QUERY_TYPE_PARAM, name);
    _name = name;
    return this;
  }

  public FindRequestBuilder assocKey(String key, Object value)
  {
    addAssocKey(key, value);
    return this;
  }

  public FindRequestBuilder paginate(int start, int count)
  {
    paginateStart(start);
    paginateCount(count);
    return this;
  }

  public FindRequestBuilder paginateStart(int start)
  {
    setParam(RestConstants.START_PARAM, String.valueOf(start));
    return this;
  }

  public FindRequestBuilder paginateCount(int count)
  {
    setParam(RestConstants.COUNT_PARAM, String.valueOf(count));
    return this;
  }

  public FindRequestBuilder fields(PathSpec... fieldPaths)
  {
    addFields(fieldPaths);
    return this;
  }

  public FindRequestBuilder metadataFields(PathSpec... metadataFieldPaths)
  {
    addMetadataFields(metadataFieldPaths);
    return this;
  }

  public FindRequestBuilder pagingFields(PathSpec... pagingFieldPaths)
  {
    addPagingFields(pagingFieldPaths);
    return this;
  }

  @Override
  public FindRequestBuilder setParam(String key, Object value)
  {
    super.setParam(key, value);
    return this;
  }

  @Override
  public FindRequestBuilder setReqParam(String key, Object value)
  {
    super.setReqParam(key, value);
    return this;
  }

  @Override
  public FindRequestBuilder addParam(String key, Object value)
  {
    super.addParam(key, value);
    return this;
  }

  @Override
  public FindRequestBuilder addReqParam(String key, Object value)
  {
    super.addReqParam(key, value);
    return this;
  }

  @Override
  public FindRequestBuilder setHeader(String key, String value)
  {
    super.setHeader(key, value);
    return this;
  }

  @Override
  public FindRequestBuilder setHeaders(Map headers)
  {
    super.setHeaders(headers);
    return this;
  }

  @Override
  public FindRequestBuilder addHeader(String name, String value)
  {
    super.addHeader(name, value);
    return this;
  }

  @Override
  public FindRequestBuilder pathKey(String name, Object value)
  {
    super.pathKey(name, value);
    return this;
  }

  @Override
  public FindRequest build()
  {
    return new FindRequest(buildReadOnlyHeaders(),
                              buildReadOnlyCookies(),
                              _elementClass,
                              _resourceSpec,
                              buildReadOnlyQueryParameters(),
                              getQueryParamClasses(),
                              _name,
                              getBaseUriTemplate(),
                              buildReadOnlyPathKeys(),
                              getRequestOptions(),
                              buildReadOnlyAssocKey());
  }
}