This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.soap
interface Name


Most common ways to construct:

SOAPEnvelope envelope = …;

Name name = envelope.createName("symbol");

Based on 32 examples

 

SOAPFactory soapFactory = …;

Name name = soapFactory.createName("stationId");

Based on 24 examples


public interface Name

A representation of an XML name. This interface provides methods for getting the local and namespace-qualified names and also for getting the prefix associated with the namespace for the name. It is also possible to get the URI of the namespace.

The following is an example of a namespace declaration in an element.

   <wombat:GetLastTradePrice xmlns:wombat="http://www.wombat.org/trader">
 
("xmlns" stands for "XML namespace".) The following shows what the methods in the Name interface will return.

XML namespaces are used to disambiguate SOAP identifiers from application-specific identifiers.

Name objects are created using the method SOAPEnvelope.createName, which has two versions. One method creates Name objects with a local name, a namespace prefix, and a namespace URI. and the second creates Name objects with just a local name. The following line of code, in which se is a SOAPEnvelope object, creates a new Name object with all three.

     Name name = se.createName("GetLastTradePrice", "WOMBAT",
                                "http://www.wombat.org/trader");
 
The following line of code gives an example of how a Name object can be used. The variable element is a SOAPElement object. This code creates a new SOAPElement object with the given name and adds it to element.
     element.addChildElement(name);
 

The Name interface may be deprecated in a future release of SAAJ in favor of javax.xml.namespace.QName


Method Summary
 String
          Gets the local name part of the XML name that this Name object represents.
 String
          Returns the prefix that was specified when this Name object was initialized.
 String
          Gets the namespace-qualified name of the XML name that this Name object represents.
 String
          Returns the URI of the namespace for the XML name that this Name object represents.
 

Method Detail

getLocalName

public String getLocalName()
Gets the local name part of the XML name that this Name object represents.

Returns:
a string giving the local name

getPrefix

public String getPrefix()
Returns the prefix that was specified when this Name object was initialized. This prefix is associated with the namespace for the XML name that this Name object represents.

Returns:
the prefix as a string

getQualifiedName

public String getQualifiedName()
Gets the namespace-qualified name of the XML name that this Name object represents.

Returns:
the namespace-qualified name as a string

getURI

public String getURI()
Returns the URI of the namespace for the XML name that this Name object represents.

Returns:
the URI as a string


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.