| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MimeHeaders</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MimeHeaders"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/soap/MimeHeaders.html" target="_top">Frames</a></li> |
| <li><a href="MimeHeaders.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.xml.soap</div> |
| <h2 title="Class MimeHeaders" class="title">Class MimeHeaders</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.xml.soap.MimeHeaders</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">MimeHeaders</span> |
| extends java.lang.Object</pre> |
| <div class="block">A container for <code>MimeHeader</code> objects, which represent |
| the MIME headers present in a MIME part of a message. |
| |
| <p>This class is used primarily when an application wants to |
| retrieve specific attachments based on certain MIME headers and |
| values. This class will most likely be used by implementations of |
| <code>AttachmentPart</code> and other MIME dependent parts of the SAAJ |
| API.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/SOAPMessage.html#getAttachments--"><code>SOAPMessage.getAttachments()</code></a>, |
| <a href="../../../jakarta/xml/soap/AttachmentPart.html" title="class in jakarta.xml.soap"><code>AttachmentPart</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#MimeHeaders--">MimeHeaders</a></span>()</code> |
| <div class="block">Constructs a default <code>MimeHeaders</code> object initialized with |
| an empty <code>Vector</code> object.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#addHeader-java.lang.String-java.lang.String-">addHeader</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Adds a <code>MimeHeader</code> object with the specified name and value |
| to this <code>MimeHeaders</code> object's list of headers.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#getAllHeaders--">getAllHeaders</a></span>()</code> |
| <div class="block">Returns all the <code>MimeHeader</code>s in this <code>MimeHeaders</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#getHeader-java.lang.String-">getHeader</a></span>(java.lang.String name)</code> |
| <div class="block">Returns all of the values for the specified header as an array of |
| <code>String</code> objects.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#getMatchingHeaders-java.lang.String:A-">getMatchingHeaders</a></span>(java.lang.String[] names)</code> |
| <div class="block">Returns all the <code>MimeHeader</code> objects whose name matches |
| a name in the given array of names.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#getNonMatchingHeaders-java.lang.String:A-">getNonMatchingHeaders</a></span>(java.lang.String[] names)</code> |
| <div class="block">Returns all of the <code>MimeHeader</code> objects whose name does not |
| match a name in the given array of names.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#removeAllHeaders--">removeAllHeaders</a></span>()</code> |
| <div class="block">Removes all the header entries from this <code>MimeHeaders</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#removeHeader-java.lang.String-">removeHeader</a></span>(java.lang.String name)</code> |
| <div class="block">Remove all <code>MimeHeader</code> objects whose name matches the |
| given name.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/MimeHeaders.html#setHeader-java.lang.String-java.lang.String-">setHeader</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Replaces the current value of the first header entry whose name matches |
| the given name with the given value, adding a new header if no existing header |
| name matches.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MimeHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MimeHeaders</h4> |
| <pre>public MimeHeaders()</pre> |
| <div class="block">Constructs a default <code>MimeHeaders</code> object initialized with |
| an empty <code>Vector</code> object.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeader</h4> |
| <pre>public java.lang.String[] getHeader(java.lang.String name)</pre> |
| <div class="block">Returns all of the values for the specified header as an array of |
| <code>String</code> objects.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header for which values will be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> array with all of the values for the |
| specified header</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/MimeHeaders.html#setHeader-java.lang.String-java.lang.String-"><code>setHeader(java.lang.String, java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setHeader-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeader</h4> |
| <pre>public void setHeader(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Replaces the current value of the first header entry whose name matches |
| the given name with the given value, adding a new header if no existing header |
| name matches. This method also removes all matching headers after the first one. |
| <P> |
| Note that RFC822 headers can contain only US-ASCII characters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> with the name of the header for |
| which to search</dd> |
| <dd><code>value</code> - a <code>String</code> with the value that will replace the |
| current value of the specified header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem in the |
| mime header name or the value being set</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/xml/soap/MimeHeaders.html#getHeader-java.lang.String-"><code>getHeader(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addHeader-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre>public void addHeader(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Adds a <code>MimeHeader</code> object with the specified name and value |
| to this <code>MimeHeaders</code> object's list of headers. |
| <P> |
| Note that RFC822 headers can contain only US-ASCII characters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> with the name of the header to |
| be added</dd> |
| <dd><code>value</code> - a <code>String</code> with the value of the header to |
| be added</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem in the |
| mime header name or value being added</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeHeader</h4> |
| <pre>public void removeHeader(java.lang.String name)</pre> |
| <div class="block">Remove all <code>MimeHeader</code> objects whose name matches the |
| given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> with the name of the header for |
| which to search</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAllHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllHeaders</h4> |
| <pre>public void removeAllHeaders()</pre> |
| <div class="block">Removes all the header entries from this <code>MimeHeaders</code> object.</div> |
| </li> |
| </ul> |
| <a name="getAllHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllHeaders</h4> |
| <pre>public java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>> getAllHeaders()</pre> |
| <div class="block">Returns all the <code>MimeHeader</code>s in this <code>MimeHeaders</code> object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object over this <code>MimeHeaders</code> |
| object's list of <code>MimeHeader</code> objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMatchingHeaders-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatchingHeaders</h4> |
| <pre>public java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>> getMatchingHeaders(java.lang.String[] names)</pre> |
| <div class="block">Returns all the <code>MimeHeader</code> objects whose name matches |
| a name in the given array of names.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - an array of <code>String</code> objects with the names |
| for which to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object over the <code>MimeHeader</code> |
| objects whose name matches one of the names in the given list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNonMatchingHeaders-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNonMatchingHeaders</h4> |
| <pre>public java.util.Iterator<<a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap">MimeHeader</a>> getNonMatchingHeaders(java.lang.String[] names)</pre> |
| <div class="block">Returns all of the <code>MimeHeader</code> objects whose name does not |
| match a name in the given array of names.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - an array of <code>String</code> objects with the names |
| for which to search</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object over the <code>MimeHeader</code> |
| objects whose name does not match one of the names in the given list</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/xml/soap/MimeHeader.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/xml/soap/Name.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/xml/soap/MimeHeaders.html" target="_top">Frames</a></li> |
| <li><a href="MimeHeaders.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
