Author: sanjiva
Date: Tue Jul 26 01:54:27 2005
New Revision: 225262
URL: http://svn.apache.org/viewcvs?rev=225262&view=rev
Log:
improved comment
Modified:
webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPHeader.java
Modified:
webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPHeader.java
URL:
http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPHeader.java?rev=225262&r1=225261&r2=225262&view=diff
==============================================================================
---
webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPHeader.java
(original)
+++
webservices/axis/trunk/java/modules/xml/src/org/apache/axis2/soap/SOAPHeader.java
Tue Jul 26 01:54:27 2005
@@ -15,69 +15,67 @@
*/
package org.apache.axis2.soap;
+import java.util.ArrayList;
+import java.util.Iterator;
+
import org.apache.axis2.om.OMElement;
import org.apache.axis2.om.OMException;
import org.apache.axis2.om.OMNamespace;
-import java.util.ArrayList;
-import java.util.Iterator;
-
/**
* Interface SOAPHeader
*/
public interface SOAPHeader extends OMElement {
/**
- * Creates a new <CODE>SOAPHeaderBlock</CODE> object
- * initialized with the specified name and adds it to this
- * <CODE>SOAPHeader</CODE> object.
- *
+ * Creates a new <CODE>SOAPHeaderBlock</CODE> object initialized with the
+ * specified name and adds it to this <CODE>SOAPHeader</CODE> object.
+ *
* @param localName
* @param ns
- * @return the new <CODE>SOAPHeaderBlock</CODE> object that
- * was inserted into this <CODE>SOAPHeader</CODE>
- * object
+ * @return the new <CODE>SOAPHeaderBlock</CODE> object that was inserted
+ * into this <CODE>SOAPHeader</CODE> object
* @throws org.apache.axis2.om.OMException
- * if a SOAP error occurs
+ * if a SOAP error occurs
*/
public abstract SOAPHeaderBlock addHeaderBlock(String localName,
- OMNamespace ns) throws
OMException;
+ OMNamespace ns) throws OMException;
/**
- * Returns a list of all the <CODE>SOAPHeaderBlock</CODE>
- * objects in this <CODE>SOAPHeader</CODE> object that have the
- * the specified role. An role is a global attribute that
- * indicates the intermediate parties to whom the message should
- * be sent. An role receives the message and then sends it to
- * the next role. The default role is the ultimate intended
- * recipient for the message, so if no role attribute is
- * included in a <CODE>SOAPHeader</CODE> object, the message is
- * sent to its ultimate destination.
- *
- * @param role a <CODE>String</CODE> giving the
- * URI of the role for which to search
+ * Returns a list of all the <CODE>SOAPHeaderBlock</CODE> objects in this
+ * <CODE>SOAPHeader</CODE> object that have the the specified role. An
+ * role is a global attribute that indicates the intermediate parties to
+ * whom the message should be sent. An role receives the message and then
+ * sends it to the next role. The default role is the ultimate intended
+ * recipient for the message, so if no role attribute is included in a
+ * <CODE>SOAPHeader</CODE> object, the message is sent to its ultimate
+ * destination.
+ *
+ * @param role
+ * a <CODE>String</CODE> giving the URI of the role for which
+ * to search
* @return an <CODE>Iterator</CODE> object over all the <CODE>
- * SOAPHeaderBlock</CODE> objects that contain the
- * specified role
- * @see #extractHeaderBlocks(java.lang.String)
extractHeaderBlocks(java.lang.String)
+ * SOAPHeaderBlock</CODE> objects that contain the specified role
+ * @see #extractHeaderBlocks(java.lang.String)
+ * extractHeaderBlocks(java.lang.String)
*/
public abstract Iterator examineHeaderBlocks(String role);
/**
- * Returns a list of all the <CODE>SOAPHeaderBlock</CODE>
- * objects in this <CODE>SOAPHeader</CODE> object that have
- * the the specified role and detaches them from this <CODE>
- * SOAPHeader</CODE> object.
- * <P>This method allows an role to process only the parts of
- * the <CODE>SOAPHeader</CODE> object that apply to it and to
- * remove them before passing the message on to the next
- * role.
- *
- * @param role a <CODE>String</CODE> giving the
- * URI of the role for which to search
+ * Returns a list of all the <CODE>SOAPHeaderBlock</CODE> objects in this
+ * <CODE>SOAPHeader</CODE> object that have the the specified role and
+ * detaches them from this <CODE>SOAPHeader</CODE> object.
+ * <P>
+ * This method allows an role to process only the parts of the <CODE>
+ * SOAPHeader</CODE> object that apply to it and to remove them before
+ * passing the message on to the next role.
+ *
+ * @param role
+ * a <CODE>String</CODE> giving the URI of the role for which
+ * to search
* @return an <CODE>Iterator</CODE> object over all the <CODE>
- * SOAPHeaderBlock</CODE> objects that contain the
- * specified role
- * @see #examineHeaderBlocks(java.lang.String)
examineHeaderBlocks(java.lang.String)
+ * SOAPHeaderBlock</CODE> objects that contain the specified role
+ * @see #examineHeaderBlocks(java.lang.String)
+ * examineHeaderBlocks(java.lang.String)
*/
public abstract Iterator extractHeaderBlocks(String role);
@@ -86,12 +84,13 @@
* <code>SOAPHeaderBlock</code> objects in this <code>SOAPHeader</code>
* object that have the specified role and that have a MustUnderstand
* attribute whose value is equivalent to <code>true</code>.
- *
- * @param role a <code>String</code> giving the URI of the role for which
- * to search
+ *
+ * @param role
+ * a <code>String</code> giving the URI of the role for which
+ * to search
* @return an <code>Iterator</code> object over all the
- * <code>SOAPHeaderBlock</code> objects that contain the
- * specified role and are marked as MustUnderstand
+ * <code>SOAPHeaderBlock</code> objects that contain the specified
+ * role and are marked as MustUnderstand
*/
public abstract Iterator examineMustUnderstandHeaderBlocks(String role);
@@ -99,10 +98,11 @@
* Returns an <code>Iterator</code> over all the
* <code>SOAPHeaderBlock</code> objects in this <code>SOAPHeader</code>
* object.
- *
+ *
* @return an <code>Iterator</code> object over all the
* <code>SOAPHeaderBlock</code> objects contained by this
- * <code>SOAPHeader</code>
+ * <code>SOAPHeader</code>. If there are no header blocks then an
+ * empty iterator is returned.
*/
public abstract Iterator examineAllHeaderBlocks();
@@ -110,7 +110,7 @@
* Returns an <code>Iterator</code> over all the
* <code>SOAPHeaderBlock</code> objects in this <code>SOAPHeader </code>
* object and detaches them from this <code>SOAPHeader</code> object.
- *
+ *
* @return an <code>Iterator</code> object over all the
* <code>SOAPHeaderBlock</code> objects contained by this
* <code>SOAPHeader</code>
@@ -119,7 +119,7 @@
/**
* Return all the Headers that has the Namespace URI to given NS URI
- *
+ *
* @param nsURI
* @return
*/
