src/share/jaxws_classes/javax/xml/soap/SOAPElement.java
Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:
*** 38,47 ****
--- 38,49 ----
* Methods in this interface that are required to return SAAJ specific objects
* may "silently" replace nodes in the tree as required to successfully return
* objects of the correct type. See {@link #getChildElements()} and
* {@link <a HREF="package-summary.html#package_description">javax.xml.soap<a>}
* for details.
+ *
+ * @since 1.6
*/
public interface SOAPElement extends Node, org.w3c.dom.Element {
/**
* Creates a new <code>SOAPElement</code> object initialized with the
*** 72,82 ****
*
* @return the new <code>SOAPElement</code> object that was created
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
* @see SOAPElement#addChildElement(Name)
! * @since SAAJ 1.3
*/
public SOAPElement addChildElement(QName qname) throws SOAPException;
/**
* Creates a new <code>SOAPElement</code> object initialized with the
--- 74,84 ----
*
* @return the new <code>SOAPElement</code> object that was created
* @exception SOAPException if there is an error in creating the
* <code>SOAPElement</code> object
* @see SOAPElement#addChildElement(Name)
! * @since 1.6, SAAJ 1.3
*/
public SOAPElement addChildElement(QName qname) throws SOAPException;
/**
* Creates a new <code>SOAPElement</code> object initialized with the
*** 171,181 ****
* completed <code>SOAPHeaders</code> and <code>SOAPBodys</code> in
* preparation for sending a fault when an error condition is detected. It
* is also useful for recycling portions of a document within a SOAP
* message.
*
! * @since SAAJ 1.2
*/
public abstract void removeContents();
/**
* Creates a new <code>Text</code> object initialized with the given
--- 173,183 ----
* completed <code>SOAPHeaders</code> and <code>SOAPBodys</code> in
* preparation for sending a fault when an error condition is detected. It
* is also useful for recycling portions of a document within a SOAP
* message.
*
! * @since 1.6, SAAJ 1.2
*/
public abstract void removeContents();
/**
* Creates a new <code>Text</code> object initialized with the given
*** 222,232 ****
* @exception SOAPException if there is an error in creating the
* Attribute, or it is invalid to set
an attribute with <code>QName</code>
<code>qname</code> on this SOAPElement.
* @see SOAPElement#addAttribute(Name, String)
! * @since SAAJ 1.3
*/
public SOAPElement addAttribute(QName qname, String value)
throws SOAPException;
/**
--- 224,234 ----
* @exception SOAPException if there is an error in creating the
* Attribute, or it is invalid to set
an attribute with <code>QName</code>
<code>qname</code> on this SOAPElement.
* @see SOAPElement#addAttribute(Name, String)
! * @since 1.6, SAAJ 1.3
*/
public SOAPElement addAttribute(QName qname, String value)
throws SOAPException;
/**
*** 259,269 ****
*
* @param qname a <code>QName</code> object with the qname of the attribute
* @return a <code>String</code> giving the value of the specified
* attribute, Null if there is no such attribute
* @see SOAPElement#getAttributeValue(Name)
! * @since SAAJ 1.3
*/
public String getAttributeValue(QName qname);
/**
* Returns an <code>Iterator</code> over all of the attribute
--- 261,271 ----
*
* @param qname a <code>QName</code> object with the qname of the attribute
* @return a <code>String</code> giving the value of the specified
* attribute, Null if there is no such attribute
* @see SOAPElement#getAttributeValue(Name)
! * @since 1.6, SAAJ 1.3
*/
public String getAttributeValue(QName qname);
/**
* Returns an <code>Iterator</code> over all of the attribute
*** 285,295 ****
* be passed to the method <code>getAttributeValue</code> to retrieve
* the value of each attribute.
*
* @return an iterator over the QNames of the attributes
* @see SOAPElement#getAllAttributes()
! * @since SAAJ 1.3
*/
public Iterator getAllAttributesAsQNames();
/**
--- 287,297 ----
* be passed to the method <code>getAttributeValue</code> to retrieve
* the value of each attribute.
*
* @return an iterator over the QNames of the attributes
* @see SOAPElement#getAllAttributes()
! * @since 1.6, SAAJ 1.3
*/
public Iterator getAllAttributesAsQNames();
/**
*** 320,330 ****
* <code>getNamespaceURI</code> to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes are within scope of this
* <code>SOAPElement</code> object
*
! * @since SAAJ 1.2
*/
public Iterator getVisibleNamespacePrefixes();
/**
* Creates a <code>QName</code> whose namespace URI is the one associated
--- 322,332 ----
* <code>getNamespaceURI</code> to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes are within scope of this
* <code>SOAPElement</code> object
*
! * @since 1.6, SAAJ 1.2
*/
public Iterator getVisibleNamespacePrefixes();
/**
* Creates a <code>QName</code> whose namespace URI is the one associated
*** 346,356 ****
* <code>{@link #getNamespaceURI(String)}</code> if it were given
* <code>prefix</code> as it's parameter.
*
* @exception SOAPException if the <code>QName</code> cannot be created.
*
! * @since SAAJ 1.3
*/
public QName createQName(String localName, String prefix)
throws SOAPException;
/**
* Returns the name of this <code>SOAPElement</code> object.
--- 348,358 ----
* <code>{@link #getNamespaceURI(String)}</code> if it were given
* <code>prefix</code> as it's parameter.
*
* @exception SOAPException if the <code>QName</code> cannot be created.
*
! * @since 1.6, SAAJ 1.3
*/
public QName createQName(String localName, String prefix)
throws SOAPException;
/**
* Returns the name of this <code>SOAPElement</code> object.
*** 364,374 ****
* Returns the qname of this <code>SOAPElement</code> object.
*
* @return a <code>QName</code> object with the qname of this
* <code>SOAPElement</code> object
* @see SOAPElement#getElementName()
! * @since SAAJ 1.3
*/
public QName getElementQName();
/**
* Changes the name of this <code>Element</code> to <code>newName</code> if
--- 366,376 ----
* Returns the qname of this <code>SOAPElement</code> object.
*
* @return a <code>QName</code> object with the qname of this
* <code>SOAPElement</code> object
* @see SOAPElement#getElementName()
! * @since 1.6, SAAJ 1.3
*/
public QName getElementQName();
/**
* Changes the name of this <code>Element</code> to <code>newName</code> if
*** 384,394 ****
*
* @exception SOAPException if changing the name of this <code>Element</code>
* is not allowed.
* @return The renamed Node
*
! * @since SAAJ 1.3
*/
public SOAPElement setElementQName(QName newName) throws SOAPException;
/**
* Removes the attribute with the specified name.
--- 386,396 ----
*
* @exception SOAPException if changing the name of this <code>Element</code>
* is not allowed.
* @return The renamed Node
*
! * @since 1.6, SAAJ 1.3
*/
public SOAPElement setElementQName(QName newName) throws SOAPException;
/**
* Removes the attribute with the specified name.
*** 407,417 ****
* @param qname the <code>QName</code> object with the qname of the
* attribute to be removed
* @return <code>true</code> if the attribute was
* removed successfully; <code>false</code> if it was not
* @see SOAPElement#removeAttribute(Name)
! * @since SAAJ 1.3
*/
public boolean removeAttribute(QName qname);
/**
* Removes the namespace declaration corresponding to the given prefix.
--- 409,419 ----
* @param qname the <code>QName</code> object with the qname of the
* attribute to be removed
* @return <code>true</code> if the attribute was
* removed successfully; <code>false</code> if it was not
* @see SOAPElement#removeAttribute(Name)
! * @since 1.6, SAAJ 1.3
*/
public boolean removeAttribute(QName qname);
/**
* Removes the namespace declaration corresponding to the given prefix.
*** 494,504 ****
*
* @return an <code>Iterator</code> object over all the elements
* in this <code>SOAPElement</code> object with the
* specified qname
* @see SOAPElement#getChildElements(Name)
! * @since SAAJ 1.3
*/
public Iterator getChildElements(QName qname);
/**
* Sets the encoding style for this <code>SOAPElement</code> object
--- 496,506 ----
*
* @return an <code>Iterator</code> object over all the elements
* in this <code>SOAPElement</code> object with the
* specified qname
* @see SOAPElement#getChildElements(Name)
! * @since 1.6, SAAJ 1.3
*/
public Iterator getChildElements(QName qname);
/**
* Sets the encoding style for this <code>SOAPElement</code> object