• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/jaxws_classes/javax/xml/soap/Name.java@7166269ef0f1 (annotated)

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

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 1921

7166269ef0f1

parent 637

9c07ef4934dd

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset fdbe50121f48

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2004, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package javax.xml.soap;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* A representation of an XML name. This interface provides methods for
aoqi@0	30	* getting the local and namespace-qualified names and also for getting the
aoqi@0	31	* prefix associated with the namespace for the name. It is also possible
aoqi@0	32	* to get the URI of the namespace.
aoqi@0	33	* <P>
aoqi@0	34	* The following is an example of a namespace declaration in an element.
aoqi@0	35	* <PRE>
aoqi@0	36	* &lt;wombat:GetLastTradePrice xmlns:wombat="http://www.wombat.org/trader"&gt;
aoqi@0	37	* </PRE>
aoqi@0	38	* ("xmlns" stands for "XML namespace".)
aoqi@0	39	* The following
aoqi@0	40	* shows what the methods in the <code>Name</code> interface will return.
aoqi@0	41	* <UL>
aoqi@0	42	* <LI><code>getQualifiedName</code> will return "prefix:LocalName" =
aoqi@0	43	* "WOMBAT:GetLastTradePrice"
aoqi@0	44	* <LI><code>getURI</code> will return "http://www.wombat.org/trader"
aoqi@0	45	* <LI><code>getLocalName</code> will return "GetLastTracePrice"
aoqi@0	46	* <LI><code>getPrefix</code> will return "WOMBAT"
aoqi@0	47	* </UL>
aoqi@0	48	* <P>
aoqi@0	49	* XML namespaces are used to disambiguate SOAP identifiers from
aoqi@0	50	* application-specific identifiers.
aoqi@0	51	* <P>
aoqi@0	52	* <code>Name</code> objects are created using the method
aoqi@0	53	* <code>SOAPEnvelope.createName</code>, which has two versions.
aoqi@0	54	* One method creates <code>Name</code> objects with
aoqi@0	55	* a local name, a namespace prefix, and a namespace URI.
aoqi@0	56	* and the second creates <code>Name</code> objects with just a local name.
aoqi@0	57	* The following line of
aoqi@0	58	* code, in which <i>se</i> is a <code>SOAPEnvelope</code> object, creates a new
aoqi@0	59	* <code>Name</code> object with all three.
aoqi@0	60	* <PRE>
aoqi@0	61	* Name name = se.createName("GetLastTradePrice", "WOMBAT",
aoqi@0	62	* "http://www.wombat.org/trader");
aoqi@0	63	* </PRE>
aoqi@0	64	* The following line of code gives an example of how a <code>Name</code> object
aoqi@0	65	* can be used. The variable <i>element</i> is a <code>SOAPElement</code> object.
aoqi@0	66	* This code creates a new <code>SOAPElement</code> object with the given name and
aoqi@0	67	* adds it to <i>element</i>.
aoqi@0	68	* <PRE>
aoqi@0	69	* element.addChildElement(name);
aoqi@0	70	* </PRE>
aoqi@0	71	* <P>
aoqi@0	72	* The <code>Name</code> interface may be deprecated in a future release of SAAJ
aoqi@0	73	* in favor of <code>javax.xml.namespace.QName<code>
aoqi@0	74	* @see SOAPEnvelope#createName(String, String, String) SOAPEnvelope.createName
aoqi@0	75	* @see SOAPFactory#createName(String, String, String) SOAPFactory.createName
aoqi@0	76	*/
aoqi@0	77	public interface Name {
aoqi@0	78	/**
aoqi@0	79	* Gets the local name part of the XML name that this <code>Name</code>
aoqi@0	80	* object represents.
aoqi@0	81	*
aoqi@0	82	* @return a string giving the local name
aoqi@0	83	*/
aoqi@0	84	String getLocalName();
aoqi@0	85
aoqi@0	86	/**
aoqi@0	87	* Gets the namespace-qualified name of the XML name that this
aoqi@0	88	* <code>Name</code> object represents.
aoqi@0	89	*
aoqi@0	90	* @return the namespace-qualified name as a string
aoqi@0	91	*/
aoqi@0	92	String getQualifiedName();
aoqi@0	93
aoqi@0	94	/**
aoqi@0	95	* Returns the prefix that was specified when this <code>Name</code> object
aoqi@0	96	* was initialized. This prefix is associated with the namespace for the XML
aoqi@0	97	* name that this <code>Name</code> object represents.
aoqi@0	98	*
aoqi@0	99	* @return the prefix as a string
aoqi@0	100	*/
aoqi@0	101	String getPrefix();
aoqi@0	102
aoqi@0	103	/**
aoqi@0	104	* Returns the URI of the namespace for the XML
aoqi@0	105	* name that this <code>Name</code> object represents.
aoqi@0	106	*
aoqi@0	107	* @return the URI as a string
aoqi@0	108	*/
aoqi@0	109	String getURI();
aoqi@0	110	}