/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2000 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:  
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "SOAP" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written 
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation and was
 * originally based on software copyright (c) 2000, International
 * Business Machines, Inc., http://www.apache.org.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.soap.rpc;

import java.io.*;
import java.util.*;
import org.w3c.dom.*;
import org.apache.soap.util.*;
import org.apache.soap.util.xml.*;
import org.apache.soap.*;
import org.apache.soap.encoding.*;

/**
 * A <code>Parameter</code> represents an argument to an <em>RPC</em>
 * call. <code>Parameter</code> objects are used by both the client
 * and the server.
 * <p>
 * Here is an example of creating a string parameter called <em>name</em>
 * with a value of <em>Matthew Duftler</em> using the SOAP encoding:
 * <br />
 * <code>
 * new Parameter( "name", String.class, "Matthew Duftler", null )
 * </code>
 * <br />
 * </p>
 *
 * @author Matthew J. Duftler (duftler@us.ibm.com)
 * @author Sanjiva Weerawarana (sanjiva@watson.ibm.com)
 */
public class Parameter
{
  private String name             = null;
  private Class  type             = null;
  private Object value            = null;
  private String encodingStyleURI = null;

  /**
   * Create an instance of a call parameter.
   * <p>
   * Note that if the <em>encodingStyleURI</em> is null, then the SOAP-ENC
   * style will be used.
   * </p>
   *
   * @param name the name of the parameter
   * @param type the Java type of the parameter
   * @param value the value to use for this parameter
   * @param encodingStyleURI the URI of the encoding style for this parameter
   */
  public Parameter(String name,
                   Class  type,
                   Object value,
                   String encodingStyleURI)
  {
    this.name = name;
    this.type = type;
    this.value = value;
    this.encodingStyleURI = encodingStyleURI;
  }

  public void setName(String name)
  {
    this.name = name;
  }

  public String getName()
  {
    return name;
  }

  public void setType(Class type)
  {
    this.type = type;
  }

  public Class getType()
  {
    return type;
  }

  public void setValue(Object value)
  {
    this.value = value;
  }

  public Object getValue()
  {
    return value;
  }

  /**
   * Set the URI of the encoding style for this parameter.
   * <p>
   * Note that if the <em>encodingStyleURI</em> is null, then the SOAP-ENC
   * style will be used.
   * </p>
   *
   * @param encodingStyleURI the URI of the encoding style for this parameter
   */
  public void setEncodingStyleURI(String encodingStyleURI)
  {
    this.encodingStyleURI = encodingStyleURI;
  }

  /**
   * Get the URI of the encoding style for this parameter.
   * <p>
   * If this returns null, then assume SOAP-ENC was used, or will be used,
   * for this parameters.
   * </p>
   *
   * @return the URI of the encoding style for this parameter
   */
  public String getEncodingStyleURI()
  {
    return encodingStyleURI;
  }

  public String toString()
  {
    return "[name=" + name + "] " +
           "[type=" + type + "] " +
           "[value=" + value + "] " +
           "[encodingStyleURI=" + encodingStyleURI + "]";
  }
}