Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / jakartaee-10.0 / javadoc / jakarta / ws / rs / core / EntityPart.Builder.html
blob: 1fecdbefc7e596fe2a959037fc83d672b4207677 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>EntityPart.Builder</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EntityPart.Builder";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":18,"i3":18,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/ws/rs/core/EntityTag.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/core/EntityPart.Builder.html" target="_top">Frames</a></li>
<li><a href="EntityPart.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.ws.rs.core</div>
<h2 title="Interface EntityPart.Builder" class="title">Interface EntityPart.Builder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../../../jakarta/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core">EntityPart</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">EntityPart.Builder</span></pre>
<div class="block">Builder for <a href="../../../../jakarta/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core"><code>EntityPart</code></a> instances.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.1</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../jakarta/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core">EntityPart</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--">build</a></span>()</code>
<div class="block">Builds a new EntityPart instance using the provided property values.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#content-java.io.InputStream-">content</a></span>(java.io.InputStream&nbsp;content)</code>
<div class="block">Sets the content for this part.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#content-java.lang.Object-">content</a></span>(java.lang.Object&nbsp;content)</code>
<div class="block">Sets the content for this part.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#content-java.lang.String-java.io.InputStream-">content</a></span>(java.lang.String&nbsp;fileName,
java.io.InputStream&nbsp;content)</code>
<div class="block">Convenience method, equivalent to calling
<code>fileName(fileName).content(content)</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#content-T-java.lang.Class-">content</a></span>(T&nbsp;content,
java.lang.Class&lt;? extends T&gt;&nbsp;type)</code>
<div class="block">Sets the content for this part.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#content-T-jakarta.ws.rs.core.GenericType-">content</a></span>(T&nbsp;content,
<a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a>&lt;T&gt;&nbsp;type)</code>
<div class="block">Sets the content for this part.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#fileName-java.lang.String-">fileName</a></span>(java.lang.String&nbsp;fileName)</code>
<div class="block">Sets the file name for this part.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#header-java.lang.String-java.lang.String...-">header</a></span>(java.lang.String&nbsp;headerName,
java.lang.String...&nbsp;headerValues)</code>
<div class="block">Adds a new header or replaces a previously added header and sets the header
value(s).</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#headers-jakarta.ws.rs.core.MultivaluedMap-">headers</a></span>(<a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;java.lang.String,java.lang.String&gt;&nbsp;newHeaders)</code>
<div class="block">Adds new headers or replaces previously added headers.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-jakarta.ws.rs.core.MediaType-">mediaType</a></span>(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType)</code>
<div class="block">Sets the media type for the EntityPart.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-java.lang.String-">mediaType</a></span>(java.lang.String&nbsp;mediaTypeString)</code>
<div class="block">Convenience method for setting the media type for the EntityPart.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="mediaType-jakarta.ws.rs.core.MediaType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mediaType</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;mediaType(<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core">MediaType</a>&nbsp;mediaType)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the media type for the EntityPart. This will also set the
<code>Content-Type</code> header for this part.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaType</code> - the media type for the part to be built</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>mediaType</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="mediaType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mediaType</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;mediaType(java.lang.String&nbsp;mediaTypeString)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Convenience method for setting the media type for the EntityPart. This will
also set the <code>Content-Type</code> header for this part. This call is
effectively the same as
<code>mediaType(MediaType.valueOf(mediaTypeString))</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaTypeString</code> - the media type for the part to be built</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>mediaTypeString</code> cannot be parsed
or is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="header-java.lang.String-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;header(java.lang.String&nbsp;headerName,
java.lang.String...&nbsp;headerValues)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Adds a new header or replaces a previously added header and sets the header
value(s).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headerName</code> - the header name</dd>
<dd><code>headerValues</code> - the header value(s)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>headerName</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="headers-jakarta.ws.rs.core.MultivaluedMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headers</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;headers(<a href="../../../../jakarta/ws/rs/core/MultivaluedMap.html" title="interface in jakarta.ws.rs.core">MultivaluedMap</a>&lt;java.lang.String,java.lang.String&gt;&nbsp;newHeaders)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Adds new headers or replaces previously added headers. The behavior of this
method would be the same as if iterating over the entry set and invoking the
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#header-java.lang.String-java.lang.String...-"><code>header(String, String...)</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newHeaders</code> - the multivalued map of headers to add to this part</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>newHeaders</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="fileName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fileName</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;fileName(java.lang.String&nbsp;fileName)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the file name for this part. The file name will be specified as an
attribute in the <code>Content-Disposition</code> header of this part. When this
method is called, the default media type used for the built part will be
"application/octet-stream" if not otherwise specified.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileName</code> - the file name for this part</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>fileName</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="content-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;content(java.io.InputStream&nbsp;content)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the content for this part. The content of this builder must be specified
before invoking the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a> method.
<p>
The <code>InputStream</code> will be closed by the implementation code after
sending the multipart data. Closing the stream before it is sent could result
in unexpected behavior.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - <code>InputStream</code> of the content of this part</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>content</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="content-java.lang.String-java.io.InputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre>default&nbsp;<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;content(java.lang.String&nbsp;fileName,
java.io.InputStream&nbsp;content)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Convenience method, equivalent to calling
<code>fileName(fileName).content(content)</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileName</code> - the filename of the part.</dd>
<dd><code>content</code> - the content stream of the part.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if either parameter is <code>null</code>.</dd>
</dl>
</li>
</ul>
<a name="content-java.lang.Object-java.lang.Class-">
<!-- -->
</a><a name="content-T-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;content(T&nbsp;content,
java.lang.Class&lt;? extends T&gt;&nbsp;type)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the content for this part. The content of this builder must be specified
before invoking the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a> method.
<p>
If the content is specified using this method, then the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a>
method is responsible for finding a registered
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a> that is capable of writing the
object type specified here using the default <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> or the
<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> specified in the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-jakarta.ws.rs.core.MediaType-"><code>mediaType(MediaType)</code></a> or
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-java.lang.String-"><code>mediaType(String)</code></a> methods and using any headers specified via the
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#header-java.lang.String-java.lang.String...-"><code>header(String, String...)</code></a> or <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#headers-jakarta.ws.rs.core.MultivaluedMap-"><code>headers(MultivaluedMap)</code></a>
methods.
</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the entity type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - the object to be used as the content</dd>
<dd><code>type</code> - the type of this object which will be used when selecting the
appropriate <a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>content</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="content-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre>default&nbsp;<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;content(java.lang.Object&nbsp;content)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the content for this part. The content of this builder must be specified
before invoking the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a> method.
<p>
If the content is specified using this method, then the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a>
method is responsible for finding a registered
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a> that is capable of writing the
object's class type specified here using the default <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> or the
<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> specified in the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-jakarta.ws.rs.core.MediaType-"><code>mediaType(MediaType)</code></a> or
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-java.lang.String-"><code>mediaType(String)</code></a> methods and using any headers specified via the
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#header-java.lang.String-java.lang.String...-"><code>header(String, String...)</code></a> or <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#headers-jakarta.ws.rs.core.MultivaluedMap-"><code>headers(MultivaluedMap)</code></a>
methods.
</p>
<p>
This is the equivalent of calling
<code>content(content, content.getClass())</code>.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - the object to be used as the content</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>content</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="content-java.lang.Object-jakarta.ws.rs.core.GenericType-">
<!-- -->
</a><a name="content-T-jakarta.ws.rs.core.GenericType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre>&lt;T&gt;&nbsp;<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html" title="interface in jakarta.ws.rs.core">EntityPart.Builder</a>&nbsp;content(T&nbsp;content,
<a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a>&lt;T&gt;&nbsp;type)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Sets the content for this part. The content of this builder must be specified
before invoking the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a> method.
<p>
If the content is specified using this method, then the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#build--"><code>build()</code></a>
method is responsible for finding a registered
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a> that is capable of writing the
object type specified here using the default <a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> or the
<a href="../../../../jakarta/ws/rs/core/MediaType.html" title="class in jakarta.ws.rs.core"><code>MediaType</code></a> specified in the <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-jakarta.ws.rs.core.MediaType-"><code>mediaType(MediaType)</code></a> or
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#mediaType-java.lang.String-"><code>mediaType(String)</code></a> methods and using any headers specified via the
<a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#header-java.lang.String-java.lang.String...-"><code>header(String, String...)</code></a> or <a href="../../../../jakarta/ws/rs/core/EntityPart.Builder.html#headers-jakarta.ws.rs.core.MultivaluedMap-"><code>headers(MultivaluedMap)</code></a>
methods.
</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the entity type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - the object to be used as the content</dd>
<dd><code>type</code> - the generic type of this object which will be used when
selecting the appropriate
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>content</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../jakarta/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core">EntityPart</a>&nbsp;build()
throws java.lang.IllegalStateException,
java.io.IOException,
<a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></pre>
<div class="block">Builds a new EntityPart instance using the provided property values.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../jakarta/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core"><code>EntityPart</code></a> instance built from the provided property values.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the content was not specified or no
matching
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a>
was found.</dd>
<dd><code>java.io.IOException</code> - if the underlying
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a>
throws an <code>IOException</code></dd>
<dd><code><a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></code> - if the underlying
<a href="../../../../jakarta/ws/rs/ext/MessageBodyWriter.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyWriter</code></a>
throws a <code>WebApplicationException</code></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/ws/rs/core/EntityPart.html" title="interface in jakarta.ws.rs.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../jakarta/ws/rs/core/EntityTag.html" title="class in jakarta.ws.rs.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?jakarta/ws/rs/core/EntityPart.Builder.html" target="_top">Frames</a></li>
<li><a href="EntityPart.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>