javax.xml.soap.Name Maven / Gradle / Ivy
/*
* $Id: Name.java,v 1.5 2006/03/30 00:59:39 ofung Exp $
* $Revision: 1.5 $
* $Date: 2006/03/30 00:59:39 $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package javax.xml.soap;
/**
* 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.
*
* getQualifiedName will return "prefix:LocalName" =
* "WOMBAT:GetLastTradePrice"
* getURI will return "http://www.wombat.org/trader"
* getLocalName will return "GetLastTracePrice"
* getPrefix will return "WOMBAT"
*
*
* 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
* @see SOAPEnvelope#createName(String, String, String) SOAPEnvelope.createName
* @see SOAPFactory#createName(String, String, String) SOAPFactory.createName
*/
public interface Name {
/**
* Gets the local name part of the XML name that this Name
* object represents.
*
* @return a string giving the local name
*/
String getLocalName();
/**
* Gets the namespace-qualified name of the XML name that this
* Name object represents.
*
* @return the namespace-qualified name as a string
*/
String getQualifiedName();
/**
* 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.
*
* @return the prefix as a string
*/
String getPrefix();
/**
* Returns the URI of the namespace for the XML
* name that this Name object represents.
*
* @return the URI as a string
*/
String getURI();
}