| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>AttachmentPart</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="AttachmentPart"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":10,"i6":10,"i7":10,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":10,"i20":10,"i21":10,"i22":6,"i23":6,"i24":6,"i25":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Prev Class</li> |
| <li><a href="../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/soap/AttachmentPart.html" target="_top">Frames</a></li> |
| <li><a href="AttachmentPart.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">javax.xml.soap</div> |
| <h2 title="Class AttachmentPart" class="title">Class AttachmentPart</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.xml.soap.AttachmentPart</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AttachmentPart</span> |
| extends java.lang.Object</pre> |
| <div class="block">A single attachment to a <code>SOAPMessage</code> object. A <code>SOAPMessage</code> |
| object may contain zero, one, or many <code>AttachmentPart</code> objects. |
| Each <code>AttachmentPart</code> object consists of two parts, |
| application-specific content and associated MIME headers. The |
| MIME headers consists of name/value pairs that can be used to |
| identify and describe the content. |
| <p> |
| An <code>AttachmentPart</code> object must conform to certain standards. |
| <OL> |
| <LI>It must conform to <a href="http://www.ietf.org/rfc/rfc2045.txt"> |
| MIME [RFC2045] standards</a> |
| <LI>It MUST contain content |
| <LI>The header portion MUST include the following header: |
| <UL> |
| <LI><code>Content-Type</code><br> |
| This header identifies the type of data in the content of an |
| <code>AttachmentPart</code> object and MUST conform to [RFC2045]. |
| The following is an example of a Content-Type header: |
| <PRE> |
| Content-Type: application/xml |
| </PRE> |
| The following line of code, in which <code>ap</code> is an |
| <code>AttachmentPart</code> object, sets the header shown in |
| the previous example. |
| <PRE> |
| ap.setMimeHeader("Content-Type", "application/xml"); |
| </PRE> |
| </UL> |
| </OL> |
| <p> |
| There are no restrictions on the content portion of an <code>AttachmentPart</code> object. The content may be anything from a |
| simple plain text object to a complex XML document or image file. |
| |
| <p> |
| An <code>AttachmentPart</code> object is created with the method |
| <code>SOAPMessage.createAttachmentPart</code>. After setting its MIME headers, |
| the <code>AttachmentPart</code> object is added to the message |
| that created it with the method <code>SOAPMessage.addAttachmentPart</code>. |
| |
| <p> |
| The following code fragment, in which <code>m</code> is a |
| <code>SOAPMessage</code> object and <code>contentStringl</code> is a |
| <code>String</code>, creates an instance of <code>AttachmentPart</code>, |
| sets the <code>AttachmentPart</code> object with some content and |
| header information, and adds the <code>AttachmentPart</code> object to |
| the <code>SOAPMessage</code> object. |
| <PRE> |
| AttachmentPart ap1 = m.createAttachmentPart(); |
| ap1.setContent(contentString1, "text/plain"); |
| m.addAttachmentPart(ap1); |
| </PRE> |
| |
| |
| <p> |
| The following code fragment creates and adds a second |
| <code>AttachmentPart</code> instance to the same message. <code>jpegData</code> |
| is a binary byte buffer representing the jpeg file. |
| <PRE> |
| AttachmentPart ap2 = m.createAttachmentPart(); |
| byte[] jpegData = ...; |
| ap2.setContent(new ByteArrayInputStream(jpegData), "image/jpeg"); |
| m.addAttachmentPart(ap2); |
| </PRE> |
| <p> |
| The <code>getContent</code> method retrieves the contents and header from |
| an <code>AttachmentPart</code> object. Depending on the |
| <code>DataContentHandler</code> objects present, the returned |
| <code>Object</code> can either be a typed Java object corresponding |
| to the MIME type or an <code>InputStream</code> object that contains the |
| content as bytes. |
| <PRE> |
| String content1 = ap1.getContent(); |
| java.io.InputStream content2 = ap2.getContent(); |
| </PRE> |
| |
| The method <code>clearContent</code> removes all the content from an |
| <code>AttachmentPart</code> object but does not affect its header information. |
| <PRE> |
| ap1.clearContent(); |
| </PRE></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</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="../../../javax/xml/soap/AttachmentPart.html#AttachmentPart--">AttachmentPart</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#addMimeHeader-java.lang.String-java.lang.String-">addMimeHeader</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Adds a MIME header with the specified name and value to this |
| <code>AttachmentPart</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#clearContent--">clearContent</a></span>()</code> |
| <div class="block">Clears out the content of this <code>AttachmentPart</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../javax/xml/soap/MimeHeader.html" title="class in javax.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getAllMimeHeaders--">getAllMimeHeaders</a></span>()</code> |
| <div class="block">Retrieves all the headers for this <code>AttachmentPart</code> object |
| as an iterator over the <code>MimeHeader</code> objects.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract java.io.InputStream</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getBase64Content--">getBase64Content</a></span>()</code> |
| <div class="block">Returns an <code>InputStream</code> which can be used to obtain the |
| content of <code>AttachmentPart</code> as Base64 encoded |
| character data, this method would base64 encode the raw bytes |
| of the attachment and return.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getContent--">getContent</a></span>()</code> |
| <div class="block">Gets the content of this <code>AttachmentPart</code> object as a Java |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getContentId--">getContentId</a></span>()</code> |
| <div class="block">Gets the value of the MIME header whose name is "Content-ID".</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getContentLocation--">getContentLocation</a></span>()</code> |
| <div class="block">Gets the value of the MIME header whose name is "Content-Location".</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getContentType--">getContentType</a></span>()</code> |
| <div class="block">Gets the value of the MIME header whose name is "Content-Type".</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract javax.activation.DataHandler</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getDataHandler--">getDataHandler</a></span>()</code> |
| <div class="block">Gets the <code>DataHandler</code> object for this <code>AttachmentPart</code> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../javax/xml/soap/MimeHeader.html" title="class in javax.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getMatchingMimeHeaders-java.lang.String:A-">getMatchingMimeHeaders</a></span>(java.lang.String[] names)</code> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects that match a name in |
| the given array.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getMimeHeader-java.lang.String-">getMimeHeader</a></span>(java.lang.String name)</code> |
| <div class="block">Gets all the values of the header identified by the given |
| <code>String</code>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract java.util.Iterator<<a href="../../../javax/xml/soap/MimeHeader.html" title="class in javax.xml.soap">MimeHeader</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getNonMatchingMimeHeaders-java.lang.String:A-">getNonMatchingMimeHeaders</a></span>(java.lang.String[] names)</code> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects whose name does |
| not match a name in the given array.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract java.io.InputStream</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getRawContent--">getRawContent</a></span>()</code> |
| <div class="block">Gets the content of this <code>AttachmentPart</code> object as an |
| InputStream as if a call had been made to <code>getContent</code> and no |
| <code>DataContentHandler</code> had been registered for the |
| <code>content-type</code> of this <code>AttachmentPart</code>.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getRawContentBytes--">getRawContentBytes</a></span>()</code> |
| <div class="block">Gets the content of this <code>AttachmentPart</code> object as a |
| byte[] array as if a call had been made to <code>getContent</code> and no |
| <code>DataContentHandler</code> had been registered for the |
| <code>content-type</code> of this <code>AttachmentPart</code>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#getSize--">getSize</a></span>()</code> |
| <div class="block">Returns the number of bytes in this <code>AttachmentPart</code> |
| object.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#removeAllMimeHeaders--">removeAllMimeHeaders</a></span>()</code> |
| <div class="block">Removes all the MIME header entries.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#removeMimeHeader-java.lang.String-">removeMimeHeader</a></span>(java.lang.String header)</code> |
| <div class="block">Removes all MIME headers that match the given name.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setBase64Content-java.io.InputStream-java.lang.String-">setBase64Content</a></span>(java.io.InputStream content, |
| java.lang.String contentType)</code> |
| <div class="block">Sets the content of this attachment part from the Base64 source |
| <code>InputStream</code> and sets the value of the |
| <code>Content-Type</code> header to the value contained in |
| <code>contentType</code>, This method would first decode the base64 |
| input and write the resulting raw bytes to the attachment.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setContent-java.lang.Object-java.lang.String-">setContent</a></span>(java.lang.Object object, |
| java.lang.String contentType)</code> |
| <div class="block">Sets the content of this attachment part to that of the given |
| <code>Object</code> and sets the value of the <code>Content-Type</code> |
| header to the given type.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setContentId-java.lang.String-">setContentId</a></span>(java.lang.String contentId)</code> |
| <div class="block">Sets the MIME header whose name is "Content-ID" with the given value.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setContentLocation-java.lang.String-">setContentLocation</a></span>(java.lang.String contentLocation)</code> |
| <div class="block">Sets the MIME header whose name is "Content-Location" with the given value.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setContentType-java.lang.String-">setContentType</a></span>(java.lang.String contentType)</code> |
| <div class="block">Sets the MIME header whose name is "Content-Type" with the given value.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setDataHandler-javax.activation.DataHandler-">setDataHandler</a></span>(javax.activation.DataHandler dataHandler)</code> |
| <div class="block">Sets the given <code>DataHandler</code> object as the data handler |
| for this <code>AttachmentPart</code> object.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setMimeHeader-java.lang.String-java.lang.String-">setMimeHeader</a></span>(java.lang.String name, |
| java.lang.String value)</code> |
| <div class="block">Changes the first header entry that matches the given name |
| to the given value, adding a new header if no existing header |
| matches.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setRawContent-java.io.InputStream-java.lang.String-">setRawContent</a></span>(java.io.InputStream content, |
| java.lang.String contentType)</code> |
| <div class="block">Sets the content of this attachment part to that contained by the |
| <code>InputStream</code> <code>content</code> and sets the value of the |
| <code>Content-Type</code> header to the value contained in |
| <code>contentType</code>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/soap/AttachmentPart.html#setRawContentBytes-byte:A-int-int-java.lang.String-">setRawContentBytes</a></span>(byte[] content, |
| int offset, |
| int len, |
| java.lang.String contentType)</code> |
| <div class="block">Sets the content of this attachment part to that contained by the |
| <code>byte[]</code> array <code>content</code> and sets the value of the |
| <code>Content-Type</code> header to the value contained in |
| <code>contentType</code>.</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="AttachmentPart--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AttachmentPart</h4> |
| <pre>public AttachmentPart()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSize</h4> |
| <pre>public abstract int getSize() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Returns the number of bytes in this <code>AttachmentPart</code> |
| object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the size of this <code>AttachmentPart</code> object in bytes |
| or -1 if the size cannot be determined</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if the content of this attachment is |
| corrupted of if there was an exception while trying |
| to determine the size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clearContent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearContent</h4> |
| <pre>public abstract void clearContent()</pre> |
| <div class="block">Clears out the content of this <code>AttachmentPart</code> object. |
| The MIME header portion is left untouched.</div> |
| </li> |
| </ul> |
| <a name="getContent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre>public abstract java.lang.Object getContent() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Gets the content of this <code>AttachmentPart</code> object as a Java |
| object. The type of the returned Java object depends on (1) the |
| <code>DataContentHandler</code> object that is used to interpret the bytes |
| and (2) the <code>Content-Type</code> given in the header. |
| <p> |
| For the MIME content types "text/plain", "text/html" and "text/xml", the |
| <code>DataContentHandler</code> object does the conversions to and |
| from the Java types corresponding to the MIME types. |
| For other MIME types,the <code>DataContentHandler</code> object |
| can return an <code>InputStream</code> object that contains the content data |
| as raw bytes. |
| <p> |
| A SAAJ-compliant implementation must, as a minimum, return a |
| <code>java.lang.String</code> object corresponding to any content |
| stream with a <code>Content-Type</code> value of |
| <code>text/plain</code>, a |
| <code>javax.xml.transform.stream.StreamSource</code> object corresponding to a |
| content stream with a <code>Content-Type</code> value of |
| <code>text/xml</code>, a <code>java.awt.Image</code> object |
| corresponding to a content stream with a |
| <code>Content-Type</code> value of <code>image/gif</code> or |
| <code>image/jpeg</code>. For those content types that an |
| installed <code>DataContentHandler</code> object does not understand, the |
| <code>DataContentHandler</code> object is required to return a |
| <code>java.io.InputStream</code> object with the raw bytes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Java object with the content of this <code>AttachmentPart</code> |
| object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there is no content set into this |
| <code>AttachmentPart</code> object or if there was a data |
| transformation error</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRawContent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRawContent</h4> |
| <pre>public abstract java.io.InputStream getRawContent() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Gets the content of this <code>AttachmentPart</code> object as an |
| InputStream as if a call had been made to <code>getContent</code> and no |
| <code>DataContentHandler</code> had been registered for the |
| <code>content-type</code> of this <code>AttachmentPart</code>. |
| <p> |
| Note that reading from the returned InputStream would result in consuming |
| the data in the stream. It is the responsibility of the caller to reset |
| the InputStream appropriately before calling a Subsequent API. If a copy |
| of the raw attachment content is required then the <a href="../../../javax/xml/soap/AttachmentPart.html#getRawContentBytes--"><code>getRawContentBytes()</code></a> API |
| should be used instead.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>InputStream</code> from which the raw data contained by |
| the <code>AttachmentPart</code> can be accessed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there is no content set into this |
| <code>AttachmentPart</code> object or if there was a data |
| transformation error.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/AttachmentPart.html#getRawContentBytes--"><code>getRawContentBytes()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRawContentBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRawContentBytes</h4> |
| <pre>public abstract byte[] getRawContentBytes() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Gets the content of this <code>AttachmentPart</code> object as a |
| byte[] array as if a call had been made to <code>getContent</code> and no |
| <code>DataContentHandler</code> had been registered for the |
| <code>content-type</code> of this <code>AttachmentPart</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>byte[]</code> array containing the raw data of the |
| <code>AttachmentPart</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there is no content set into this |
| <code>AttachmentPart</code> object or if there was a data |
| transformation error.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getBase64Content--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBase64Content</h4> |
| <pre>public abstract java.io.InputStream getBase64Content() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Returns an <code>InputStream</code> which can be used to obtain the |
| content of <code>AttachmentPart</code> as Base64 encoded |
| character data, this method would base64 encode the raw bytes |
| of the attachment and return.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>InputStream</code> from which the Base64 encoded |
| <code>AttachmentPart</code> can be read.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there is no content set into this |
| <code>AttachmentPart</code> object or if there was a data |
| transformation error.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContent-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContent</h4> |
| <pre>public abstract void setContent(java.lang.Object object, |
| java.lang.String contentType)</pre> |
| <div class="block">Sets the content of this attachment part to that of the given |
| <code>Object</code> and sets the value of the <code>Content-Type</code> |
| header to the given type. The type of the |
| <code>Object</code> should correspond to the value given for the |
| <code>Content-Type</code>. This depends on the particular |
| set of <code>DataContentHandler</code> objects in use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the Java object that makes up the content for |
| this attachment part</dd> |
| <dd><code>contentType</code> - the MIME string that specifies the type of |
| the content</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - may be thrown if the contentType |
| does not match the type of the content object, or if there |
| was no <code>DataContentHandler</code> object for this |
| content object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/AttachmentPart.html#getContent--"><code>getContent()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRawContent-java.io.InputStream-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRawContent</h4> |
| <pre>public abstract void setRawContent(java.io.InputStream content, |
| java.lang.String contentType) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Sets the content of this attachment part to that contained by the |
| <code>InputStream</code> <code>content</code> and sets the value of the |
| <code>Content-Type</code> header to the value contained in |
| <code>contentType</code>. |
| <P> |
| A subsequent call to getSize() may not be an exact measure |
| of the content size.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the raw data to add to the attachment part</dd> |
| <dd><code>contentType</code> - the value to set into the <code>Content-Type</code> |
| header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if an there is an error in setting the content</dd> |
| <dd><code>java.lang.NullPointerException</code> - if <code>content</code> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRawContentBytes-byte:A-int-int-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRawContentBytes</h4> |
| <pre>public abstract void setRawContentBytes(byte[] content, |
| int offset, |
| int len, |
| java.lang.String contentType) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Sets the content of this attachment part to that contained by the |
| <code>byte[]</code> array <code>content</code> and sets the value of the |
| <code>Content-Type</code> header to the value contained in |
| <code>contentType</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the raw data to add to the attachment part</dd> |
| <dd><code>contentType</code> - the value to set into the <code>Content-Type</code> |
| header</dd> |
| <dd><code>offset</code> - the offset in the byte array of the content</dd> |
| <dd><code>len</code> - the number of bytes that form the content</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if an there is an error in setting the content |
| or content is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setBase64Content-java.io.InputStream-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBase64Content</h4> |
| <pre>public abstract void setBase64Content(java.io.InputStream content, |
| java.lang.String contentType) |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Sets the content of this attachment part from the Base64 source |
| <code>InputStream</code> and sets the value of the |
| <code>Content-Type</code> header to the value contained in |
| <code>contentType</code>, This method would first decode the base64 |
| input and write the resulting raw bytes to the attachment. |
| <P> |
| A subsequent call to getSize() may not be an exact measure |
| of the content size.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the base64 encoded data to add to the attachment part</dd> |
| <dd><code>contentType</code> - the value to set into the <code>Content-Type</code> |
| header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if an there is an error in setting the content</dd> |
| <dd><code>java.lang.NullPointerException</code> - if <code>content</code> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, SAAJ 1.3</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDataHandler--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataHandler</h4> |
| <pre>public abstract javax.activation.DataHandler getDataHandler() |
| throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre> |
| <div class="block">Gets the <code>DataHandler</code> object for this <code>AttachmentPart</code> |
| object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>DataHandler</code> object associated with this |
| <code>AttachmentPart</code> object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if there is no data in |
| this <code>AttachmentPart</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDataHandler-javax.activation.DataHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDataHandler</h4> |
| <pre>public abstract void setDataHandler(javax.activation.DataHandler dataHandler)</pre> |
| <div class="block">Sets the given <code>DataHandler</code> object as the data handler |
| for this <code>AttachmentPart</code> object. Typically, on an incoming |
| message, the data handler is automatically set. When |
| a message is being created and populated with content, the |
| <code>setDataHandler</code> method can be used to get data from |
| various data sources into the message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataHandler</code> - the <code>DataHandler</code> object to be set</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified <code>DataHandler</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentId</h4> |
| <pre>public java.lang.String getContentId()</pre> |
| <div class="block">Gets the value of the MIME header whose name is "Content-ID".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the |
| "Content-ID" header or <code>null</code> if there |
| is none</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/AttachmentPart.html#setContentId-java.lang.String-"><code>setContentId(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentLocation</h4> |
| <pre>public java.lang.String getContentLocation()</pre> |
| <div class="block">Gets the value of the MIME header whose name is "Content-Location".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the |
| "Content-Location" header or <code>null</code> if there |
| is none</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentType</h4> |
| <pre>public java.lang.String getContentType()</pre> |
| <div class="block">Gets the value of the MIME header whose name is "Content-Type".</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> giving the value of the |
| "Content-Type" header or <code>null</code> if there |
| is none</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContentId-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentId</h4> |
| <pre>public void setContentId(java.lang.String contentId)</pre> |
| <div class="block">Sets the MIME header whose name is "Content-ID" with the given value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentId</code> - a <code>String</code> giving the value of the |
| "Content-ID" header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified <code>contentId</code> value</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/AttachmentPart.html#getContentId--"><code>getContentId()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContentLocation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentLocation</h4> |
| <pre>public void setContentLocation(java.lang.String contentLocation)</pre> |
| <div class="block">Sets the MIME header whose name is "Content-Location" with the given value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentLocation</code> - a <code>String</code> giving the value of the |
| "Content-Location" header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified content location</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setContentType-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentType</h4> |
| <pre>public void setContentType(java.lang.String contentType)</pre> |
| <div class="block">Sets the MIME header whose name is "Content-Type" with the given value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>contentType</code> - a <code>String</code> giving the value of the |
| "Content-Type" header</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified content type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeMimeHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMimeHeader</h4> |
| <pre>public abstract void removeMimeHeader(java.lang.String header)</pre> |
| <div class="block">Removes all MIME headers that match the given name.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - the string name of the MIME header/s to |
| be removed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeAllMimeHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeAllMimeHeaders</h4> |
| <pre>public abstract void removeAllMimeHeaders()</pre> |
| <div class="block">Removes all the MIME header entries.</div> |
| </li> |
| </ul> |
| <a name="getMimeHeader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMimeHeader</h4> |
| <pre>public abstract java.lang.String[] getMimeHeader(java.lang.String name)</pre> |
| <div class="block">Gets all the values of the header identified by the given |
| <code>String</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header; example: "Content-Type"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>String</code> array giving the value for the |
| specified header</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/xml/soap/AttachmentPart.html#setMimeHeader-java.lang.String-java.lang.String-"><code>setMimeHeader(java.lang.String, java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMimeHeader-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMimeHeader</h4> |
| <pre>public abstract void setMimeHeader(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Changes the first header entry that matches the given name |
| to the given value, adding a new header if no existing header |
| matches. This method also removes all matching headers but the first. <p> |
| |
| Note that RFC822 headers can only contain US-ASCII characters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - a <code>String</code> giving the name of the header |
| for which to search</dd> |
| <dd><code>value</code> - a <code>String</code> giving the value to be set for |
| the header whose name matches the given name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if there was a problem with |
| the specified mime header name or value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addMimeHeader-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMimeHeader</h4> |
| <pre>public abstract void addMimeHeader(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Adds a MIME header with the specified name and value to this |
| <code>AttachmentPart</code> object. |
| <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> giving the name of the header |
| to be added</dd> |
| <dd><code>value</code> - a <code>String</code> giving 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 with |
| the specified mime header name or value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllMimeHeaders--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllMimeHeaders</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../javax/xml/soap/MimeHeader.html" title="class in javax.xml.soap">MimeHeader</a>> getAllMimeHeaders()</pre> |
| <div class="block">Retrieves all the headers for this <code>AttachmentPart</code> object |
| as an iterator over the <code>MimeHeader</code> objects.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an <code>Iterator</code> object with all of the Mime |
| headers for this <code>AttachmentPart</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMatchingMimeHeaders-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatchingMimeHeaders</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../javax/xml/soap/MimeHeader.html" title="class in javax.xml.soap">MimeHeader</a>> getMatchingMimeHeaders(java.lang.String[] names)</pre> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects that match a name in |
| the given array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a <code>String</code> array with the name(s) of the |
| MIME headers to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all of the MIME headers that match one of the names in the |
| given array as an <code>Iterator</code> object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNonMatchingMimeHeaders-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNonMatchingMimeHeaders</h4> |
| <pre>public abstract java.util.Iterator<<a href="../../../javax/xml/soap/MimeHeader.html" title="class in javax.xml.soap">MimeHeader</a>> getNonMatchingMimeHeaders(java.lang.String[] names)</pre> |
| <div class="block">Retrieves all <code>MimeHeader</code> objects whose name does |
| not match a name in the given array.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>names</code> - a <code>String</code> array with the name(s) of the |
| MIME headers not to be returned</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>all of the MIME headers in this <code>AttachmentPart</code> object |
| except those that match one of the names in the |
| given array. The nonmatching MIME headers are returned as an |
| <code>Iterator</code> object.</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>Prev Class</li> |
| <li><a href="../../../javax/xml/soap/Detail.html" title="interface in javax.xml.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/xml/soap/AttachmentPart.html" target="_top">Frames</a></li> |
| <li><a href="AttachmentPart.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> |
