src/share/jaxws_classes/javax/xml/soap/Name.java

Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:


  56  *  and the second creates <code>Name</code> objects with just a local name.
  57  * The following line of
  58  * code, in which <i>se</i> is a <code>SOAPEnvelope</code> object, creates a new
  59  * <code>Name</code> object with all three.
  60  * <PRE>
  61  *     Name name = se.createName("GetLastTradePrice", "WOMBAT",
  62  *                                "http://www.wombat.org/trader");
  63  * </PRE>
  64  * The following line of code gives an example of how a <code>Name</code> object
  65  * can be used. The variable <i>element</i> is a <code>SOAPElement</code> object.
  66  * This code creates a new <code>SOAPElement</code> object with the given name and
  67  * adds it to <i>element</i>.
  68  * <PRE>
  69  *     element.addChildElement(name);
  70  * </PRE>
  71  * <P>
  72  * The <code>Name</code> interface may be deprecated in a future release of SAAJ
  73  * in favor of <code>javax.xml.namespace.QName<code>
  74  * @see SOAPEnvelope#createName(String, String, String) SOAPEnvelope.createName
  75  * @see SOAPFactory#createName(String, String, String) SOAPFactory.createName

  76  */
  77 public interface Name {
  78     /**
  79      * Gets the local name part of the XML name that this <code>Name</code>
  80      * object represents.
  81      *
  82      * @return a string giving the local name
  83      */
  84     String getLocalName();
  85 
  86     /**
  87      * Gets the namespace-qualified name of the XML name that this
  88      * <code>Name</code> object represents.
  89      *
  90      * @return the namespace-qualified name as a string
  91      */
  92     String getQualifiedName();
  93 
  94     /**
  95      * Returns the prefix that was specified when this <code>Name</code> object


  56  *  and the second creates <code>Name</code> objects with just a local name.
  57  * The following line of
  58  * code, in which <i>se</i> is a <code>SOAPEnvelope</code> object, creates a new
  59  * <code>Name</code> object with all three.
  60  * <PRE>
  61  *     Name name = se.createName("GetLastTradePrice", "WOMBAT",
  62  *                                "http://www.wombat.org/trader");
  63  * </PRE>
  64  * The following line of code gives an example of how a <code>Name</code> object
  65  * can be used. The variable <i>element</i> is a <code>SOAPElement</code> object.
  66  * This code creates a new <code>SOAPElement</code> object with the given name and
  67  * adds it to <i>element</i>.
  68  * <PRE>
  69  *     element.addChildElement(name);
  70  * </PRE>
  71  * <P>
  72  * The <code>Name</code> interface may be deprecated in a future release of SAAJ
  73  * in favor of <code>javax.xml.namespace.QName<code>
  74  * @see SOAPEnvelope#createName(String, String, String) SOAPEnvelope.createName
  75  * @see SOAPFactory#createName(String, String, String) SOAPFactory.createName
  76  * @since 1.6
  77  */
  78 public interface Name {
  79     /**
  80      * Gets the local name part of the XML name that this <code>Name</code>
  81      * object represents.
  82      *
  83      * @return a string giving the local name
  84      */
  85     String getLocalName();
  86 
  87     /**
  88      * Gets the namespace-qualified name of the XML name that this
  89      * <code>Name</code> object represents.
  90      *
  91      * @return the namespace-qualified name as a string
  92      */
  93     String getQualifiedName();
  94 
  95     /**
  96      * Returns the prefix that was specified when this <code>Name</code> object