/usr/share/doc/libasync-http-client-java/api/com/ning/http/multipart/MultipartRequestEntity.html is in libasync-http-client-java-doc 1.6.5-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_51) on Wed Feb 19 11:43:02 UTC 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>MultipartRequestEntity (Asynchronous Http Client 1.6.5 API)</title>
<meta name="date" content="2014-02-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MultipartRequestEntity (Asynchronous Http Client 1.6.5 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/MultipartRequestEntity.html">Use</a></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="../../../../com/ning/http/multipart/MultipartEncodingUtil.html" title="class in com.ning.http.multipart"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ning/http/multipart/Part.html" title="class in com.ning.http.multipart"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ning/http/multipart/MultipartRequestEntity.html" target="_top">Frames</a></li>
<li><a href="MultipartRequestEntity.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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">com.ning.http.multipart</div>
<h2 title="Class MultipartRequestEntity" class="title">Class MultipartRequestEntity</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.ning.http.multipart.MultipartRequestEntity</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/ning/http/multipart/RequestEntity.html" title="interface in com.ning.http.multipart">RequestEntity</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">MultipartRequestEntity</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../com/ning/http/multipart/RequestEntity.html" title="interface in com.ning.http.multipart">RequestEntity</a></pre>
<div class="block">This class is an adaptation of the Apache HttpClient implementation</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../com/ning/http/multipart/Part.html" title="class in com.ning.http.multipart">Part</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#parts">parts</a></strong></code>
<div class="block">The MIME parts as set by the constructor</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#MultipartRequestEntity(com.ning.http.multipart.Part[], com.ning.http.client.FluentStringsMap)">MultipartRequestEntity</a></strong>(<a href="../../../../com/ning/http/multipart/Part.html" title="class in com.ning.http.multipart">Part</a>[] parts,
<a href="../../../../com/ning/http/client/FluentStringsMap.html" title="class in com.ning.http.client">FluentStringsMap</a> methodParams)</code>
<div class="block">Creates a new multipart entity containing the given parts.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#getContentLength()">getContentLength</a></strong>()</code>
<div class="block">Gets the request entity's length.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#getContentType()">getContentType</a></strong>()</code>
<div class="block">Gets the entity's content type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#getMultipartBoundary()">getMultipartBoundary</a></strong>()</code>
<div class="block">Returns the MIME boundary string that is used to demarcate boundaries of
this part.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#isRepeatable()">isRepeatable</a></strong>()</code>
<div class="block">Returns <code>true</code> if all parts are repeatable, <code>false</code> otherwise.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/ning/http/multipart/MultipartRequestEntity.html#writeRequest(java.io.OutputStream)">writeRequest</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)</code>
<div class="block">Writes the request entity to the given stream.</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.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="parts">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parts</h4>
<pre>protected <a href="../../../../com/ning/http/multipart/Part.html" title="class in com.ning.http.multipart">Part</a>[] parts</pre>
<div class="block">The MIME parts as set by the constructor</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MultipartRequestEntity(com.ning.http.multipart.Part[], com.ning.http.client.FluentStringsMap)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MultipartRequestEntity</h4>
<pre>public MultipartRequestEntity(<a href="../../../../com/ning/http/multipart/Part.html" title="class in com.ning.http.multipart">Part</a>[] parts,
<a href="../../../../com/ning/http/client/FluentStringsMap.html" title="class in com.ning.http.client">FluentStringsMap</a> methodParams)</pre>
<div class="block">Creates a new multipart entity containing the given parts.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parts</code> - The parts to include.</dd><dd><code>methodParams</code> - The params of the HttpMethod using this entity.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMultipartBoundary()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMultipartBoundary</h4>
<pre>protected byte[] getMultipartBoundary()</pre>
<div class="block">Returns the MIME boundary string that is used to demarcate boundaries of
this part. The first call to this method will implicitly create a new
boundary string. To create a boundary string first the
HttpMethodParams.MULTIPART_BOUNDARY parameter is considered. Otherwise
a random one is generated.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The boundary string of this entity in ASCII encoding.</dd></dl>
</li>
</ul>
<a name="isRepeatable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRepeatable</h4>
<pre>public boolean isRepeatable()</pre>
<div class="block">Returns <code>true</code> if all parts are repeatable, <code>false</code> otherwise.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ning/http/multipart/RequestEntity.html#isRepeatable()">isRepeatable</a></code> in interface <code><a href="../../../../com/ning/http/multipart/RequestEntity.html" title="interface in com.ning.http.multipart">RequestEntity</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if the entity can be written to <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> more than once,
<tt>false</tt> otherwise.</dd></dl>
</li>
</ul>
<a name="writeRequest(java.io.OutputStream)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeRequest</h4>
<pre>public void writeRequest(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/ning/http/multipart/RequestEntity.html#writeRequest(java.io.OutputStream)">RequestEntity</a></code></strong></div>
<div class="block">Writes the request entity to the given stream.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ning/http/multipart/RequestEntity.html#writeRequest(java.io.OutputStream)">writeRequest</a></code> in interface <code><a href="../../../../com/ning/http/multipart/RequestEntity.html" title="interface in com.ning.http.multipart">RequestEntity</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
</li>
</ul>
<a name="getContentLength()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContentLength</h4>
<pre>public long getContentLength()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/ning/http/multipart/RequestEntity.html#getContentLength()">RequestEntity</a></code></strong></div>
<div class="block">Gets the request entity's length. This method should return a non-negative value if the content
length is known or a negative value if it is not. In the latter case the
EntityEnclosingMethod will use chunk encoding to
transmit the request entity.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ning/http/multipart/RequestEntity.html#getContentLength()">getContentLength</a></code> in interface <code><a href="../../../../com/ning/http/multipart/RequestEntity.html" title="interface in com.ning.http.multipart">RequestEntity</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a non-negative value when content length is known or a negative value when content length
is not known</dd></dl>
</li>
</ul>
<a name="getContentType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContentType</h4>
<pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getContentType()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/ning/http/multipart/RequestEntity.html#getContentType()">RequestEntity</a></code></strong></div>
<div class="block">Gets the entity's content type. This content type will be used as the value for the
"Content-Type" header.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/ning/http/multipart/RequestEntity.html#getContentType()">getContentType</a></code> in interface <code><a href="../../../../com/ning/http/multipart/RequestEntity.html" title="interface in com.ning.http.multipart">RequestEntity</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the entity's content type</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/MultipartRequestEntity.html">Use</a></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="../../../../com/ning/http/multipart/MultipartEncodingUtil.html" title="class in com.ning.http.multipart"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/ning/http/multipart/Part.html" title="class in com.ning.http.multipart"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ning/http/multipart/MultipartRequestEntity.html" target="_top">Frames</a></li>
<li><a href="MultipartRequestEntity.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 ======= -->
<p class="legalCopy"><small>Copyright © 2014. All rights reserved.</small></p>
</body>
</html>
|