CreateIdRequestBuilder.java

/*
   Copyright (c) 2014 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.template.RecordTemplate;
import com.linkedin.restli.common.ResourceSpec;
import com.linkedin.restli.common.TypeSpec;
import com.linkedin.restli.common.attachments.RestLiAttachmentDataSourceWriter;
import com.linkedin.restli.common.attachments.RestLiDataSourceIterator;
import com.linkedin.restli.internal.client.IdResponseDecoder;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;


/**
 * Builder for CreateIdRequest.
 * @author Moira Tagle
 */
public class CreateIdRequestBuilder<K, V extends RecordTemplate>
  extends SingleEntityRequestBuilder<K, V, CreateIdRequest<K, V>>
{
  private List<Object> _streamingAttachments; //We initialize only when we need to.

  protected CreateIdRequestBuilder(String baseURITemplate,
                                   Class<V> valueClass,
                                   ResourceSpec resourceSpec,
                                   RestliRequestOptions requestOptions)
  {
    super(baseURITemplate, valueClass, resourceSpec, requestOptions);
  }

  @Override
  public CreateIdRequestBuilder<K, V> input(V entity)
  {
    super.input(entity);
    return this;
  }

  public CreateIdRequestBuilder<K, V> appendSingleAttachment(final RestLiAttachmentDataSourceWriter streamingAttachment)
  {
    if (_streamingAttachments == null)
    {
      _streamingAttachments = new ArrayList<>();
    }

    _streamingAttachments.add(streamingAttachment);
    return this;
  }

  public CreateIdRequestBuilder<K, V> appendMultipleAttachments(final RestLiDataSourceIterator dataSourceIterator)
  {
    if (_streamingAttachments == null)
    {
      _streamingAttachments = new ArrayList<>();
    }

    _streamingAttachments.add(dataSourceIterator);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> setParam(String key, Object value)
  {
    super.setParam(key, value);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> setReqParam(String key, Object value)
  {
    super.setReqParam(key, value);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> addParam(String key, Object value)
  {
    super.addParam(key, value);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> addReqParam(String key, Object value)
  {
    super.addReqParam(key, value);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> setHeader(String key, String value)
  {
    super.setHeader(key, value);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> setHeaders(Map<String, String> headers)
  {
    super.setHeaders(headers);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> addHeader(String name, String value)
  {
    super.addHeader(name, value);
    return this;
  }

  @Override
  public CreateIdRequestBuilder<K, V> pathKey(String name, Object value)
  {
    super.pathKey(name, value);
    return this;
  }

  @Override
  public CreateIdRequest<K, V> build()
  {
    @SuppressWarnings("unchecked")
    IdResponseDecoder<K> idResponseDecoder = new IdResponseDecoder<K>((TypeSpec<K>)_resourceSpec.getKeyType(),
                                                                       _resourceSpec.getKeyParts(),
                                                                       _resourceSpec.getComplexKeyType());
    return new CreateIdRequest<K, V>(buildReadOnlyInput(),
                                     buildReadOnlyHeaders(),
                                     buildReadOnlyCookies(),
                                     idResponseDecoder,
                                     _resourceSpec,
                                     buildReadOnlyQueryParameters(),
                                     getQueryParamClasses(),
                                     getBaseUriTemplate(),
                                     buildReadOnlyPathKeys(),
                                     getRequestOptions(),
                                     _streamingAttachments == null ? null : Collections.unmodifiableList(_streamingAttachments));
  }
}