You are viewing a plain text version of this content. The canonical link for it is here.
Posted to soap-dev@ws.apache.org by Jeremiah Johnson <mr...@mail.com> on 2002/11/10 10:02:53 UTC
Parameter javadocs
While implementing some code that uses the xml-soap library, it
wasn't clear to me how the encodingStyleURI was involved. It was
very curious to me that most, if not all, of the samples leave a null
in the encodingStyleURI.
I updated the javadocs of Parameter based on what I found by looking
around. Could someone check the accuracy of my comments and possibly
add these docs to the source so the next guy like me doesn't have to
go through the same hunt?
The diff is below; I attached my copy of org.apache.soap.rpc.Parameter
- jeremiah
--- diff Parameter
$ cvs diff Parameter.java
Index: Parameter.java
===================================================================
RCS file: /home/cvspublic/xml-soap/java/src/org/apache/soap/rpc/Parameter.java,v
retrieving revision 1.3
diff -r1.3 Parameter.java
71a72,80
> * <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>
82a92,103
> /**
> * 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
> */
123a145,153
> /**
> * 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
> */
128a159,167
> /**
> * 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
> */
--
__________________________________________________________
Sign-up for your own FREE Personalized E-mail at Mail.com
http://www.mail.com/?sr=signup
Single & ready to mingle? lavalife.com: Where singles click. Free to Search!
http://www.lavalife.com/mailcom.epl?a=2116
Re: Parameter javadocs
Posted by Scott Nichol <sn...@scottnichol.com>.
Jeremiah,
Thanks. To add to what you have already found, I want to point out that
the encodingStyle for individual parameters is typically set to null so
that they will have the same encodingStyle that was set for the Call.
It is rare (but possible) to use a different encodingStyle for one or
more parameters than is used for the Call.
Scott Nichol
----- Original Message -----
From: "Jeremiah Johnson" <mr...@mail.com>
To: <so...@xml.apache.org>
Sent: Sunday, November 10, 2002 4:02 AM
Subject: Parameter javadocs
> While implementing some code that uses the xml-soap library, it
> wasn't clear to me how the encodingStyleURI was involved. It was
> very curious to me that most, if not all, of the samples leave a null
> in the encodingStyleURI.
>
> I updated the javadocs of Parameter based on what I found by looking
> around. Could someone check the accuracy of my comments and possibly
> add these docs to the source so the next guy like me doesn't have to
> go through the same hunt?
>
> The diff is below; I attached my copy of org.apache.soap.rpc.Parameter
>
> - jeremiah
>
> --- diff Parameter
> $ cvs diff Parameter.java
> Index: Parameter.java
> ===================================================================
> RCS file:
/home/cvspublic/xml-soap/java/src/org/apache/soap/rpc/Parameter.java,v
>
> retrieving revision 1.3
> diff -r1.3 Parameter.java
> 71a72,80
> > * <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>
> 82a92,103
> > /**
> > * 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
> > */
> 123a145,153
> > /**
> > * 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
> > */
> 128a159,167
> > /**
> > * 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
> > */
>
> --
> __________________________________________________________
> Sign-up for your own FREE Personalized E-mail at Mail.com
> http://www.mail.com/?sr=signup
>
> Single & ready to mingle? lavalife.com: Where singles click. Free to
Search!
> http://www.lavalife.com/mailcom.epl?a=2116
>
>
------------------------------------------------------------------------
--------
> --
> To unsubscribe, e-mail: <ma...@xml.apache.org>
> For additional commands, e-mail: <ma...@xml.apache.org>
--
To unsubscribe, e-mail: <ma...@xml.apache.org>
For additional commands, e-mail: <ma...@xml.apache.org>
Re: Parameter javadocs
Posted by Scott Nichol <sn...@scottnichol.com>.
Jeremiah,
Thanks. To add to what you have already found, I want to point out that
the encodingStyle for individual parameters is typically set to null so
that they will have the same encodingStyle that was set for the Call.
It is rare (but possible) to use a different encodingStyle for one or
more parameters than is used for the Call.
Scott Nichol
----- Original Message -----
From: "Jeremiah Johnson" <mr...@mail.com>
To: <so...@xml.apache.org>
Sent: Sunday, November 10, 2002 4:02 AM
Subject: Parameter javadocs
> While implementing some code that uses the xml-soap library, it
> wasn't clear to me how the encodingStyleURI was involved. It was
> very curious to me that most, if not all, of the samples leave a null
> in the encodingStyleURI.
>
> I updated the javadocs of Parameter based on what I found by looking
> around. Could someone check the accuracy of my comments and possibly
> add these docs to the source so the next guy like me doesn't have to
> go through the same hunt?
>
> The diff is below; I attached my copy of org.apache.soap.rpc.Parameter
>
> - jeremiah
>
> --- diff Parameter
> $ cvs diff Parameter.java
> Index: Parameter.java
> ===================================================================
> RCS file:
/home/cvspublic/xml-soap/java/src/org/apache/soap/rpc/Parameter.java,v
>
> retrieving revision 1.3
> diff -r1.3 Parameter.java
> 71a72,80
> > * <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>
> 82a92,103
> > /**
> > * 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
> > */
> 123a145,153
> > /**
> > * 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
> > */
> 128a159,167
> > /**
> > * 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
> > */
>
> --
> __________________________________________________________
> Sign-up for your own FREE Personalized E-mail at Mail.com
> http://www.mail.com/?sr=signup
>
> Single & ready to mingle? lavalife.com: Where singles click. Free to
Search!
> http://www.lavalife.com/mailcom.epl?a=2116
>
>
------------------------------------------------------------------------
--------
> --
> To unsubscribe, e-mail: <ma...@xml.apache.org>
> For additional commands, e-mail: <ma...@xml.apache.org>