wsdef/src/main/java/com/google/gson/webservice/definition/procedural/RequestBody.java

/*
 * Copyright (C) 2008 Google Inc.
 *
 * 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.google.gson.webservice.definition.procedural;

import com.google.gson.webservice.definition.ContentBody;
import com.google.gson.webservice.definition.ParamMap;
import com.google.gson.webservice.definition.TypedKey;
import com.google.gson.webservice.definition.ParamMap.Builder;

import java.lang.reflect.Type;
import java.util.Map;

/**
 * Definition of the request body of a {@link WebServiceCall}. The request body is what is sent out
 * in the output stream of the request (for example, with 
 * {@link java.net.HttpURLConnection#getOutputStream()}) , and is read by the 
 * javax.servlet.http.HttpServletRequest#getInputStream().
 * This class omits the default constructor for use by Gson. Instead the user must use
 * {@link com.google.gson.webservice.definition.procedural.RequestBodyGsonConverter}
 * 
 * @author inder
 */
public final class RequestBody extends ContentBody {

  public static class Builder extends ParamMap.Builder<RequestBodySpec> {    
    
    public Builder(RequestBodySpec spec) {
      super(spec);
    }
    
    @Override
    public Builder put(String paramName, Object content) {
      return (Builder) super.put(paramName, content);
    }

    @Override
    public Builder put(String paramName, Object content, Type typeOfContent) {
      return (Builder) super.put(paramName, content, typeOfContent);
    }

    @Override
    public <T> Builder put(TypedKey<T> paramKey, T param) {
      return (Builder) super.put(paramKey, param);
    }

    public RequestBody build() {
      return new RequestBody(spec, contents);
    }    
  }

  private RequestBody(RequestBodySpec spec, Map<String, Object> contents) {
    super(spec, contents);
  }
  
  @Override
  public RequestBodySpec getSpec() {
    return (RequestBodySpec) spec;
  }  
}