Google Git
Sign in
apache / juneau-website / 76ce9020c16c0ae4269fba32c14a5b785abc1717 / . / content / site / apidocs-9.0.0 / org / apache / juneau / rest / mock / MockRestClient.Builder.html
blob: cd420f160a7e2c51a5704e37d6db6809d3008f0b [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>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MockRestClient.Builder (Apache Juneau 9.0.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.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="MockRestClient.Builder (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":10,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":10,"i147":10,"i148":10,"i149":10,"i150":10,"i151":10,"i152":10,"i153":10,"i154":10,"i155":10,"i156":10,"i157":10,"i158":10,"i159":10,"i160":10,"i161":10,"i162":10,"i163":10,"i164":10,"i165":10,"i166":10,"i167":10,"i168":10,"i169":10,"i170":10,"i171":10,"i172":10,"i173":10,"i174":10,"i175":10,"i176":10,"i177":10,"i178":10,"i179":10,"i180":10,"i181":10,"i182":10,"i183":10,"i184":10,"i185":10,"i186":10,"i187":10,"i188":10,"i189":10,"i190":10,"i191":10,"i192":10,"i193":10,"i194":10,"i195":10,"i196":10,"i197":10,"i198":10,"i199":10,"i200":10,"i201":10,"i202":10,"i203":10,"i204":10,"i205":10,"i206":10,"i207":10,"i208":10,"i209":10,"i210":10,"i211":10,"i212":10,"i213":10,"i214":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.html" title="class in org.apache.juneau.rest.mock"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/rest/mock/MockRestRequest.html" title="class in org.apache.juneau.rest.mock"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/rest/mock/MockRestClient.Builder.html" target="_top">Frames</a></li>
<li><a href="MockRestClient.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">org.apache.juneau.rest.mock</div>
<h2 title="Class MockRestClient.Builder" class="title">Class MockRestClient.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/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><a href="../../../../../org/apache/juneau/Context.Builder.html" title="class in org.apache.juneau">org.apache.juneau.Context.Builder</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html" title="class in org.apache.juneau">org.apache.juneau.BeanContextable.Builder</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">org.apache.juneau.rest.client.RestClient.Builder</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.rest.mock.MockRestClient.Builder</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.html" title="class in org.apache.juneau.rest.mock">MockRestClient</a></dd>
</dl>
<hr>
<br>
<pre>public static class <a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.html#line.408">MockRestClient.Builder</a>
extends <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></pre>
<div class="block">Builder class.</div>
</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#Builder--">Builder</a></span>()</code>
<div class="block">No-arg constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#accept-java.lang.String-">accept</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends an <c>Accept</c> header on this request.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#acceptCharset-java.lang.String-">acceptCharset</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Sets the value for the <c>Accept-Charset</c> request header on all requests.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#addBeanTypes--">addBeanTypes</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Add <js>"_type"</js> properties when needed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#addInterceptorFirst-org.apache.http.HttpRequestInterceptor-">addInterceptorFirst</a></span>(org.apache.http.HttpRequestInterceptor&nbsp;itcp)</code>
<div class="block">Adds this protocol interceptor to the head of the protocol processing list.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#addInterceptorFirst-org.apache.http.HttpResponseInterceptor-">addInterceptorFirst</a></span>(org.apache.http.HttpResponseInterceptor&nbsp;itcp)</code>
<div class="block">Adds this protocol interceptor to the head of the protocol processing list.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#addInterceptorLast-org.apache.http.HttpRequestInterceptor-">addInterceptorLast</a></span>(org.apache.http.HttpRequestInterceptor&nbsp;itcp)</code>
<div class="block">Adds this protocol interceptor to the tail of the protocol processing list.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#addInterceptorLast-org.apache.http.HttpResponseInterceptor-">addInterceptorLast</a></span>(org.apache.http.HttpResponseInterceptor&nbsp;itcp)</code>
<div class="block">Adds this protocol interceptor to the tail of the protocol processing list.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#addRootType--">addRootType</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Add type attribute to root nodes.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#annotations-java.lang.annotation.Annotation...-">annotations</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>...&nbsp;values)</code>
<div class="block">Defines annotations to apply to specific classes and methods.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#apply-org.apache.juneau.AnnotationWorkList-">apply</a></span>(<a href="../../../../../org/apache/juneau/AnnotationWorkList.html" title="class in org.apache.juneau">AnnotationWorkList</a>&nbsp;work)</code>
<div class="block">Applies a set of applied to this builder.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#applyAnnotations-java.lang.Class...-">applyAnnotations</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;fromClasses)</code>
<div class="block">Applies any of the various <ja>@XConfig</ja> annotations on the specified class to this context.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#applyAnnotations-java.lang.reflect.Method...-">applyAnnotations</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>...&nbsp;fromMethods)</code>
<div class="block">Applies any of the various <ja>@XConfig</ja> annotations on the specified method to this context.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#backoffManager-org.apache.http.client.BackoffManager-">backoffManager</a></span>(org.apache.http.client.BackoffManager&nbsp;backoffManager)</code>
<div class="block">Assigns <code>BackoffManager</code> instance.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#basicAuth-java.lang.String-int-java.lang.String-java.lang.String-">basicAuth</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host,
int&nbsp;port,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pw)</code>
<div class="block">Set up this client to use BASIC auth.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanClassVisibility-org.apache.juneau.Visibility-">beanClassVisibility</a></span>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</code>
<div class="block">Minimum bean class visibility.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanConstructorVisibility-org.apache.juneau.Visibility-">beanConstructorVisibility</a></span>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</code>
<div class="block">Minimum bean constructor visibility.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanContext-org.apache.juneau.BeanContext.Builder-">beanContext</a></span>(<a href="../../../../../org/apache/juneau/BeanContext.Builder.html" title="class in org.apache.juneau">BeanContext.Builder</a>&nbsp;value)</code>
<div class="block">Overrides the bean context builder.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanContext-org.apache.juneau.BeanContext-">beanContext</a></span>(<a href="../../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a>&nbsp;value)</code>
<div class="block">Specifies an already-instantiated bean context to use.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanDictionary-java.lang.Class...-">beanDictionary</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</code>
<div class="block">Bean dictionary.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanFieldVisibility-org.apache.juneau.Visibility-">beanFieldVisibility</a></span>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</code>
<div class="block">Minimum bean field visibility.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanInterceptor-java.lang.Class-java.lang.Class-">beanInterceptor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/swap/BeanInterceptor.html" title="class in org.apache.juneau.swap">BeanInterceptor</a>&lt;?&gt;&gt;&nbsp;value)</code>
<div class="block">Bean interceptor.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanMapPutReturnsOldValue--">beanMapPutReturnsOldValue</a></span>()</code>
<div class="block">BeanMap.put() returns old property value.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanMethodVisibility-org.apache.juneau.Visibility-">beanMethodVisibility</a></span>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</code>
<div class="block">Minimum bean method visibility.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanProperties-java.lang.Class-java.lang.String-">beanProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Bean property includes.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanProperties-java.util.Map-">beanProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</code>
<div class="block">Bean property includes.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanProperties-java.lang.String-java.lang.String-">beanProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Bean property includes.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-">beanPropertiesExcludes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Bean property excludes.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesExcludes-java.util.Map-">beanPropertiesExcludes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</code>
<div class="block">Bean property excludes.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesExcludes-java.lang.String-java.lang.String-">beanPropertiesExcludes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Bean property excludes.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesReadOnly-java.lang.Class-java.lang.String-">beanPropertiesReadOnly</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Read-only bean properties.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesReadOnly-java.util.Map-">beanPropertiesReadOnly</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</code>
<div class="block">Read-only bean properties.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesReadOnly-java.lang.String-java.lang.String-">beanPropertiesReadOnly</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Read-only bean properties.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesWriteOnly-java.lang.Class-java.lang.String-">beanPropertiesWriteOnly</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Write-only bean properties.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesWriteOnly-java.util.Map-">beanPropertiesWriteOnly</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</code>
<div class="block">Write-only bean properties.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beanPropertiesWriteOnly-java.lang.String-java.lang.String-">beanPropertiesWriteOnly</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</code>
<div class="block">Write-only bean properties.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beansRequireDefaultConstructor--">beansRequireDefaultConstructor</a></span>()</code>
<div class="block">Beans require no-arg constructors.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beansRequireSerializable--">beansRequireSerializable</a></span>()</code>
<div class="block">Beans require Serializable interface.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#beansRequireSettersForGetters--">beansRequireSettersForGetters</a></span>()</code>
<div class="block">Beans require setters for getters.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.html" title="class in org.apache.juneau.rest.mock">MockRestClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#build--">build</a></span>()</code>
<div class="block">Build the object.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#cache-org.apache.juneau.internal.Cache-">cache</a></span>(<a href="../../../../../org/apache/juneau/internal/Cache.html" title="class in org.apache.juneau.internal">Cache</a>&lt;<a href="../../../../../org/apache/juneau/utils/HashKey.html" title="class in org.apache.juneau.utils">HashKey</a>,? extends <a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>&gt;&nbsp;value)</code>
<div class="block">Specifies a cache to use for hashkey-based caching.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#callHandler-java.lang.Class-">callHandler</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/rest/client/RestCallHandler.html" title="interface in org.apache.juneau.rest.client">RestCallHandler</a>&gt;&nbsp;value)</code>
<div class="block">REST call handler class.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#clientVersion-java.lang.String-">clientVersion</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Sets the client version by setting the value for the <js>"Client-Version"</js> header.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#connectionBackoffStrategy-org.apache.http.client.ConnectionBackoffStrategy-">connectionBackoffStrategy</a></span>(org.apache.http.client.ConnectionBackoffStrategy&nbsp;connectionBackoffStrategy)</code>
<div class="block">Assigns <code>ConnectionBackoffStrategy</code> instance.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-">connectionManager</a></span>(org.apache.http.conn.HttpClientConnectionManager&nbsp;value)</code>
<div class="block">Assigns <code>HttpClientConnectionManager</code> instance.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#connectionManagerShared-boolean-">connectionManagerShared</a></span>(boolean&nbsp;shared)</code>
<div class="block">Defines the connection manager is to be shared by multiple client instances.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#connectionReuseStrategy-org.apache.http.ConnectionReuseStrategy-">connectionReuseStrategy</a></span>(org.apache.http.ConnectionReuseStrategy&nbsp;reuseStrategy)</code>
<div class="block">Assigns <code>ConnectionReuseStrategy</code> instance.</div>
</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#connectionTimeToLive-long-java.util.concurrent.TimeUnit-">connectionTimeToLive</a></span>(long&nbsp;connTimeToLive,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;connTimeToLiveTimeUnit)</code>
<div class="block">Sets maximum time to live for persistent connections.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#console-java.io.PrintStream-">console</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;value)</code>
<div class="block">Console print stream</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#contentDecoderRegistry-java.util.Map-">contentDecoderRegistry</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.http.client.entity.InputStreamFactory&gt;&nbsp;contentDecoderMap)</code>
<div class="block">Assigns a map of <code>InputStreamFactories</code> to be used for automatic content decompression.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#contentType-java.lang.String-">contentType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Sets the value for the <c>Content-Type</c> request header on all requests.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#contextPath-java.lang.String-">contextPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Identifies the context path for the REST resource.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#copy--">copy</a></span>()</code>
<div class="block">Copy creator.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#debug--">debug</a></span>()</code>
<div class="block">Sets the value for the <c>Debug</c> request header on all requests.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#debugOutputLines-int-">debugOutputLines</a></span>(int&nbsp;value)</code>
<div class="block"><i><l>Parser</l> configuration property:&emsp;</i> Debug output lines.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultAuthSchemeRegistry-org.apache.http.config.Lookup-">defaultAuthSchemeRegistry</a></span>(org.apache.http.config.Lookup&lt;org.apache.http.auth.AuthSchemeProvider&gt;&nbsp;authSchemeRegistry)</code>
<div class="block">Assigns default <code>AuthScheme</code> registry which will be used for request execution if not explicitly set in the client execution context.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultConnectionConfig-org.apache.http.config.ConnectionConfig-">defaultConnectionConfig</a></span>(org.apache.http.config.ConnectionConfig&nbsp;config)</code>
<div class="block">Assigns default <code>ConnectionConfig</code>.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultCookieSpecRegistry-org.apache.http.config.Lookup-">defaultCookieSpecRegistry</a></span>(org.apache.http.config.Lookup&lt;org.apache.http.cookie.CookieSpecProvider&gt;&nbsp;cookieSpecRegistry)</code>
<div class="block">Assigns default <code>CookieSpec</code> registry which will be used for request execution if not explicitly set in the client execution context.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultCookieStore-org.apache.http.client.CookieStore-">defaultCookieStore</a></span>(org.apache.http.client.CookieStore&nbsp;cookieStore)</code>
<div class="block">Assigns default <code>CookieStore</code> instance which will be used for request execution if not explicitly set in the client execution context.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultCredentialsProvider-org.apache.http.client.CredentialsProvider-">defaultCredentialsProvider</a></span>(org.apache.http.client.CredentialsProvider&nbsp;credentialsProvider)</code>
<div class="block">Assigns default <code>CredentialsProvider</code> instance which will be used for request execution if not explicitly set in the client execution context.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultRequestConfig-org.apache.http.client.config.RequestConfig-">defaultRequestConfig</a></span>(org.apache.http.client.config.RequestConfig&nbsp;config)</code>
<div class="block">Assigns default <code>RequestConfig</code> instance which will be used for request execution if not explicitly set in the client execution context.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#defaultSocketConfig-org.apache.http.config.SocketConfig-">defaultSocketConfig</a></span>(org.apache.http.config.SocketConfig&nbsp;config)</code>
<div class="block">Assigns default <code>SocketConfig</code>.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#detectLeaks--">detectLeaks</a></span>()</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Enable leak detection.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#detectRecursions--">detectRecursions</a></span>()</code>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Automatically detect POJO recursions.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#dictionaryOn-java.lang.Class-java.lang.Class...-">dictionaryOn</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</code>
<div class="block">Bean dictionary.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableAuthCaching--">disableAuthCaching</a></span>()</code>
<div class="block">Disables authentication scheme caching.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableAutomaticRetries--">disableAutomaticRetries</a></span>()</code>
<div class="block">Disables automatic request recovery and re-execution.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableBeansRequireSomeProperties--">disableBeansRequireSomeProperties</a></span>()</code>
<div class="block">Beans don't require at least one property.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableConnectionState--">disableConnectionState</a></span>()</code>
<div class="block">Disables connection state tracking.</div>
</td>
</tr>
<tr id="i68" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableContentCompression--">disableContentCompression</a></span>()</code>
<div class="block">Disables automatic content decompression.</div>
</td>
</tr>
<tr id="i69" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableCookieManagement--">disableCookieManagement</a></span>()</code>
<div class="block">Disables state (cookie) management.</div>
</td>
</tr>
<tr id="i70" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableIgnoreMissingSetters--">disableIgnoreMissingSetters</a></span>()</code>
<div class="block">Don't silently ignore missing setters.</div>
</td>
</tr>
<tr id="i71" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableIgnoreTransientFields--">disableIgnoreTransientFields</a></span>()</code>
<div class="block">Don't ignore transient fields.</div>
</td>
</tr>
<tr id="i72" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableIgnoreUnknownNullBeanProperties--">disableIgnoreUnknownNullBeanProperties</a></span>()</code>
<div class="block">Don't ignore unknown properties with null values.</div>
</td>
</tr>
<tr id="i73" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableInterfaceProxies--">disableInterfaceProxies</a></span>()</code>
<div class="block">Don't use interface proxies.</div>
</td>
</tr>
<tr id="i74" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#disableRedirectHandling--">disableRedirectHandling</a></span>()</code>
<div class="block">Disables automatic redirect handling.</div>
</td>
</tr>
<tr id="i75" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#errorCodes-java.util.function.Predicate-">errorCodes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;value)</code>
<div class="block">Errors codes predicate.</div>
</td>
</tr>
<tr id="i76" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#evictExpiredConnections--">evictExpiredConnections</a></span>()</code>
<div class="block">Makes this instance of <code>HttpClient</code> proactively evict expired connections from the connection pool using a background thread.</div>
</td>
</tr>
<tr id="i77" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#evictIdleConnections-long-java.util.concurrent.TimeUnit-">evictIdleConnections</a></span>(long&nbsp;maxIdleTime,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;maxIdleTimeUnit)</code>
<div class="block">Makes this instance of <code>HttpClient</code> proactively evict idle connections from the connection pool using a background thread.</div>
</td>
</tr>
<tr id="i78" class="altColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#example-java.lang.Class-java.lang.String-">example</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;pojoClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;json)</code>
<div class="block">POJO example.</div>
</td>
</tr>
<tr id="i79" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#example-java.lang.Class-T-">example</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;pojoClass,
T&nbsp;o)</code>
<div class="block">POJO example.</div>
</td>
</tr>
<tr id="i80" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#executorService-java.util.concurrent.ExecutorService-boolean-">executorService</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService,
boolean&nbsp;shutdownOnClose)</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Executor service.</div>
</td>
</tr>
<tr id="i81" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#findFluentSetters--">findFluentSetters</a></span>()</code>
<div class="block">Find fluent setters.</div>
</td>
</tr>
<tr id="i82" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#findFluentSetters-java.lang.Class-">findFluentSetters</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on)</code>
<div class="block">Find fluent setters.</div>
</td>
</tr>
<tr id="i83" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#formData-org.apache.http.NameValuePair...-">formData</a></span>(org.apache.http.NameValuePair...&nbsp;parts)</code>
<div class="block">Appends multiple form-data parameters to the request bodies of all URL-encoded form posts.</div>
</td>
</tr>
<tr id="i84" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#formData-java.lang.String-java.lang.String-">formData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends a form-data parameter to all request bodies.</div>
</td>
</tr>
<tr id="i85" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#formData-java.lang.String-java.util.function.Supplier-">formData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</code>
<div class="block">Appends a form-data parameter with a dynamic value to all request bodies.</div>
</td>
</tr>
<tr id="i86" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#header-java.lang.String-java.lang.String-">header</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends a header to all requests.</div>
</td>
</tr>
<tr id="i87" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#header-java.lang.String-java.util.function.Supplier-">header</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</code>
<div class="block">Appends a header to all requests using a dynamic value.</div>
</td>
</tr>
<tr id="i88" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#headers-org.apache.http.Header...-">headers</a></span>(org.apache.http.Header...&nbsp;parts)</code>
<div class="block">Appends multiple headers to all requests.</div>
</td>
</tr>
<tr id="i89" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#html--">html</a></span>()</code>
<div class="block">Convenience method for specifying HTML as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i90" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#htmlDoc--">htmlDoc</a></span>()</code>
<div class="block">Convenience method for specifying HTML DOC as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i91" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#htmlStrippedDoc--">htmlStrippedDoc</a></span>()</code>
<div class="block">Convenience method for specifying Stripped HTML DOC as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i92" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#httpClient-org.apache.http.impl.client.CloseableHttpClient-">httpClient</a></span>(org.apache.http.impl.client.CloseableHttpClient&nbsp;value)</code>
<div class="block">Sets the <code>HttpClient</code> to be used to handle all HTTP communications with the target server.</div>
</td>
</tr>
<tr id="i93" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#httpClientBuilder-org.apache.http.impl.client.HttpClientBuilder-">httpClientBuilder</a></span>(org.apache.http.impl.client.HttpClientBuilder&nbsp;value)</code>
<div class="block">Sets the <code>HttpClientBuilder</code> that will be used to create the <code>HttpClient</code> used by <a href="../../../../../org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>.</div>
</td>
</tr>
<tr id="i94" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-">httpProcessor</a></span>(org.apache.http.protocol.HttpProcessor&nbsp;httpprocessor)</code>
<div class="block">Assigns <code>HttpProcessor</code> instance.</div>
</td>
</tr>
<tr id="i95" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ignoreErrors--">ignoreErrors</a></span>()</code>
<div class="block">Ignore errors.</div>
</td>
</tr>
<tr id="i96" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ignoreInvocationExceptionsOnGetters--">ignoreInvocationExceptionsOnGetters</a></span>()</code>
<div class="block">Ignore invocation errors on getters.</div>
</td>
</tr>
<tr id="i97" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ignoreInvocationExceptionsOnSetters--">ignoreInvocationExceptionsOnSetters</a></span>()</code>
<div class="block">Ignore invocation errors on setters.</div>
</td>
</tr>
<tr id="i98" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ignoreRecursions--">ignoreRecursions</a></span>()</code>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Ignore recursion errors.</div>
</td>
</tr>
<tr id="i99" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ignoreUnknownBeanProperties--">ignoreUnknownBeanProperties</a></span>()</code>
<div class="block">Ignore unknown properties.</div>
</td>
</tr>
<tr id="i100" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ignoreUnknownEnumValues--">ignoreUnknownEnumValues</a></span>()</code>
<div class="block">Ignore unknown enum values.</div>
</td>
</tr>
<tr id="i101" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#impl-org.apache.juneau.Context-">impl</a></span>(<a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>&nbsp;value)</code>
<div class="block">Specifies a pre-instantiated bean for the <a href="../../../../../org/apache/juneau/Context.Builder.html#build--"><code>Context.Builder.build()</code></a> method to return.</div>
</td>
</tr>
<tr id="i102" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#implClass-java.lang.Class-java.lang.Class-">implClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;interfaceClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;implClass)</code>
<div class="block">Implementation classes.</div>
</td>
</tr>
<tr id="i103" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#implClasses-java.util.Map-">implClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&gt;&nbsp;values)</code>
<div class="block">Implementation classes.</div>
</td>
</tr>
<tr id="i104" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#initialDepth-int-">initialDepth</a></span>(int&nbsp;value)</code>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Initial depth.</div>
</td>
</tr>
<tr id="i105" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#interceptors-java.lang.Class...-">interceptors</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Call interceptors.</div>
</td>
</tr>
<tr id="i106" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#interceptors-java.lang.Object...-">interceptors</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;value)</code>
<div class="block">Call interceptors.</div>
</td>
</tr>
<tr id="i107" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#interfaceClass-java.lang.Class-java.lang.Class-">interfaceClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</code>
<div class="block">Identifies a class to be used as the interface class for the specified class and all subclasses.</div>
</td>
</tr>
<tr id="i108" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#interfaces-java.lang.Class...-">interfaces</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;value)</code>
<div class="block">Identifies a set of interfaces.</div>
</td>
</tr>
<tr id="i109" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#json--">json</a></span>()</code>
<div class="block">Convenience method for specifying JSON as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i110" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#keepAliveStrategy-org.apache.http.conn.ConnectionKeepAliveStrategy-">keepAliveStrategy</a></span>(org.apache.http.conn.ConnectionKeepAliveStrategy&nbsp;keepAliveStrategy)</code>
<div class="block">Assigns <code>ConnectionKeepAliveStrategy</code> instance.</div>
</td>
</tr>
<tr id="i111" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#keepHttpClientOpen--">keepHttpClientOpen</a></span>()</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Keep HttpClient open.</div>
</td>
</tr>
<tr id="i112" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#keepNullProperties--">keepNullProperties</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Don't trim null bean property values.</div>
</td>
</tr>
<tr id="i113" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#locale-java.util.Locale-">locale</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;value)</code>
<div class="block"><i><l>Context</l> configuration property:&emsp;</i> Locale.</div>
</td>
</tr>
<tr id="i114" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#logger-java.util.logging.Logger-">logger</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a>&nbsp;value)</code>
<div class="block">Logger.</div>
</td>
</tr>
<tr id="i115" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#logRequests-org.apache.juneau.DetailLevel-java.util.logging.Level-java.util.function.BiPredicate-">logRequests</a></span>(<a href="../../../../../org/apache/juneau/DetailLevel.html" title="enum in org.apache.juneau">DetailLevel</a>&nbsp;detail,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html?is-external=true" title="class or interface in java.util.logging">Level</a>&nbsp;level,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html?is-external=true" title="class or interface in java.util.function">BiPredicate</a>&lt;<a href="../../../../../org/apache/juneau/rest/client/RestRequest.html" title="class in org.apache.juneau.rest.client">RestRequest</a>,<a href="../../../../../org/apache/juneau/rest/client/RestResponse.html" title="class in org.apache.juneau.rest.client">RestResponse</a>&gt;&nbsp;test)</code>
<div class="block">Log requests.</div>
</td>
</tr>
<tr id="i116" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#logToConsole--">logToConsole</a></span>()</code>
<div class="block">Log to console.</div>
</td>
</tr>
<tr id="i117" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#marshall-org.apache.juneau.marshall.Marshall-">marshall</a></span>(<a href="../../../../../org/apache/juneau/marshall/Marshall.html" title="class in org.apache.juneau.marshall">Marshall</a>&nbsp;value)</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Marshall</div>
</td>
</tr>
<tr id="i118" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#marshalls-org.apache.juneau.marshall.Marshall...-">marshalls</a></span>(<a href="../../../../../org/apache/juneau/marshall/Marshall.html" title="class in org.apache.juneau.marshall">Marshall</a>...&nbsp;value)</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Marshalls</div>
</td>
</tr>
<tr id="i119" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#maxConnPerRoute-int-">maxConnPerRoute</a></span>(int&nbsp;maxConnPerRoute)</code>
<div class="block">Assigns maximum connection per route value.</div>
</td>
</tr>
<tr id="i120" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#maxConnTotal-int-">maxConnTotal</a></span>(int&nbsp;maxConnTotal)</code>
<div class="block">Assigns maximum total connection value.</div>
</td>
</tr>
<tr id="i121" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#maxDepth-int-">maxDepth</a></span>(int&nbsp;value)</code>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Max serialization depth.</div>
</td>
</tr>
<tr id="i122" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#maxIndent-int-">maxIndent</a></span>(int&nbsp;value)</code>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Maximum indentation.</div>
</td>
</tr>
<tr id="i123" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#mediaType-org.apache.juneau.http.header.MediaType-">mediaType</a></span>(<a href="../../../../../org/apache/juneau/http/header/MediaType.html" title="class in org.apache.juneau.http.header">MediaType</a>&nbsp;value)</code>
<div class="block">Appends the <c>Accept</c> and <c>Content-Type</c> headers on all requests made by this client.</div>
</td>
</tr>
<tr id="i124" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#mediaType-java.lang.String-">mediaType</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends the <c>Accept</c> and <c>Content-Type</c> headers on all requests made by this client.</div>
</td>
</tr>
<tr id="i125" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#msgPack--">msgPack</a></span>()</code>
<div class="block">Convenience method for specifying MessagePack as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i126" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#notBeanClasses-java.lang.Class...-">notBeanClasses</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</code>
<div class="block">Bean class exclusions.</div>
</td>
</tr>
<tr id="i127" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#notBeanPackages-java.lang.String...-">notBeanPackages</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;values)</code>
<div class="block">Bean package exclusions.</div>
</td>
</tr>
<tr id="i128" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#noTrace--">noTrace</a></span>()</code>
<div class="block">When called, <c>No-Trace: true</c> is added to requests.</div>
</td>
</tr>
<tr id="i129" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#oapiCollectionFormat-org.apache.juneau.httppart.HttpPartCollectionFormat-">oapiCollectionFormat</a></span>(<a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html" title="enum in org.apache.juneau.httppart">HttpPartCollectionFormat</a>&nbsp;value)</code>
<div class="block"><i><l>OpenApiCommon</l> configuration property:&emsp;</i> Default collection format for HTTP parts.</div>
</td>
</tr>
<tr id="i130" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#oapiFormat-org.apache.juneau.httppart.HttpPartFormat-">oapiFormat</a></span>(<a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html" title="enum in org.apache.juneau.httppart">HttpPartFormat</a>&nbsp;value)</code>
<div class="block"><i><l>OpenApiCommon</l> configuration property:&emsp;</i> Default OpenAPI format for HTTP parts.</div>
</td>
</tr>
<tr id="i131" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#openApi--">openApi</a></span>()</code>
<div class="block">Convenience method for specifying OpenAPI as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i132" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#paramFormat-org.apache.juneau.uon.ParamFormat-">paramFormat</a></span>(<a href="../../../../../org/apache/juneau/uon/ParamFormat.html" title="enum in org.apache.juneau.uon">ParamFormat</a>&nbsp;value)</code>
<div class="block"><i><l>UonSerializer</l> configuration property:&emsp;</i> Parameter format.</div>
</td>
</tr>
<tr id="i133" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#paramFormatPlain--">paramFormatPlain</a></span>()</code>
<div class="block"><i><l>UonSerializer</l> configuration property:&emsp;</i> Parameter format.</div>
</td>
</tr>
<tr id="i134" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#parser-java.lang.Class-">parser</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>&gt;&nbsp;value)</code>
<div class="block">Parser.</div>
</td>
</tr>
<tr id="i135" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#parser-org.apache.juneau.parser.Parser-">parser</a></span>(<a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>&nbsp;value)</code>
<div class="block">Parser.</div>
</td>
</tr>
<tr id="i136" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#parsers-java.lang.Class...-">parsers</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>&gt;...&nbsp;value)</code>
<div class="block">Parsers.</div>
</td>
</tr>
<tr id="i137" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#parsers-org.apache.juneau.parser.Parser...-">parsers</a></span>(<a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>...&nbsp;value)</code>
<div class="block">Parsers.</div>
</td>
</tr>
<tr id="i138" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#partParser-java.lang.Class-">partParser</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/httppart/HttpPartParser.html" title="interface in org.apache.juneau.httppart">HttpPartParser</a>&gt;&nbsp;value)</code>
<div class="block">Part parser.</div>
</td>
</tr>
<tr id="i139" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#partParser-org.apache.juneau.httppart.HttpPartParser-">partParser</a></span>(<a href="../../../../../org/apache/juneau/httppart/HttpPartParser.html" title="interface in org.apache.juneau.httppart">HttpPartParser</a>&nbsp;value)</code>
<div class="block">Part parser.</div>
</td>
</tr>
<tr id="i140" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#partSerializer-java.lang.Class-">partSerializer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/httppart/HttpPartSerializer.html" title="interface in org.apache.juneau.httppart">HttpPartSerializer</a>&gt;&nbsp;value)</code>
<div class="block">Part serializer.</div>
</td>
</tr>
<tr id="i141" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#partSerializer-org.apache.juneau.httppart.HttpPartSerializer-">partSerializer</a></span>(<a href="../../../../../org/apache/juneau/httppart/HttpPartSerializer.html" title="interface in org.apache.juneau.httppart">HttpPartSerializer</a>&nbsp;value)</code>
<div class="block">Part serializer.</div>
</td>
</tr>
<tr id="i142" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pathData-org.apache.http.NameValuePair...-">pathData</a></span>(org.apache.http.NameValuePair...&nbsp;parts)</code>
<div class="block">Sets multiple path parameters on all requests.</div>
</td>
</tr>
<tr id="i143" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pathData-java.lang.String-java.lang.String-">pathData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends a path parameter to all request bodies.</div>
</td>
</tr>
<tr id="i144" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pathData-java.lang.String-java.util.function.Supplier-">pathData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</code>
<div class="block">Sets a path parameter with a dynamic value to all request bodies.</div>
</td>
</tr>
<tr id="i145" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pathVars-java.util.Map-">pathVars</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</code>
<div class="block">Add resolved path variables to this client.</div>
</td>
</tr>
<tr id="i146" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pathVars-java.lang.String...-">pathVars</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;pairs)</code>
<div class="block">Add resolved path variables to this client.</div>
</td>
</tr>
<tr id="i147" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#plainText--">plainText</a></span>()</code>
<div class="block">Convenience method for specifying Plain Text as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i148" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pooled--">pooled</a></span>()</code>
<div class="block">When called, the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createConnectionManager--"><code>RestClient.Builder.createConnectionManager()</code></a> method will return a <code>PoolingHttpClientConnectionManager</code>
instead of a <code>BasicHttpClientConnectionManager</code>.</div>
</td>
</tr>
<tr id="i149" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#propertyNamer-java.lang.Class-java.lang.Class-">propertyNamer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>&gt;&nbsp;value)</code>
<div class="block">Bean property namer</div>
</td>
</tr>
<tr id="i150" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#propertyNamer-java.lang.Class-">propertyNamer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>&gt;&nbsp;value)</code>
<div class="block">Bean property namer</div>
</td>
</tr>
<tr id="i151" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#proxy-org.apache.http.HttpHost-">proxy</a></span>(org.apache.http.HttpHost&nbsp;proxy)</code>
<div class="block">Assigns default proxy value.</div>
</td>
</tr>
<tr id="i152" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#proxyAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">proxyAuthenticationStrategy</a></span>(org.apache.http.client.AuthenticationStrategy&nbsp;proxyAuthStrategy)</code>
<div class="block">Assigns <code>AuthenticationStrategy</code> instance for proxy authentication.</div>
</td>
</tr>
<tr id="i153" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#publicSuffixMatcher-org.apache.http.conn.util.PublicSuffixMatcher-">publicSuffixMatcher</a></span>(org.apache.http.conn.util.PublicSuffixMatcher&nbsp;publicSuffixMatcher)</code>
<div class="block">Assigns file containing public suffix matcher.</div>
</td>
</tr>
<tr id="i154" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#queryData-org.apache.http.NameValuePair...-">queryData</a></span>(org.apache.http.NameValuePair...&nbsp;parts)</code>
<div class="block">Appends multiple query parameters to the URI of all requests.</div>
</td>
</tr>
<tr id="i155" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#queryData-java.lang.String-java.lang.String-">queryData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Appends a query parameter to the URI.</div>
</td>
</tr>
<tr id="i156" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#queryData-java.lang.String-java.util.function.Supplier-">queryData</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</code>
<div class="block">Appends a query parameter with a dynamic value to the URI.</div>
</td>
</tr>
<tr id="i157" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#quoteChar-char-">quoteChar</a></span>(char&nbsp;value)</code>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Quote character.</div>
</td>
</tr>
<tr id="i158" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#redirectStrategy-org.apache.http.client.RedirectStrategy-">redirectStrategy</a></span>(org.apache.http.client.RedirectStrategy&nbsp;redirectStrategy)</code>
<div class="block">Assigns <code>RedirectStrategy</code> instance.</div>
</td>
</tr>
<tr id="i159" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#requestExecutor-org.apache.http.protocol.HttpRequestExecutor-">requestExecutor</a></span>(org.apache.http.protocol.HttpRequestExecutor&nbsp;requestExec)</code>
<div class="block">Assigns <code>HttpRequestExecutor</code> instance.</div>
</td>
</tr>
<tr id="i160" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#restBean-java.lang.Object-">restBean</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block">Specifies the <a href="../../../../../org/apache/juneau/rest/annotation/Rest.html" title="annotation in org.apache.juneau.rest.annotation"><code>Rest</code></a>-annotated bean class or instance to test against.</div>
</td>
</tr>
<tr id="i161" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#restContext-org.apache.juneau.rest.RestContext-">restContext</a></span>(<a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a>&nbsp;value)</code>
<div class="block">Specifies the <a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> created for the REST bean.</div>
</td>
</tr>
<tr id="i162" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#retryHandler-org.apache.http.client.HttpRequestRetryHandler-">retryHandler</a></span>(org.apache.http.client.HttpRequestRetryHandler&nbsp;retryHandler)</code>
<div class="block">Assigns <code>HttpRequestRetryHandler</code> instance.</div>
</td>
</tr>
<tr id="i163" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#rootUri-java.lang.Object-">rootUri</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Root URI.</div>
</td>
</tr>
<tr id="i164" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#routePlanner-org.apache.http.conn.routing.HttpRoutePlanner-">routePlanner</a></span>(org.apache.http.conn.routing.HttpRoutePlanner&nbsp;routePlanner)</code>
<div class="block">Assigns <code>HttpRoutePlanner</code> instance.</div>
</td>
</tr>
<tr id="i165" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#schemePortResolver-org.apache.http.conn.SchemePortResolver-">schemePortResolver</a></span>(org.apache.http.conn.SchemePortResolver&nbsp;schemePortResolver)</code>
<div class="block">Assigns <code>SchemePortResolver</code> instance.</div>
</td>
</tr>
<tr id="i166" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#serializer-java.lang.Class-">serializer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>&gt;&nbsp;value)</code>
<div class="block">Serializer.</div>
</td>
</tr>
<tr id="i167" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#serializer-org.apache.juneau.serializer.Serializer-">serializer</a></span>(<a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>&nbsp;value)</code>
<div class="block">Serializer.</div>
</td>
</tr>
<tr id="i168" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#serializers-java.lang.Class...-">serializers</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>&gt;...&nbsp;value)</code>
<div class="block">Serializers.</div>
</td>
</tr>
<tr id="i169" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#serializers-org.apache.juneau.serializer.Serializer...-">serializers</a></span>(<a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>...&nbsp;value)</code>
<div class="block">Serializers.</div>
</td>
</tr>
<tr id="i170" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#serviceUnavailableRetryStrategy-org.apache.http.client.ServiceUnavailableRetryStrategy-">serviceUnavailableRetryStrategy</a></span>(org.apache.http.client.ServiceUnavailableRetryStrategy&nbsp;serviceUnavailStrategy)</code>
<div class="block">Assigns <code>ServiceUnavailableRetryStrategy</code> instance.</div>
</td>
</tr>
<tr id="i171" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#servletPath-java.lang.String-">servletPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Identifies the servlet path for the REST resource.</div>
</td>
</tr>
<tr id="i172" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#simpleJson--">simpleJson</a></span>()</code>
<div class="block">Convenience method for specifying Simplified JSON as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i173" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#skipEmptyFormData--">skipEmptyFormData</a></span>()</code>
<div class="block">Skip empty form data.</div>
</td>
</tr>
<tr id="i174" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#skipEmptyFormData-boolean-">skipEmptyFormData</a></span>(boolean&nbsp;value)</code>
<div class="block">Skip empty form data.</div>
</td>
</tr>
<tr id="i175" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#skipEmptyHeaderData--">skipEmptyHeaderData</a></span>()</code>
<div class="block">Skip empty header data.</div>
</td>
</tr>
<tr id="i176" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#skipEmptyHeaderData-boolean-">skipEmptyHeaderData</a></span>(boolean&nbsp;value)</code>
<div class="block">Skip empty header data.</div>
</td>
</tr>
<tr id="i177" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#skipEmptyQueryData--">skipEmptyQueryData</a></span>()</code>
<div class="block">Skip empty query data.</div>
</td>
</tr>
<tr id="i178" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#skipEmptyQueryData-boolean-">skipEmptyQueryData</a></span>(boolean&nbsp;value)</code>
<div class="block">Skip empty query data.</div>
</td>
</tr>
<tr id="i179" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sortCollections--">sortCollections</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Sort arrays and collections alphabetically.</div>
</td>
</tr>
<tr id="i180" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sortMaps--">sortMaps</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Sort maps alphabetically.</div>
</td>
</tr>
<tr id="i181" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sortProperties--">sortProperties</a></span>()</code>
<div class="block">Sort bean properties.</div>
</td>
</tr>
<tr id="i182" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sortProperties-java.lang.Class...-">sortProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;on)</code>
<div class="block">Sort bean properties.</div>
</td>
</tr>
<tr id="i183" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sq--">sq</a></span>()</code>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Quote character.</div>
</td>
</tr>
<tr id="i184" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sslContext-javax.net.ssl.SSLContext-">sslContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl">SSLContext</a>&nbsp;sslContext)</code>
<div class="block">Assigns <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl"><code>SSLContext</code></a> instance.</div>
</td>
</tr>
<tr id="i185" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sslHostnameVerifier-javax.net.ssl.HostnameVerifier-">sslHostnameVerifier</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/HostnameVerifier.html?is-external=true" title="class or interface in javax.net.ssl">HostnameVerifier</a>&nbsp;hostnameVerifier)</code>
<div class="block">Assigns <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/HostnameVerifier.html?is-external=true" title="class or interface in javax.net.ssl"><code>HostnameVerifier</code></a> instance.</div>
</td>
</tr>
<tr id="i186" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#sslSocketFactory-org.apache.http.conn.socket.LayeredConnectionSocketFactory-">sslSocketFactory</a></span>(org.apache.http.conn.socket.LayeredConnectionSocketFactory&nbsp;sslSocketFactory)</code>
<div class="block">Assigns <code>LayeredConnectionSocketFactory</code> instance.</div>
</td>
</tr>
<tr id="i187" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#stopClass-java.lang.Class-java.lang.Class-">stopClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</code>
<div class="block">Identifies a stop class for the annotated class.</div>
</td>
</tr>
<tr id="i188" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#strict--">strict</a></span>()</code>
<div class="block"><i><l>Parser</l> configuration property:&emsp;</i> Strict mode.</div>
</td>
</tr>
<tr id="i189" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#suppressLogging--">suppressLogging</a></span>()</code>
<div class="block">Suppress logging on this client.</div>
</td>
</tr>
<tr id="i190" class="altColor">
<td class="colFirst"><code>&lt;T,S&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-">swap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;normalClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;S&gt;&nbsp;swappedClass,
<a href="../../../../../org/apache/juneau/utils/ThrowingFunction.html" title="interface in org.apache.juneau.utils">ThrowingFunction</a>&lt;T,S&gt;&nbsp;swapFunction)</code>
<div class="block">A shortcut for defining a <a href="../../../../../org/apache/juneau/swap/FunctionalSwap.html" title="class in org.apache.juneau.swap"><code>FunctionalSwap</code></a>.</div>
</td>
</tr>
<tr id="i191" class="rowColor">
<td class="colFirst"><code>&lt;T,S&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-org.apache.juneau.utils.ThrowingFunction-">swap</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;normalClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;S&gt;&nbsp;swappedClass,
<a href="../../../../../org/apache/juneau/utils/ThrowingFunction.html" title="interface in org.apache.juneau.utils">ThrowingFunction</a>&lt;T,S&gt;&nbsp;swapFunction,
<a href="../../../../../org/apache/juneau/utils/ThrowingFunction.html" title="interface in org.apache.juneau.utils">ThrowingFunction</a>&lt;S,T&gt;&nbsp;unswapFunction)</code>
<div class="block">A shortcut for defining a <a href="../../../../../org/apache/juneau/swap/FunctionalSwap.html" title="class in org.apache.juneau.swap"><code>FunctionalSwap</code></a>.</div>
</td>
</tr>
<tr id="i192" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#swaps-java.lang.Class...-">swaps</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</code>
<div class="block">Java object swaps.</div>
</td>
</tr>
<tr id="i193" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#targetAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">targetAuthenticationStrategy</a></span>(org.apache.http.client.AuthenticationStrategy&nbsp;targetAuthStrategy)</code>
<div class="block">Assigns <code>AuthenticationStrategy</code> instance for target host authentication.</div>
</td>
</tr>
<tr id="i194" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#timeZone-java.util.TimeZone-">timeZone</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;value)</code>
<div class="block"><i><l>Context</l> configuration property:&emsp;</i> TimeZone.</div>
</td>
</tr>
<tr id="i195" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#trimEmptyCollections--">trimEmptyCollections</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Trim empty lists and arrays.</div>
</td>
</tr>
<tr id="i196" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#trimEmptyMaps--">trimEmptyMaps</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Trim empty maps.</div>
</td>
</tr>
<tr id="i197" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#trimStringsOnRead--">trimStringsOnRead</a></span>()</code>
<div class="block"><i><l>Parser</l> configuration property:&emsp;</i> Trim parsed strings.</div>
</td>
</tr>
<tr id="i198" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#trimStringsOnWrite--">trimStringsOnWrite</a></span>()</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Trim strings.</div>
</td>
</tr>
<tr id="i199" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#type-java.lang.Class-">type</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>&gt;&nbsp;value)</code>
<div class="block">Associates a context class with this builder.</div>
</td>
</tr>
<tr id="i200" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#typeName-java.lang.Class-java.lang.String-">typeName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">An identifying name for this class.</div>
</td>
</tr>
<tr id="i201" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#typePropertyName-java.lang.Class-java.lang.String-">typePropertyName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Bean type property name.</div>
</td>
</tr>
<tr id="i202" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#typePropertyName-java.lang.String-">typePropertyName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Bean type property name.</div>
</td>
</tr>
<tr id="i203" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#uon--">uon</a></span>()</code>
<div class="block">Convenience method for specifying UON as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i204" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#uriContext-org.apache.juneau.UriContext-">uriContext</a></span>(<a href="../../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a>&nbsp;value)</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> URI context bean.</div>
</td>
</tr>
<tr id="i205" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#uriRelativity-org.apache.juneau.UriRelativity-">uriRelativity</a></span>(<a href="../../../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a>&nbsp;value)</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> URI relativity.</div>
</td>
</tr>
<tr id="i206" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#uriResolution-org.apache.juneau.UriResolution-">uriResolution</a></span>(<a href="../../../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a>&nbsp;value)</code>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> URI resolution.</div>
</td>
</tr>
<tr id="i207" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#urlEnc--">urlEnc</a></span>()</code>
<div class="block">Convenience method for specifying URL-Encoding as the marshalling transmission media type.</div>
</td>
</tr>
<tr id="i208" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#useEnumNames--">useEnumNames</a></span>()</code>
<div class="block">Use enum names.</div>
</td>
</tr>
<tr id="i209" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#useJavaBeanIntrospector--">useJavaBeanIntrospector</a></span>()</code>
<div class="block">Use Java Introspector.</div>
</td>
</tr>
<tr id="i210" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#userTokenHandler-org.apache.http.client.UserTokenHandler-">userTokenHandler</a></span>(org.apache.http.client.UserTokenHandler&nbsp;userTokenHandler)</code>
<div class="block">Assigns <code>UserTokenHandler</code> instance.</div>
</td>
</tr>
<tr id="i211" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#useSystemProperties--">useSystemProperties</a></span>()</code>
<div class="block">Use system properties when creating and configuring default implementations.</div>
</td>
</tr>
<tr id="i212" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#useWhitespace--">useWhitespace</a></span>()</code>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Use whitespace.</div>
</td>
</tr>
<tr id="i213" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#ws--">ws</a></span>()</code>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Use whitespace.</div>
</td>
</tr>
<tr id="i214" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#xml--">xml</a></span>()</code>
<div class="block">Convenience method for specifying XML as the marshalling transmission media type.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.client.RestClient.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.rest.client.<a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></h3>
<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#callHandler--">callHandler</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#callHandler-java.util.function.Consumer-">callHandler</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createCallHandler--">createCallHandler</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createConnectionManager--">createConnectionManager</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createFormData--">createFormData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createHeaderData--">createHeaderData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createHttpClient--">createHttpClient</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createHttpClientBuilder--">createHttpClientBuilder</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createParsers--">createParsers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createPartParser--">createPartParser</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createPartSerializer--">createPartSerializer</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createPathData--">createPathData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createQueryData--">createQueryData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createSerializers--">createSerializers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createUrlEncodingSerializer--">createUrlEncodingSerializer</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData--">formData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-java.util.function.Consumer-">formData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formDataDefault-org.apache.http.NameValuePair...-">formDataDefault</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#getRootUri--">getRootUri</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--">headers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers-java.util.function.Consumer-">headers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headersDefault-org.apache.http.Header...-">headersDefault</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpClientBuilder--">httpClientBuilder</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpClientBuilder-java.util.function.Consumer-">httpClientBuilder</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parsers--">parsers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parsers-java.util.function.Consumer-">parsers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partParser--">partParser</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partParser-java.util.function.Consumer-">partParser</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer--">partSerializer</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer-java.util.function.Consumer-">partSerializer</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData--">pathData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-java.util.function.Consumer-">pathData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathDataDefault-org.apache.http.NameValuePair...-">pathDataDefault</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData--">queryData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-java.util.function.Consumer-">queryData</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryDataDefault-org.apache.http.NameValuePair...-">queryDataDefault</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializers--">serializers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializers-java.util.function.Consumer-">serializers</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#universal--">universal</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#urlEncodingSerializer--">urlEncodingSerializer</a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#urlEncodingSerializer-java.util.function.Consumer-">urlEncodingSerializer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanContextable.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html" title="class in org.apache.juneau">BeanContextable.Builder</a></h3>
<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanContext--">beanContext</a>, <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanContext-java.util.function.Consumer-">beanContext</a>, <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#hashKey--">hashKey</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.Context.Builder">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.<a href="../../../../../org/apache/juneau/Context.Builder.html" title="class in org.apache.juneau">Context.Builder</a></h3>
<code><a href="../../../../../org/apache/juneau/Context.Builder.html#apply-java.lang.Class-java.util.function.Consumer-">apply</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#build-java.lang.Class-">build</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#canApply-org.apache.juneau.AnnotationWorkList-">canApply</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#debug-boolean-">debug</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#env-java.lang.String-">env</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#env-java.lang.String-T-">env</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#getApplied--">getApplied</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#getType--">getType</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#isDebug--">isDebug</a>, <a href="../../../../../org/apache/juneau/Context.Builder.html#registerBuilders-java.lang.Object...-">registerBuilders</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Builder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Builder</h4>
<pre>protected&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.421">Builder</a>()</pre>
<div class="block">No-arg constructor.
<p>
Provided so that this class can be easily subclassed.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.427">copy</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#copy--">Context.Builder</a></code></span></div>
<div class="block">Copy creator.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#copy--">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new mutable copy of this builder.</dd>
</dl>
</li>
</ul>
<a name="restBean-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restBean</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.437">restBean</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block">Specifies the <a href="../../../../../org/apache/juneau/rest/annotation/Rest.html" title="annotation in org.apache.juneau.rest.annotation"><code>Rest</code></a>-annotated bean class or instance to test against.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The <a href="../../../../../org/apache/juneau/rest/annotation/Rest.html" title="annotation in org.apache.juneau.rest.annotation"><code>Rest</code></a>-annotated bean class or instance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="restContext-org.apache.juneau.rest.RestContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restContext</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.448">restContext</a>(<a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest">RestContext</a>&nbsp;value)</pre>
<div class="block">Specifies the <a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> created for the REST bean.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The <a href="../../../../../org/apache/juneau/rest/RestContext.html" title="class in org.apache.juneau.rest"><code>RestContext</code></a> created for the REST bean.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="contextPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contextPath</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.474">contextPath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Identifies the context path for the REST resource.
<p>
This value is used to deconstruct the request URL and set the appropriate URL getters on the <code>HttpServletRequest</code>
object correctly.
<p>
Should either be a value such as <js>"/foo"</js> or an empty string.
<p>
The following fixes are applied to non-conforming strings.
<ul>
<li><jk>nulls</jk> and <js>"/"</js> are converted to empty strings.
<li>Trailing slashes are trimmed.
<li>Leading slash is added if needed.
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The context path.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="servletPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>servletPath</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.500">servletPath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Identifies the servlet path for the REST resource.
<p>
This value is used to deconstruct the request URL and set the appropriate URL getters on the <code>HttpServletRequest</code>
object correctly.
<p>
Should either be a value such as <js>"/foo"</js> or an empty string.
<p>
The following fixes are applied to non-conforming strings.
<ul>
<li><jk>nulls</jk> and <js>"/"</js> are converted to empty strings.
<li>Trailing slashes are trimmed.
<li>Leading slash is added if needed.
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The context path.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="pathVars-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathVars</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.551">pathVars</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</pre>
<div class="block">Add resolved path variables to this client.
<p>
Allows you to add resolved parent path variables when performing tests on child resource classes.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A parent class with a path variable.</jc>
<ja>@Rest</ja>(
path=<js>"/parent/{foo}"</js>,
children={
Child.<jk>class</jk>
}
)
<jk>public class</jk> Parent { ... }
<jc>// A child class that uses the parent path variable.</jc>
<ja>@Rest</ja>
<jk>public class</jk> Child {
<jk>@RestGet</jk>
<jk>public</jk> String get(<ja>@Path</ja>(<js>"foo"</js>) String <jv>foo</jv>) {
<jk>return</jk> <jv>foo</jv>;
}
}
</p>
<p class='bjava'>
<jc>// Test the method that uses the parent path variable.</jc>
MockRestClient
.<jsm>create</jsm>(Child.<jk>class</jk>)
.simpleJson()
.pathVars(<js>"foo"</js>,<js>"bar"</js>)
.build()
.get(<js>"/"</js>)
.run()
.assertStatus().asCode().is(200)
.assertContent().is(<js>"bar"</js>);
</p>
<review>Needs review</review></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The path variables.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/mock/MockServletRequest.html#pathVars-java.util.Map-"><code>MockServletRequest.pathVars(Map)</code></a></dd>
</dl>
</li>
</ul>
<a name="pathVars-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathVars</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.565">pathVars</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;pairs)</pre>
<div class="block">Add resolved path variables to this client.
<p>
Identical to <a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html#pathVars-java.util.Map-"><code>pathVars(Map)</code></a> but allows you to specify as a list of key/value pairs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pairs</code> - The key/value pairs. Must be an even number of parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="suppressLogging--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>suppressLogging</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.574">suppressLogging</a>()</pre>
<div class="block">Suppress logging on this client.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="debug--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debug</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.579">debug</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#debug--">RestClient.Builder</a></code></span></div>
<div class="block">Sets the value for the <c>Debug</c> request header on all requests.
<p>
This is a shortcut for calling <c>headerData().append(Debug.<jsm>of</jsm>(<jv>value</jv>))</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#debug--">debug</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.html" title="class in org.apache.juneau.rest.mock">MockRestClient</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.586">build</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#build--">Context.Builder</a></code></span></div>
<div class="block">Build the object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#build--">build</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The built object.</dd>
</dl>
</li>
</ul>
<a name="annotations-java.lang.annotation.Annotation...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>annotations</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.593">annotations</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>...&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#annotations-java.lang.annotation.Annotation...-">Context.Builder</a></code></span></div>
<div class="block">Defines annotations to apply to specific classes and methods.
<p>
Allows you to dynamically apply Juneau annotations typically applied directly to classes and methods.
Useful in cases where you want to use the functionality of the annotation on beans and bean properties but
do not have access to the code to do so.
<p>
As a rule, any Juneau annotation with an <l>on()</l> method can be used with this setting.
<p>
The following example shows the equivalent methods for applying the <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation:
<p class='bjava'>
<jc>// Class with explicit annotation.</jc>
<ja>@Bean</ja>(properties=<js>"street,city,state"</js>)
<jk>public class</jk> A {...}
<jc>// Class with annotation applied via @BeanConfig</jc>
<jk>public class</jk> B {...}
<jc>// Java REST method with @BeanConfig annotation.</jc>
<ja>@RestGet</ja>(...)
<ja>@Bean</ja>(on=<js>"B"</js>, properties=<js>"street,city,state"</js>)
<jk>public void</jk> doFoo() {...}
</p>
<p>
In general, the underlying framework uses this method when it finds dynamically applied annotations on
config annotations. However, concrete implementations of annotations are also provided that can be passed
directly into builder classes like so:
<p class='bjava'>
<jc>// Create a concrete @Bean annotation.</jc>
<ja>Bean</ja> <jv>annotation</jv> = BeanAnnotation.<jsm>create</jsm>(B.<jk>class</jk>).properties(<js>"street,city,state"</js>).build();
<jc>// Apply it to a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer.<jsm>create</jsm>().annotations(<jv>annotation</jv>).build();
<jc>// Serialize a bean with the dynamically applied annotation.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> B());
</p>
<p>
The following is the list of annotations builders provided that can be constructed
and passed into the builder class:
<ul class='javatreec'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanAnnotation.html" title="class in org.apache.juneau.annotation"><code>BeanAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeancAnnotation.html" title="class in org.apache.juneau.annotation"><code>BeancAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanIgnoreAnnotation.html" title="class in org.apache.juneau.annotation"><code>BeanIgnoreAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanpAnnotation.html" title="class in org.apache.juneau.annotation"><code>BeanpAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/ExampleAnnotation.html" title="class in org.apache.juneau.annotation"><code>ExampleAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/NamePropertyAnnotation.html" title="class in org.apache.juneau.annotation"><code>NamePropertyAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/ParentPropertyAnnotation.html" title="class in org.apache.juneau.annotation"><code>ParentPropertyAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/SwapAnnotation.html" title="class in org.apache.juneau.annotation"><code>SwapAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/UriAnnotation.html" title="class in org.apache.juneau.annotation"><code>UriAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/csv/annotation/CsvAnnotation.html" title="class in org.apache.juneau.csv.annotation"><code>CsvAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/html/annotation/HtmlAnnotation.html" title="class in org.apache.juneau.html.annotation"><code>HtmlAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/json/annotation/JsonAnnotation.html" title="class in org.apache.juneau.json.annotation"><code>JsonAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/http/annotation/SchemaAnnotation.html" title="class in org.apache.juneau.http.annotation"><code>SchemaAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/msgpack/annotation/MsgPackAnnotation.html" title="class in org.apache.juneau.msgpack.annotation"><code>MsgPackAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiAnnotation.html" title="class in org.apache.juneau.oapi.annotation"><code>OpenApiAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/plaintext/annotation/PlainTextAnnotation.html" title="class in org.apache.juneau.plaintext.annotation"><code>PlainTextAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/soap/annotation/SoapXmlAnnotation.html" title="class in org.apache.juneau.soap.annotation"><code>SoapXmlAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/uon/annotation/UonAnnotation.html" title="class in org.apache.juneau.uon.annotation"><code>UonAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/urlencoding/annotation/UrlEncodingAnnotation.html" title="class in org.apache.juneau.urlencoding.annotation"><code>UrlEncodingAnnotation</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/xml/annotation/XmlAnnotation.html" title="class in org.apache.juneau.xml.annotation"><code>XmlAnnotation</code></a>
</ul>
<p>
The syntax for the <l>on()</l> pattern match parameter depends on whether it applies to a class, method, field, or constructor.
The valid pattern matches are:
<ul class='spaced-list'>
<li>Classes:
<ul>
<li>Fully qualified:
<ul>
<li><js>"com.foo.MyClass"</js>
</ul>
<li>Fully qualified inner class:
<ul>
<li><js>"com.foo.MyClass$Inner1$Inner2"</js>
</ul>
<li>Simple:
<ul>
<li><js>"MyClass"</js>
</ul>
<li>Simple inner:
<ul>
<li><js>"MyClass$Inner1$Inner2"</js>
<li><js>"Inner1$Inner2"</js>
<li><js>"Inner2"</js>
</ul>
</ul>
<li>Methods:
<ul>
<li>Fully qualified with args:
<ul>
<li><js>"com.foo.MyClass.myMethod(String,int)"</js>
<li><js>"com.foo.MyClass.myMethod(java.lang.String,int)"</js>
<li><js>"com.foo.MyClass.myMethod()"</js>
</ul>
<li>Fully qualified:
<ul>
<li><js>"com.foo.MyClass.myMethod"</js>
</ul>
<li>Simple with args:
<ul>
<li><js>"MyClass.myMethod(String,int)"</js>
<li><js>"MyClass.myMethod(java.lang.String,int)"</js>
<li><js>"MyClass.myMethod()"</js>
</ul>
<li>Simple:
<ul>
<li><js>"MyClass.myMethod"</js>
</ul>
<li>Simple inner class:
<ul>
<li><js>"MyClass$Inner1$Inner2.myMethod"</js>
<li><js>"Inner1$Inner2.myMethod"</js>
<li><js>"Inner2.myMethod"</js>
</ul>
</ul>
<li>Fields:
<ul>
<li>Fully qualified:
<ul>
<li><js>"com.foo.MyClass.myField"</js>
</ul>
<li>Simple:
<ul>
<li><js>"MyClass.myField"</js>
</ul>
<li>Simple inner class:
<ul>
<li><js>"MyClass$Inner1$Inner2.myField"</js>
<li><js>"Inner1$Inner2.myField"</js>
<li><js>"Inner2.myField"</js>
</ul>
</ul>
<li>Constructors:
<ul>
<li>Fully qualified with args:
<ul>
<li><js>"com.foo.MyClass(String,int)"</js>
<li><js>"com.foo.MyClass(java.lang.String,int)"</js>
<li><js>"com.foo.MyClass()"</js>
</ul>
<li>Simple with args:
<ul>
<li><js>"MyClass(String,int)"</js>
<li><js>"MyClass(java.lang.String,int)"</js>
<li><js>"MyClass()"</js>
</ul>
<li>Simple inner class:
<ul>
<li><js>"MyClass$Inner1$Inner2()"</js>
<li><js>"Inner1$Inner2()"</js>
<li><js>"Inner2()"</js>
</ul>
</ul>
<li>A comma-delimited list of anything on this list.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html" title="annotation in org.apache.juneau.annotation"><code>BeanConfig</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#annotations-java.lang.annotation.Annotation...-">annotations</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The annotations to register with the context.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="apply-org.apache.juneau.AnnotationWorkList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>apply</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.599">apply</a>(<a href="../../../../../org/apache/juneau/AnnotationWorkList.html" title="class in org.apache.juneau">AnnotationWorkList</a>&nbsp;work)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#apply-org.apache.juneau.AnnotationWorkList-">Context.Builder</a></code></span></div>
<div class="block">Applies a set of applied to this builder.
<p>
An <a href="../../../../../org/apache/juneau/AnnotationWork.html" title="class in org.apache.juneau"><code>AnnotationWork</code></a> consists of a single pair of <a href="../../../../../org/apache/juneau/reflect/AnnotationInfo.html" title="class in org.apache.juneau.reflect"><code>AnnotationInfo</code></a> that represents an annotation instance,
and <a href="../../../../../org/apache/juneau/AnnotationApplier.html" title="class in org.apache.juneau"><code>AnnotationApplier</code></a> which represents the code used to apply the values in that annotation to a specific builder.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A class annotated with a config annotation.</jc>
<ja>@BeanConfig</ja>(sortProperties=<js>"$S{sortProperties,false}"</js>)
<jk>public class</jk> MyClass {...}
<jc>// Find all annotations that themselves are annotated with @ContextPropertiesApply.</jc>
AnnotationList <jv>annotations</jv> = ClassInfo.<jsm>of</jsm>(MyClass.<jk>class</jk>).getAnnotationList(<jsf>CONTEXT_APPLY_FILTER</jsf>);
VarResolverSession <jv>vrs</jv> = VarResolver.<jsf>DEFAULT</jsf>.createSession();
AnnotationWorkList <jv>work</jv> = AnnotationWorkList.of(<jv>vrs</jv>, <jv>annotations</jv>);
<jc>// Apply any settings found on the annotations.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.apply(<jv>work</jv>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#apply-org.apache.juneau.AnnotationWorkList-">apply</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>work</code> - The list of annotations and appliers to apply to this builder.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="applyAnnotations-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyAnnotations</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.605">applyAnnotations</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;fromClasses)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#applyAnnotations-java.lang.Class...-">Context.Builder</a></code></span></div>
<div class="block">Applies any of the various <ja>@XConfig</ja> annotations on the specified class to this context.
<p>
Any annotations found that themselves are annotated with <a href="../../../../../org/apache/juneau/annotation/ContextApply.html" title="annotation in org.apache.juneau.annotation"><code>ContextApply</code></a> will be resolved and
applied as properties to this builder. These annotations include:
<ul class='javatreec'>
<li class ='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html" title="annotation in org.apache.juneau.annotation"><code>BeanConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/csv/annotation/CsvConfig.html" title="annotation in org.apache.juneau.csv.annotation"><code>CsvConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/html/annotation/HtmlConfig.html" title="annotation in org.apache.juneau.html.annotation"><code>HtmlConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/html/annotation/HtmlDocConfig.html" title="annotation in org.apache.juneau.html.annotation"><code>HtmlDocConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/json/annotation/JsonConfig.html" title="annotation in org.apache.juneau.json.annotation"><code>JsonConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/jsonschema/annotation/JsonSchemaConfig.html" title="annotation in org.apache.juneau.jsonschema.annotation"><code>JsonSchemaConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/msgpack/annotation/MsgPackConfig.html" title="annotation in org.apache.juneau.msgpack.annotation"><code>MsgPackConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfig.html" title="annotation in org.apache.juneau.oapi.annotation"><code>OpenApiConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/parser/annotation/ParserConfig.html" title="annotation in org.apache.juneau.parser.annotation"><code>ParserConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/plaintext/annotation/PlainTextConfig.html" title="annotation in org.apache.juneau.plaintext.annotation"><code>PlainTextConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/serializer/annotation/SerializerConfig.html" title="annotation in org.apache.juneau.serializer.annotation"><code>SerializerConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/soap/annotation/SoapXmlConfig.html" title="annotation in org.apache.juneau.soap.annotation"><code>SoapXmlConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/uon/annotation/UonConfig.html" title="annotation in org.apache.juneau.uon.annotation"><code>UonConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/urlencoding/annotation/UrlEncodingConfig.html" title="annotation in org.apache.juneau.urlencoding.annotation"><code>UrlEncodingConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html" title="annotation in org.apache.juneau.xml.annotation"><code>XmlConfig</code></a>
<li class ='ja'><c>RdfConfig</c>
</ul>
<p>
Annotations on classes are appended in the following order:
<ol>
<li>On the package of this class.
<li>On interfaces ordered parent-to-child.
<li>On parent classes ordered parent-to-child.
<li>On this class.
</ol>
<p>
The default var resolver <a href="../../../../../org/apache/juneau/svl/VarResolver.html#DEFAULT"><code>VarResolver.DEFAULT</code></a> is used to resolve any variables in annotation field values.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A class annotated with a config annotation.</jc>
<ja>@BeanConfig</ja>(sortProperties=<js>"$S{sortProperties,false}"</js>)
<jk>public class</jk> MyClass {...}
<jc>// Apply any settings found on the annotations.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.applyAnnotations(MyClass.<jk>class</jk>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#applyAnnotations-java.lang.Class...-">applyAnnotations</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromClasses</code> - The classes on which the annotations are defined.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="applyAnnotations-java.lang.reflect.Method...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyAnnotations</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.611">applyAnnotations</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect">Method</a>...&nbsp;fromMethods)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#applyAnnotations-java.lang.reflect.Method...-">Context.Builder</a></code></span></div>
<div class="block">Applies any of the various <ja>@XConfig</ja> annotations on the specified method to this context.
<p>
Any annotations found that themselves are annotated with <a href="../../../../../org/apache/juneau/annotation/ContextApply.html" title="annotation in org.apache.juneau.annotation"><code>ContextApply</code></a> will be resolved and
applied as properties to this builder. These annotations include:
<ul class='javatreec'>
<li class ='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html" title="annotation in org.apache.juneau.annotation"><code>BeanConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/csv/annotation/CsvConfig.html" title="annotation in org.apache.juneau.csv.annotation"><code>CsvConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/html/annotation/HtmlConfig.html" title="annotation in org.apache.juneau.html.annotation"><code>HtmlConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/html/annotation/HtmlDocConfig.html" title="annotation in org.apache.juneau.html.annotation"><code>HtmlDocConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/json/annotation/JsonConfig.html" title="annotation in org.apache.juneau.json.annotation"><code>JsonConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/jsonschema/annotation/JsonSchemaConfig.html" title="annotation in org.apache.juneau.jsonschema.annotation"><code>JsonSchemaConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/msgpack/annotation/MsgPackConfig.html" title="annotation in org.apache.juneau.msgpack.annotation"><code>MsgPackConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/oapi/annotation/OpenApiConfig.html" title="annotation in org.apache.juneau.oapi.annotation"><code>OpenApiConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/parser/annotation/ParserConfig.html" title="annotation in org.apache.juneau.parser.annotation"><code>ParserConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/plaintext/annotation/PlainTextConfig.html" title="annotation in org.apache.juneau.plaintext.annotation"><code>PlainTextConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/serializer/annotation/SerializerConfig.html" title="annotation in org.apache.juneau.serializer.annotation"><code>SerializerConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/soap/annotation/SoapXmlConfig.html" title="annotation in org.apache.juneau.soap.annotation"><code>SoapXmlConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/uon/annotation/UonConfig.html" title="annotation in org.apache.juneau.uon.annotation"><code>UonConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/urlencoding/annotation/UrlEncodingConfig.html" title="annotation in org.apache.juneau.urlencoding.annotation"><code>UrlEncodingConfig</code></a>
<li class ='ja'><a href="../../../../../org/apache/juneau/xml/annotation/XmlConfig.html" title="annotation in org.apache.juneau.xml.annotation"><code>XmlConfig</code></a>
<li class ='ja'><c>RdfConfig</c>
</ul>
<p>
Annotations on methods are appended in the following order:
<ol>
<li>On the package of the method class.
<li>On interfaces ordered parent-to-child.
<li>On parent classes ordered parent-to-child.
<li>On the method class.
<li>On this method and matching methods ordered parent-to-child.
</ol>
<p>
The default var resolver <a href="../../../../../org/apache/juneau/svl/VarResolver.html#DEFAULT"><code>VarResolver.DEFAULT</code></a> is used to resolve any variables in annotation field values.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A method annotated with a config annotation.</jc>
<jk>public class</jk> MyClass {
<ja>@BeanConfig</ja>(sortProperties=<js>"$S{sortProperties,false}"</js>)
<jk>public void</jk> myMethod() {...}
}
<jc>// Apply any settings found on the annotations.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.applyAnnotations(MyClass.<jk>class</jk>.getMethod(<js>"myMethod"</js>))
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#applyAnnotations-java.lang.reflect.Method...-">applyAnnotations</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromMethods</code> - The methods on which the annotations are defined.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="cache-org.apache.juneau.internal.Cache-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cache</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.617">cache</a>(<a href="../../../../../org/apache/juneau/internal/Cache.html" title="class in org.apache.juneau.internal">Cache</a>&lt;<a href="../../../../../org/apache/juneau/utils/HashKey.html" title="class in org.apache.juneau.utils">HashKey</a>,? extends <a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#cache-org.apache.juneau.internal.Cache-">Context.Builder</a></code></span></div>
<div class="block">Specifies a cache to use for hashkey-based caching.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#cache-org.apache.juneau.internal.Cache-">cache</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The cache.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="impl-org.apache.juneau.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>impl</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.623">impl</a>(<a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#impl-org.apache.juneau.Context-">Context.Builder</a></code></span></div>
<div class="block">Specifies a pre-instantiated bean for the <a href="../../../../../org/apache/juneau/Context.Builder.html#build--"><code>Context.Builder.build()</code></a> method to return.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#impl-org.apache.juneau.Context-">impl</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="type-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.629">type</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/Context.Builder.html#type-java.lang.Class-">Context.Builder</a></code></span></div>
<div class="block">Associates a context class with this builder.
<p>
This is the type of object that this builder creates when the <a href="../../../../../org/apache/juneau/Context.Builder.html#build--"><code>Context.Builder.build()</code></a> method is called.
<p>
By default, it's the outer class of where the builder class is defined.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#type-java.lang.Class-">type</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The context class that this builder should create.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanClassVisibility-org.apache.juneau.Visibility-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanClassVisibility</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.635">beanClassVisibility</a>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanClassVisibility-org.apache.juneau.Visibility-">BeanContextable.Builder</a></code></span></div>
<div class="block">Minimum bean class visibility.
<p>
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is <jsf>PUBLIC</jsf> and the bean class is <jk>protected</jk>, then the class
will not be interpreted as a bean class and be serialized as a string.
Use this setting to reduce the visibility requirement.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a protected class and one field.</jc>
<jk>protected class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Create a serializer that's capable of serializing the class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanClassVisibility(<jsf>PROTECTED</jsf>)
.build();
<jc>// Produces: {"foo","bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a non-public bean class to override this setting.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on a public bean class to ignore it as a bean.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beanClassVisibility--"><code>BeanConfig.beanClassVisibility()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanClassVisibility-org.apache.juneau.Visibility-">beanClassVisibility</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanConstructorVisibility-org.apache.juneau.Visibility-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanConstructorVisibility</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.641">beanConstructorVisibility</a>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanConstructorVisibility-org.apache.juneau.Visibility-">BeanContextable.Builder</a></code></span></div>
<div class="block">Minimum bean constructor visibility.
<p>
Only look for constructors with the specified minimum visibility.
<p>
This setting affects the logic for finding no-arg constructors for bean. Normally, only <jk>public</jk> no-arg
constructors are used. Use this setting if you want to reduce the visibility requirement.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a protected constructor and one field.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>;
<jk>protected</jk> MyBean() {}
}
<jc>// Create a parser capable of calling the protected constructor.</jc>
ReaderParser <jv>parser</jv> = ReaderParser
.<jsm>create</jsm>()
.beanConstructorVisibility(<jsf>PROTECTED</jsf>)
.build();
<jc>// Use it.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'bar'}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Beanc.html" title="annotation in org.apache.juneau.annotation"><code>@Beanc</code></a> annotation can also be used to expose a non-public constructor.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on a public bean constructor to ignore it.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beanConstructorVisibility--"><code>BeanConfig.beanConstructorVisibility()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanConstructorVisibility-org.apache.juneau.Visibility-">beanConstructorVisibility</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanContext-org.apache.juneau.BeanContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanContext</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.647">beanContext</a>(<a href="../../../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanContext-org.apache.juneau.BeanContext-">BeanContextable.Builder</a></code></span></div>
<div class="block">Specifies an already-instantiated bean context to use.
<p>
Provides an optimization for cases where serializers and parsers can use an existing
bean context without having to go through <c><jv>beanContext</jv>.copy().build()</c>.
An example is <a href="../../../../../org/apache/juneau/BeanContext.html#getBeanToStringSerializer--"><code>BeanContext.getBeanToStringSerializer()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanContext-org.apache.juneau.BeanContext-">beanContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The bean context to use.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanContext-org.apache.juneau.BeanContext.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanContext</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.653">beanContext</a>(<a href="../../../../../org/apache/juneau/BeanContext.Builder.html" title="class in org.apache.juneau">BeanContext.Builder</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanContext-org.apache.juneau.BeanContext.Builder-">BeanContextable.Builder</a></code></span></div>
<div class="block">Overrides the bean context builder.
<p>
Used when sharing bean context builders across multiple context objects.
For example, <a href="../../../../../org/apache/juneau/jsonschema/JsonSchemaGenerator.Builder.html" title="class in org.apache.juneau.jsonschema"><code>JsonSchemaGenerator.Builder</code></a> uses this to apply common bean settings with the JSON
serializer and parser.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanContext-org.apache.juneau.BeanContext.Builder-">beanContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanDictionary-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanDictionary</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.659">beanDictionary</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanDictionary-java.lang.Class...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean dictionary.
<p>
The list of classes that make up the bean dictionary in this bean context.
<p>
Values are prepended to the list so that later calls can override classes of earlier calls.
<p>
A dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred
through reflection. The names are defined through the <a href="../../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>@Bean(typeName)</code></a> annotation defined
on the bean class. For example, if a class <c>Foo</c> has a type-name of <js>"myfoo"</js>, then it would end up
serialized as <js>"{_type:'myfoo',...}"</js> in JSON
or <js>"&lt;myfoo&gt;...&lt;/myfoo&gt;"</js> in XML.
<p>
This setting tells the parsers which classes to look for when resolving <js>"_type"</js> attributes.
<p>
Values can consist of any of the following types:
<ul>
<li>Any bean class that specifies a value for <a href="../../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>@Bean(typeName)</code></a>.
<li>Any subclass of <a href="../../../../../org/apache/juneau/BeanDictionaryList.html" title="class in org.apache.juneau"><code>BeanDictionaryList</code></a> containing a collection of bean classes with type name annotations.
<li>Any subclass of <a href="../../../../../org/apache/juneau/BeanDictionaryMap.html" title="class in org.apache.juneau"><code>BeanDictionaryMap</code></a> containing a mapping of type names to classes without type name annotations.
<li>Any array or collection of the objects above.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// POJOs with @Bean(name) annotations.</jc>
<ja>@Bean</ja>(typeName=<js>"foo"</js>)
<jk>public class</jk> Foo {...}
<ja>@Bean</ja>(typeName=<js>"bar"</js>)
<jk>public class</jk> Bar {...}
<jc>// Create a parser and tell it which classes to try to resolve.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.dictionary(Foo.<jk>class</jk>, Bar.<jk>class</jk>)
.addBeanTypes()
.build();
<jc>// A bean with a field with an indeterminate type.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> Object <jf>mySimpleField</jf>;
}
<jc>// Parse bean.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{mySimpleField:{_type:'foo',...}}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
Another option is to use the <a href="../../../../../org/apache/juneau/annotation/Bean.html#dictionary--"><code>Bean.dictionary()</code></a> annotation on the POJO class itself:
<p class='bjava'>
<jc>// Instead of by parser, define a bean dictionary on a class through an annotation.</jc>
<jc>// This applies to all properties on this class and all subclasses.</jc>
<ja>@Bean</ja>(dictionary={Foo.<jk>class</jk>,Bar.<jk>class</jk>})
<jk>public class</jk> MyBean {
<jk>public</jk> Object <jf>mySimpleField</jf>; <jc>// May contain Foo or Bar object.</jc>
<jk>public</jk> Map&lt;String,Object&gt; <jf>myMapField</jf>; <jc>// May contain Foo or Bar objects.</jc>
}
</p>
<p>
A typical usage is to allow for HTML documents to be parsed back into HTML beans:
<p class='bjava'>
<jc>// Use the predefined HTML5 bean dictionary which is a BeanDictionaryList.</jc>
ReaderParser <jv>parser</jv> = HtmlParser
.<jsm>create</jsm>()
.dictionary(HtmlBeanDictionary.<jk>class</jk>)
.build();
<jc>// Parse an HTML body into HTML beans.</jc>
Body <jv>body</jv> = <jv>parser</jv>.parse(<js>"&lt;body&gt;&lt;ul&gt;&lt;li&gt;foo&lt;/li&gt;&lt;li&gt;bar&lt;/li&gt;&lt;/ul&gt;"</js>, Body.<jk>class</jk>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#dictionary--"><code>Bean.dictionary()</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Beanp.html#dictionary--"><code>Beanp.dictionary()</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#dictionary--"><code>BeanConfig.dictionary()</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#dictionary_replace--"><code>BeanConfig.dictionary_replace()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanDictionary-java.lang.Class...-">beanDictionary</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanFieldVisibility-org.apache.juneau.Visibility-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanFieldVisibility</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.665">beanFieldVisibility</a>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanFieldVisibility-org.apache.juneau.Visibility-">BeanContextable.Builder</a></code></span></div>
<div class="block">Minimum bean field visibility.
<p>
Only look for bean fields with the specified minimum visibility.
<p>
This affects which fields on a bean class are considered bean properties. Normally only <jk>public</jk> fields are considered.
Use this setting if you want to reduce the visibility requirement.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a protected field.</jc>
<jk>public class</jk> MyBean {
<jk>protected</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Create a serializer that recognizes the protected field.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFieldVisibility(<jsf>PROTECTED</jsf>)
.build();
<jc>// Produces: {"foo":"bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
Bean fields can be ignored as properties entirely by setting the value to <a href="../../../../../org/apache/juneau/Visibility.html#NONE"><code>Visibility.NONE</code></a>
<p class='bjava'>
<jc>// Disable using fields as properties entirely.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFieldVisibility(<jsf>NONE</jsf>)
.build();
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation"><code>@Beanp</code></a> annotation can also be used to expose a non-public field.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on a public bean field to ignore it as a bean property.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beanFieldVisibility--"><code>BeanConfig.beanFieldVisibility()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanFieldVisibility-org.apache.juneau.Visibility-">beanFieldVisibility</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanInterceptor-java.lang.Class-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanInterceptor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.671">beanInterceptor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/swap/BeanInterceptor.html" title="class in org.apache.juneau.swap">BeanInterceptor</a>&lt;?&gt;&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanInterceptor-java.lang.Class-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean interceptor.
<p>
Bean interceptors can be used to intercept calls to getters and setters and alter their values in transit.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Interceptor that strips out sensitive information.</jc>
<jk>public class</jk> AddressInterceptor <jk>extends</jk> BeanInterceptor&lt;Address&gt; {
<jk>public</jk> Object readProperty(Address <jv>bean</jv>, String <jv>name</jv>, Object <jv>value</jv>) {
<jk>if</jk> (<js>"taxInfo"</js>.equals(<jv>name</jv>))
<jk>return</jk> <js>"redacted"</js>;
<jk>return</jk> <jv>value</jv>;
}
<jk>public</jk> Object writeProperty(Address <jv>bean</jv>, String <jv>name</jv>, Object <jv>value</jv>) {
<jk>if</jk> (<js>"taxInfo"</js>.equals(<jv>name</jv>) &amp;&amp; <js>"redacted"</js>.equals(<jv>value</jv>))
<jk>return</jk> TaxInfoUtils.<jsm>lookup</jsm>(<jv>bean</jv>.getStreet(), <jv>bean</jv>.getCity(), <jv>bean</jv>.getState());
<jk>return</jk> <jv>value</jv>;
}
}
<jc>// Our bean class.</jc>
<jk>public class</jk> Address {
<jk>public</jk> String getTaxInfo() {...}
<jk>public void</jk> setTaxInfo(String <jv>value</jv>) {...}
}
<jc>// Register filter on serializer or parser.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanInterceptor(Address.<jk>class</jk>, AddressInterceptor.<jk>class</jk>)
.build();
<jc>// Produces: {"taxInfo":"redacted"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> Address());
</p>
<ul class='seealso'>
<li class='jc'><a href="../../../../../org/apache/juneau/swap/BeanInterceptor.html" title="class in org.apache.juneau.swap"><code>BeanInterceptor</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#interceptor--"><code>Bean(interceptor)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanInterceptor-java.lang.Class-java.lang.Class-">beanInterceptor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The bean that the filter applies to.</dd>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanMapPutReturnsOldValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanMapPutReturnsOldValue</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.677">beanMapPutReturnsOldValue</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanMapPutReturnsOldValue--">BeanContextable.Builder</a></code></span></div>
<div class="block">BeanMap.put() returns old property value.
<p>
When enabled, then the <a href="../../../../../org/apache/juneau/BeanMap.html#put-java.lang.String-java.lang.Object-"><code>BeanMap.put()</code></a> method will return old property
values. Otherwise, it returns <jk>null</jk>.
<p>
Disabled by default because it introduces a slight performance penalty during serialization.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a context that creates BeanMaps with normal put() behavior.</jc>
BeanContext <jv>context</jv> = BeanContext
.<jsm>create</jsm>()
.beanMapPutReturnsOldValue()
.build();
BeanMap&lt;MyBean&gt; <jv>beanMap</jv> = <jv>context</jv>.createSession().toBeanMap(<jk>new</jk> MyBean());
<jv>beanMap</jv>.put(<js>"foo"</js>, <js>"bar"</js>);
Object <jv>oldValue</jv> = <jv>beanMap</jv>.put(<js>"foo"</js>, <js>"baz"</js>); <jc>// oldValue == "bar"</jc>
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beanMapPutReturnsOldValue--"><code>BeanConfig.beanMapPutReturnsOldValue()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#beanMapPutReturnsOldValue--"><code>BeanContext.Builder.beanMapPutReturnsOldValue()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanMapPutReturnsOldValue--">beanMapPutReturnsOldValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html" title="class in org.apache.juneau">BeanContextable.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanMethodVisibility-org.apache.juneau.Visibility-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanMethodVisibility</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.683">beanMethodVisibility</a>(<a href="../../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanMethodVisibility-org.apache.juneau.Visibility-">BeanContextable.Builder</a></code></span></div>
<div class="block">Minimum bean method visibility.
<p>
Only look for bean methods with the specified minimum visibility.
<p>
This affects which methods are detected as getters and setters on a bean class. Normally only <jk>public</jk> getters and setters are considered.
Use this setting if you want to reduce the visibility requirement.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a protected getter.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String getFoo() { <jk>return</jk> <js>"foo"</js>; }
<jk>protected</jk> String getBar() { <jk>return</jk> <js>"bar"</js>; }
}
<jc>// Create a serializer that looks for protected getters and setters.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanMethodVisibility(<jsf>PROTECTED</jsf>)
.build();
<jc>// Produces: {"foo":"foo","bar":"bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation"><code>@Beanp</code></a> annotation can also be used to expose a non-public method.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on a public bean getter/setter to ignore it as a bean property.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beanMethodVisibility--"><code>BeanConfig.beanMethodVisibility()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanMethodVisibility-org.apache.juneau.Visibility-">beanMethodVisibility</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanProperties-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.689">beanProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.util.Map-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property includes.
<p>
Specifies the set and order of names of properties associated with bean classes.
<p>
For example, <c>beanProperties(AMap.<jsm>of</jsm>(<js>"MyBean"</js>, <js>"foo,bar"</js>))</c> means only serialize the <c>foo</c> and
<c>bar</c> properties on the specified bean. Likewise, parsing will ignore any bean properties not specified
and either throw an exception or silently ignore them depending on whether <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreUnknownBeanProperties--"><code>BeanContextable.Builder.ignoreUnknownBeanProperties()</code></a>
has been called.
<p>
This value is entirely optional if you simply want to expose all the getters and public fields on
a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be
serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code,
whereas on Oracle JREs, the order is entirely random.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String
<jf>foo</jf> = <js>"foo"</js>,
<jf>bar</jf> = <js>"bar"</js>,
<jf>baz</jf> = <js>"baz"</js>;
}
<jc>// Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanProperties(AMap.<jsm>of</jsm>(<js>"MyBean"</js>, <js>"foo,bar"</js>))
.build();
<jc>// Produces: {"foo":"foo","bar":"bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
This method is functionally equivalent to the following code for each entry:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>key</jv>).properties(<jv>value</jv>.toString()).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--"><code>Bean.properties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#p--"><code>Bean.p()</code></a>- On an annotation on the bean class itself.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanProperties-java.util.Map-">beanProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this builder.
<br>Keys are bean class names which can be a simple name, fully-qualified name, or <js>"*"</js> for all beans.
<br>Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanProperties-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.695">beanProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property includes.
<p>
Specifies the set and order of names of properties associated with the bean class.
<p>
For example, <c>beanProperties(MyBean.<jk>class</jk>, <js>"foo,bar"</js>)</c> means only serialize the <c>foo</c> and
<c>bar</c> properties on the specified bean. Likewise, parsing will ignore any bean properties not specified
and either throw an exception or silently ignore them depending on whether <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreUnknownBeanProperties--"><code>BeanContextable.Builder.ignoreUnknownBeanProperties()</code></a>
has been called.
<p>
This value is entirely optional if you simply want to expose all the getters and public fields on
a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be
serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code,
whereas on Oracle JREs, the order is entirely random.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String
<jf>foo</jf> = <js>"foo"</js>,
<jf>bar</jf> = <js>"bar"</js>,
<jf>baz</jf> = <js>"baz"</js>;
}
<jc>// Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanProperties(MyBean.<jk>class</jk>, <js>"foo,bar"</js>)
.build();
<jc>// Produces: {"foo":"foo","bar":"bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClass</jv>).properties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--"><code>Bean.properties()</code></a>/<a href="../../../../../org/apache/juneau/annotation/Bean.html#p--"><code>Bean.p()</code></a> - On an annotation on the bean class itself.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanProperties-java.lang.Class-java.lang.String-">beanProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClass</code> - The bean class.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanProperties-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.701">beanProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.String-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property includes.
<p>
Specifies the set and order of names of properties associated with the bean class.
<p>
For example, <c>beanProperties(<js>"MyBean"</js>, <js>"foo,bar"</js>)</c> means only serialize the <c>foo</c> and
<c>bar</c> properties on the specified bean. Likewise, parsing will ignore any bean properties not specified
and either throw an exception or silently ignore them depending on whether <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreUnknownBeanProperties--"><code>BeanContextable.Builder.ignoreUnknownBeanProperties()</code></a>
has been called.
<p>
This value is entirely optional if you simply want to expose all the getters and public fields on
a class as bean properties. However, it's useful if you want certain getters to be ignored or you want the properties to be
serialized in a particular order. Note that on IBM JREs, the property order is the same as the order in the source code,
whereas on Oracle JREs, the order is entirely random.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String
<jf>foo</jf> = <js>"foo"</js>,
<jf>bar</jf> = <js>"bar"</js>,
<jf>baz</jf> = <js>"baz"</js>;
}
<jc>// Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanProperties(<js>"MyBean"</js>, <js>"foo,bar"</js>)
.build();
<jc>// Produces: {"foo":"foo","bar":"bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClassName</jv>).properties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--"><code>Bean.properties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#p--"><code>Bean.p()</code></a> - On an annotation on the bean class itself.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanProperties-java.lang.String-java.lang.String-">beanProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClassName</code> - The bean class name.
<br>Can be a simple name, fully-qualified name, or <js>"*"</js> for all beans.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesExcludes-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesExcludes</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.707">beanPropertiesExcludes</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.util.Map-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property excludes.
<p>
Specifies to exclude the specified list of properties for the specified bean classes.
<p>
Same as <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.util.Map-"><code>BeanContextable.Builder.beanProperties(Map)</code></a> except you specify a list of bean property names that you want to exclude from
serialization.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String
<jf>foo</jf> = <js>"foo"</js>,
<jf>bar</jf> = <js>"bar"</js>,
<jf>baz</jf> = <js>"baz"</js>;
}
<jc>// Create a serializer that excludes the "bar" and "baz" properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesExcludes(AMap.of(<js>"MyBean"</js>, <js>"bar,baz"</js>))
.build();
<jc>// Produces: {"foo":"foo"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
This method is functionally equivalent to the following code for each entry:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>key</jv>).excludeProperties(<jv>value</jv>.toString()).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#excludeProperties--"><code>Bean.excludeProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#xp--"><code>Bean.xp()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesExcludes-java.util.Map-">beanPropertiesExcludes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this builder.
<br>Keys are bean class names which can be a simple name, fully-qualified name, or <js>"*"</js> for all beans.
<br>Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesExcludes-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesExcludes</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.713">beanPropertiesExcludes</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property excludes.
<p>
Specifies to exclude the specified list of properties for the specified bean class.
<p>
Same as <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>BeanContextable.Builder.beanProperties(Class, String)</code></a> except you specify a list of bean property names that you want to exclude from
serialization.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String
<jf>foo</jf> = <js>"foo"</js>,
<jf>bar</jf> = <js>"bar"</js>,
<jf>baz</jf> = <js>"baz"</js>;
}
<jc>// Create a serializer that excludes the "bar" and "baz" properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesExcludes(MyBean.<jk>class</jk>, <js>"bar,baz"</js>)
.build();
<jc>// Produces: {"foo":"foo"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClass</jv>).excludeProperties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#excludeProperties--"><code>Bean.excludeProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#xp--"><code>Bean.xp()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-">beanPropertiesExcludes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClass</code> - The bean class.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesExcludes-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesExcludes</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.719">beanPropertiesExcludes</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.String-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property excludes.
<p>
Specifies to exclude the specified list of properties for the specified bean class.
<p>
Same as <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.String-java.lang.String-"><code>BeanContextable.Builder.beanPropertiesExcludes(String, String)</code></a> except you specify a list of bean property names that you want to exclude from
serialization.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String
<jf>foo</jf> = <js>"foo"</js>,
<jf>bar</jf> = <js>"bar"</js>,
<jf>baz</jf> = <js>"baz"</js>;
}
<jc>// Create a serializer that excludes the "bar" and "baz" properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesExcludes(<js>"MyBean"</js>, <js>"bar,baz"</js>)
.build();
<jc>// Produces: {"foo":"foo"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClassName</jv>).excludeProperties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#excludeProperties--"><code>Bean.excludeProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#xp--"><code>Bean.xp()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesExcludes-java.lang.String-java.lang.String-">beanPropertiesExcludes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClassName</code> - The bean class name.
<br>Can be a simple name, fully-qualified name, or <js>"*"</js> for all bean classes.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesReadOnly-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesReadOnly</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.725">beanPropertiesReadOnly</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesReadOnly-java.util.Map-">BeanContextable.Builder</a></code></span></div>
<div class="block">Read-only bean properties.
<p>
Specifies one or more properties on beans that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
Note that this is different from the <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>beanProperties</code></a>/<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>beanPropertiesExcludes</code></a> settings which include or exclude properties
for both serializers and parsers.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>, <jf>bar</jf>, <jf>baz</jf>;
}
<jc>// Create a serializer with read-only property settings.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesReadOnly(AMap.<jsm>of</jsm>(<js>"MyBean"</js>, <js>"bar,baz"</js>))
.build();
<jc>// All 3 properties will be serialized.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a parser with read-only property settings.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanPropertiesReadOnly(AMap.<jsm>of</jsm>(<js>"MyBean"</js>, <js>"bar,baz"</js>))
.ignoreUnknownBeanProperties()
.build();
<jc>// Parser ignores bar and baz properties.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar',baz:'baz'}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This method is functionally equivalent to the following code for each entry:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>key</jv>).readOnlyProperties(<jv>value</jv>.toString()).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#readOnlyProperties--"><code>Bean.readOnlyProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#ro--"><code>Bean.ro()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesReadOnly-java.util.Map-">beanPropertiesReadOnly</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this builder.
<br>Keys are bean class names which can be a simple name, fully-qualified name, or <js>"*"</js> for all beans.
<br>Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesReadOnly-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesReadOnly</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.731">beanPropertiesReadOnly</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesReadOnly-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Read-only bean properties.
<p>
Specifies one or more properties on a bean that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
Note that this is different from the <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>beanProperties</code></a>/<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>beanPropertiesExcludes</code></a> settings which include or exclude properties
for both serializers and parsers.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>, <jf>bar</jf>, <jf>baz</jf>;
}
<jc>// Create a serializer with read-only property settings.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesReadOnly(MyBean.<jk>class</jk>, <js>"bar,baz"</js>)
.build();
<jc>// All 3 properties will be serialized.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a parser with read-only property settings.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanPropertiesReadOnly(MyBean.<jk>class</jk>, <js>"bar,baz"</js>)
.ignoreUnknownBeanProperties()
.build();
<jc>// Parser ignores bar and baz properties.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar',baz:'baz'}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClass</jv>).readOnlyProperties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#readOnlyProperties--"><code>Bean.readOnlyProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#ro--"><code>Bean.ro()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesReadOnly-java.lang.Class-java.lang.String-">beanPropertiesReadOnly</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClass</code> - The bean class.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesReadOnly-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesReadOnly</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.737">beanPropertiesReadOnly</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesReadOnly-java.lang.String-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Read-only bean properties.
<p>
Specifies one or more properties on a bean that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
Note that this is different from the <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>beanProperties</code></a>/<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>beanPropertiesExcludes</code></a> settings which include or exclude properties
for both serializers and parsers.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>, <jf>bar</jf>, <jf>baz</jf>;
}
<jc>// Create a serializer with read-only property settings.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesReadOnly(<js>"MyBean"</js>, <js>"bar,baz"</js>)
.build();
<jc>// All 3 properties will be serialized.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a parser with read-only property settings.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanPropertiesReadOnly(<js>"MyBean"</js>, <js>"bar,baz"</js>)
.ignoreUnknownBeanProperties()
.build();
<jc>// Parser ignores bar and baz properties.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar',baz:'baz'}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClassName</jv>).readOnlyProperties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#readOnlyProperties--"><code>Bean.readOnlyProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#ro--"><code>Bean.ro()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesReadOnly-java.lang.String-java.lang.String-">beanPropertiesReadOnly</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClassName</code> - The bean class name.
<br>Can be a simple name, fully-qualified name, or <js>"*"</js> for all bean classes.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesWriteOnly-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesWriteOnly</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.743">beanPropertiesWriteOnly</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesWriteOnly-java.util.Map-">BeanContextable.Builder</a></code></span></div>
<div class="block">Write-only bean properties.
<p>
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
Note that this is different from the <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>beanProperties</code></a>/<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>beanPropertiesExcludes</code></a> settings which include or exclude properties
for both serializers and parsers.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>, <jf>bar</jf>, <jf>baz</jf>;
}
<jc>// Create a serializer with write-only property settings.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesWriteOnly(AMap.<jsm>of</jsm>(<js>"MyBean"</js>, <js>"bar,baz"</js>))
.build();
<jc>// Only foo will be serialized.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a parser with write-only property settings.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanPropertiesWriteOnly(AMap.<jsm>of</jsm>(<js>"MyBean"</js>, <js>"bar,baz"</js>))
.build();
<jc>// Parser parses all 3 properties.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar',baz:'baz'}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This method is functionally equivalent to the following code for each entry:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>key</jv>).writeOnlyProperties(<jv>value</jv>.toString()).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#writeOnlyProperties--"><code>Bean.writeOnlyProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#wo--"><code>Bean.wo()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesWriteOnly-java.util.Map-">beanPropertiesWriteOnly</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this builder.
<br>Keys are bean class names which can be a simple name, fully-qualified name, or <js>"*"</js> for all beans.
<br>Values are comma-delimited lists of property names. Non-String objects are first converted to Strings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesWriteOnly-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesWriteOnly</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.749">beanPropertiesWriteOnly</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesWriteOnly-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Write-only bean properties.
<p>
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
Note that this is different from the <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>beanProperties</code></a>/<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>beanPropertiesExcludes</code></a> settings which include or exclude properties
for both serializers and parsers.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>, <jf>bar</jf>, <jf>baz</jf>;
}
<jc>// Create a serializer with write-only property settings.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesWriteOnly(MyBean.<jk>class</jk>, <js>"bar,baz"</js>)
.build();
<jc>// Only foo will be serialized.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a parser with write-only property settings.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanPropertiesWriteOnly(MyBean.<jk>class</jk>, <js>"bar,baz"</js>)
.build();
<jc>// Parser parses all 3 properties.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar',baz:'baz'}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClass</jv>).writeOnlyProperties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#writeOnlyProperties--"><code>Bean.writeOnlyProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#wo--"><code>Bean.wo()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesWriteOnly-java.lang.Class-java.lang.String-">beanPropertiesWriteOnly</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClass</code> - The bean class.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beanPropertiesWriteOnly-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beanPropertiesWriteOnly</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.755">beanPropertiesWriteOnly</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;beanClassName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;properties)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesWriteOnly-java.lang.String-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Write-only bean properties.
<p>
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
Note that this is different from the <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>beanProperties</code></a>/<a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>beanPropertiesExcludes</code></a> settings which include or exclude properties
for both serializers and parsers.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>, <jf>bar</jf>, <jf>baz</jf>;
}
<jc>// Create a serializer with write-only property settings.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanPropertiesWriteOnly(<js>"MyBean"</js>, <js>"bar,baz"</js>)
.build();
<jc>// Only foo will be serialized.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a parser with write-only property settings.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanPropertiesWriteOnly(<js>"MyBean"</js>, <js>"bar,baz"</js>)
.build();
<jc>// Parser parses all 3 properties.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar',baz:'baz'}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This method is functionally equivalent to the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(BeanAnnotation.<jsm>create</jsm>(<jv>beanClassName</jv>).writeOnlyProperties(<jv>properties</jv>).build());
</p>
<ul class='seealso'>
<li class='jma'><a href="../../../../../org/apache/juneau/annotation/Bean.html#writeOnlyProperties--"><code>Bean.writeOnlyProperties()</code></a> / <a href="../../../../../org/apache/juneau/annotation/Bean.html#wo--"><code>Bean.wo()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beanPropertiesWriteOnly-java.lang.String-java.lang.String-">beanPropertiesWriteOnly</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClassName</code> - The bean class name.
<br>Can be a simple name, fully-qualified name, or <js>"*"</js> for all bean classes.</dd>
<dd><code>properties</code> - Comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beansRequireDefaultConstructor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beansRequireDefaultConstructor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.761">beansRequireDefaultConstructor</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beansRequireDefaultConstructor--">BeanContextable.Builder</a></code></span></div>
<div class="block">Beans require no-arg constructors.
<p>
When enabled, a Java class must implement a default no-arg constructor to be considered a bean.
Otherwise, the bean will be serialized as a string using the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a> method.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean without a no-arg constructor.</jc>
<jk>public class</jk> MyBean {
<jc>// A property method.</jc>
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
<jc>// A no-arg constructor</jc>
<jk>public</jk> MyBean(String <jv>foo</jv>) {
<jk>this</jk>.<jf>foo</jf> = <jv>foo</jv>;
}
<ja>@Override</ja>
<jk>public</jk> String toString() {
<jk>return</jk> <js>"bar"</js>;
}
}
<jc>// Create a serializer that ignores beans without default constructors.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beansRequireDefaultConstructor()
.build();
<jc>// Produces: "bar"</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a bean class to override this setting.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on a class to ignore it as a bean.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beansRequireDefaultConstructor--"><code>BeanConfig.beansRequireDefaultConstructor()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#beansRequireDefaultConstructor--"><code>BeanContext.Builder.beansRequireDefaultConstructor()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beansRequireDefaultConstructor--">beansRequireDefaultConstructor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beansRequireSerializable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beansRequireSerializable</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.767">beansRequireSerializable</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beansRequireSerializable--">BeanContextable.Builder</a></code></span></div>
<div class="block">Beans require Serializable interface.
<p>
When enabled, a Java class must implement the <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io"><code>Serializable</code></a> interface to be considered a bean.
Otherwise, the bean will be serialized as a string using the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a> method.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean without a Serializable interface.</jc>
<jk>public class</jk> MyBean {
<jc>// A property method.</jc>
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
<ja>@Override</ja>
<jk>public</jk> String toString() {
<jk>return</jk> <js>"bar"</js>;
}
}
<jc>// Create a serializer that ignores beans not implementing Serializable.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beansRequireSerializable()
.build();
<jc>// Produces: "bar"</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a bean class to override this setting.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on a class to ignore it as a bean.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beansRequireSerializable--"><code>BeanConfig.beansRequireSerializable()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#beansRequireSerializable--"><code>BeanContext.Builder.beansRequireSerializable()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beansRequireSerializable--">beansRequireSerializable</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="beansRequireSettersForGetters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beansRequireSettersForGetters</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.773">beansRequireSettersForGetters</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beansRequireSettersForGetters--">BeanContextable.Builder</a></code></span></div>
<div class="block">Beans require setters for getters.
<p>
When enabled, ignore read-only properties (properties with getters but not setters).
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean without a Serializable interface.</jc>
<jk>public class</jk> MyBean {
<jc>// A read/write property.</jc>
<jk>public</jk> String getFoo() { <jk>return</jk> <js>"foo"</js>; }
<jk>public void</jk> setFoo(String <jv>foo</jv>) { ... }
<jc>// A read-only property.</jc>
<jk>public</jk> String getBar() { <jk>return</jk> <js>"bar"</js>; }
}
<jc>// Create a serializer that ignores bean properties without setters.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beansRequireSettersForGetters()
.build();
<jc>// Produces: {"foo":"foo"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation"><code>@Beanp</code></a> annotation can be used on the getter to override this setting.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on getters to ignore them as bean properties.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#beansRequireSettersForGetters--"><code>BeanConfig.beansRequireSettersForGetters()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#beansRequireSettersForGetters--"><code>BeanContext.Builder.beansRequireSettersForGetters()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#beansRequireSettersForGetters--">beansRequireSettersForGetters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="dictionaryOn-java.lang.Class-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dictionaryOn</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.779">dictionaryOn</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#dictionaryOn-java.lang.Class-java.lang.Class...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean dictionary.
<p>
This is identical to <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#beanDictionary-java.lang.Class...-"><code>BeanContextable.Builder.beanDictionary(Class...)</code></a>, but specifies a dictionary within the context of
a single class as opposed to globally.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// POJOs with @Bean(name) annotations.</jc>
<ja>@Bean</ja>(typeName=<js>"foo"</js>)
<jk>public class</jk> Foo {...}
<ja>@Bean</ja>(typeName=<js>"bar"</js>)
<jk>public class</jk> Bar {...}
<jc>// A bean with a field with an indeterminate type.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> Object <jf>mySimpleField</jf>;
}
<jc>// Create a parser and tell it which classes to try to resolve.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.dictionaryOn(MyBean.<jk>class</jk>, Foo.<jk>class</jk>, Bar.<jk>class</jk>)
.build();
<jc>// Parse bean.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{mySimpleField:{_type:'foo',...}}"</js>, MyBean.<jk>class</jk>);
</p>
<p>
This is functionally equivalent to the <a href="../../../../../org/apache/juneau/annotation/Bean.html#dictionary--"><code>Bean.dictionary()</code></a> annotation.
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#dictionary--"><code>Bean.dictionary()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#beanDictionary-java.lang.Class...-"><code>BeanContext.Builder.beanDictionary(Class...)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#dictionaryOn-java.lang.Class-java.lang.Class...-">dictionaryOn</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class that the dictionary values apply to.</dd>
<dd><code>values</code> - The new values for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="disableBeansRequireSomeProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableBeansRequireSomeProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.785">disableBeansRequireSomeProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#disableBeansRequireSomeProperties--">BeanContextable.Builder</a></code></span></div>
<div class="block">Beans don't require at least one property.
<p>
When enabled, then a Java class doesn't need to contain at least 1 property to be considered a bean.
Otherwise, the bean will be serialized as a string using the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a> method.
<p>
The <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a class to override this setting when <jk>true</jk>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with no properties.</jc>
<jk>public class</jk> MyBean {
}
<jc>// Create a serializer that serializes beans even if they have zero properties.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.disableBeansRequireSomeProperties()
.build();
<jc>// Produces: {}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on the class to force it to be recognized as a bean class
even if it has no properties.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#disableBeansRequireSomeProperties--"><code>BeanConfig.disableBeansRequireSomeProperties()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#disableBeansRequireSomeProperties--"><code>BeanContext.Builder.disableBeansRequireSomeProperties()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableBeansRequireSomeProperties--">disableBeansRequireSomeProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="disableIgnoreMissingSetters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableIgnoreMissingSetters</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.791">disableIgnoreMissingSetters</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#disableIgnoreMissingSetters--">BeanContextable.Builder</a></code></span></div>
<div class="block">Don't silently ignore missing setters.
<p>
When enabled, trying to set a value on a bean property without a setter will throw a <a href="../../../../../org/apache/juneau/BeanRuntimeException.html" title="class in org.apache.juneau"><code>BeanRuntimeException</code></a>.
Otherwise, it will be silently ignored.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a property with a getter but not a setter.</jc>
<jk>public class</jk> MyBean {
<jk>public void</jk> getFoo() {
<jk>return</jk> <js>"foo"</js>;
}
}
<jc>// Create a parser that throws an exception if a setter is not found but a getter is.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.disableIgnoreMissingSetters()
.build();
<jc>// Throws a ParseException.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'bar'}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on getters and fields to ignore them.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#disableIgnoreMissingSetters--"><code>BeanConfig.disableIgnoreMissingSetters()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#disableIgnoreMissingSetters--"><code>BeanContext.Builder.disableIgnoreMissingSetters()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableIgnoreMissingSetters--">disableIgnoreMissingSetters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="disableIgnoreTransientFields--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableIgnoreTransientFields</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.797">disableIgnoreTransientFields</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#disableIgnoreTransientFields--">BeanContextable.Builder</a></code></span></div>
<div class="block">Don't ignore transient fields.
<p>
When enabled, methods and fields marked as <jk>transient</jk> will not be ignored as bean properties.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a transient field.</jc>
<jk>public class</jk> MyBean {
<jk>public transient</jk> String <jf>foo</jf> = <js>"foo"</js>;
}
<jc>// Create a serializer that doesn't ignore transient fields.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.disableIgnoreTransientFields()
.build();
<jc>// Produces: {"foo":"foo"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation"><code>@Beanp</code></a> annotation can also be used on transient fields to keep them from being ignored.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#disableIgnoreTransientFields--"><code>BeanConfig.disableIgnoreTransientFields()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#disableIgnoreTransientFields--"><code>BeanContext.Builder.disableIgnoreTransientFields()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableIgnoreTransientFields--">disableIgnoreTransientFields</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="disableIgnoreUnknownNullBeanProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableIgnoreUnknownNullBeanProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.803">disableIgnoreUnknownNullBeanProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#disableIgnoreUnknownNullBeanProperties--">BeanContextable.Builder</a></code></span></div>
<div class="block">Don't ignore unknown properties with null values.
<p>
When enabled, trying to set a <jk>null</jk> value on a non-existent bean property will throw a <a href="../../../../../org/apache/juneau/BeanRuntimeException.html" title="class in org.apache.juneau"><code>BeanRuntimeException</code></a>.
Otherwise it will be silently ignored.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a single property.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>;
}
<jc>// Create a parser that throws an exception on an unknown property even if the value being set is null.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.disableIgnoreUnknownNullBeanProperties()
.build();
<jc>// Throws a BeanRuntimeException wrapped in a ParseException on the unknown 'bar' property.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:null}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#disableIgnoreUnknownNullBeanProperties--"><code>BeanConfig.disableIgnoreUnknownNullBeanProperties()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#disableIgnoreUnknownNullBeanProperties--"><code>BeanContext.Builder.disableIgnoreUnknownNullBeanProperties()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableIgnoreUnknownNullBeanProperties--">disableIgnoreUnknownNullBeanProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="disableInterfaceProxies--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableInterfaceProxies</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.809">disableInterfaceProxies</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#disableInterfaceProxies--">BeanContextable.Builder</a></code></span></div>
<div class="block">Don't use interface proxies.
<p>
When enabled, interfaces will be instantiated as proxy classes through the use of an
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationHandler.html?is-external=true" title="class or interface in java.lang.reflect"><code>InvocationHandler</code></a> if there is no other way of instantiating them.
Otherwise, throws a <a href="../../../../../org/apache/juneau/BeanRuntimeException.html" title="class in org.apache.juneau"><code>BeanRuntimeException</code></a>.
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#disableInterfaceProxies--"><code>BeanConfig.disableInterfaceProxies()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#disableInterfaceProxies--"><code>BeanContext.Builder.disableInterfaceProxies()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableInterfaceProxies--">disableInterfaceProxies</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="example-java.lang.Class-java.lang.Object-">
<!-- -->
</a><a name="example-java.lang.Class-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>example</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.815">example</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;pojoClass,
T&nbsp;o)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#example-java.lang.Class-T-">BeanContextable.Builder</a></code></span></div>
<div class="block">POJO example.
<p>
Specifies an example of the specified class.
<p>
Examples are used in cases such as POJO examples in Swagger documents.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.example(MyBean.<jk>class</jk>, <jk>new</jk> MyBean().setFoo(<js>"foo"</js>).setBar(123))
.build();
</p>
<p>
This is a shorthand method for the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(MarshalledAnnotation.<jsm>create</jsm>(<jv>pojoClass</jv>).example(SimpleJson.<jsf>DEFAULT</jsf>.toString(<jv>object</jv>)).build())
</p>
<ul class='notes'>
<li class='note'>Using this method assumes the serialized form of the object is the same as that produced
by the default serializer. This may not be true based on settings or swaps on the constructed serializer.
</ul>
<p>
POJO examples can also be defined on classes via the following:
<ul class='spaced-list'>
<li>The <a href="../../../../../org/apache/juneau/annotation/Marshalled.html#example--"><code>Marshalled.example()</code></a> annotation on the class itself.
<li>A static field annotated with <a href="../../../../../org/apache/juneau/annotation/Example.html" title="annotation in org.apache.juneau.annotation"><code>@Example</code></a>.
<li>A static method annotated with <a href="../../../../../org/apache/juneau/annotation/Example.html" title="annotation in org.apache.juneau.annotation"><code>@Example</code></a> with zero arguments or one <a href="../../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> argument.
<li>A static method with name <c>example</c> with no arguments or one <a href="../../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> argument.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#example-java.lang.Class-T-">example</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html" title="class in org.apache.juneau">BeanContextable.Builder</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The POJO class.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pojoClass</code> - The POJO class.</dd>
<dd><code>o</code> - An instance of the POJO class used for examples.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="example-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>example</h4>
<pre>public&nbsp;&lt;T&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.821">example</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;pojoClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;json)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#example-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">POJO example.
<p>
Specifies an example in JSON of the specified class.
<p>
Examples are used in cases such as POJO examples in Swagger documents.
<p>
Setting applies to specified class and all subclasses.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.example(MyBean.<jk>class</jk>, <js>"{foo:'bar'}"</js>)
.build();
</p>
<p>
This is a shorthand method for the following code:
<p class='bjava'>
<jv>builder</jv>.annotations(MarshalledAnnotation.<jsm>create</jsm>(<jv>pojoClass</jv>).example(<jv>json</jv>).build())
</p>
<p>
POJO examples can also be defined on classes via the following:
<ul class='spaced-list'>
<li>A static field annotated with <a href="../../../../../org/apache/juneau/annotation/Example.html" title="annotation in org.apache.juneau.annotation"><code>@Example</code></a>.
<li>A static method annotated with <a href="../../../../../org/apache/juneau/annotation/Example.html" title="annotation in org.apache.juneau.annotation"><code>@Example</code></a> with zero arguments or one <a href="../../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> argument.
<li>A static method with name <c>example</c> with no arguments or one <a href="../../../../../org/apache/juneau/BeanSession.html" title="class in org.apache.juneau"><code>BeanSession</code></a> argument.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Marshalled.html#example--"><code>Marshalled.example()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#example-java.lang.Class-java.lang.String-">example</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html" title="class in org.apache.juneau">BeanContextable.Builder</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The POJO class type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pojoClass</code> - The POJO class.</dd>
<dd><code>json</code> - The simple JSON representation of the example.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="findFluentSetters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFluentSetters</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.827">findFluentSetters</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#findFluentSetters--">BeanContextable.Builder</a></code></span></div>
<div class="block">Find fluent setters.
<p>
When enabled, fluent setters are detected on beans during parsing.
<p>
Fluent setters must have the following attributes:
<ul>
<li>Public.
<li>Not static.
<li>Take in one parameter.
<li>Return the bean itself.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a fluent setter.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> MyBean foo(String <jv>value</jv>) {...}
}
<jc>// Create a parser that finds fluent setters.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.findFluentSetters()
.build();
<jc>// Parse into bean using fluent setter.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'bar'}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Beanp.html" title="annotation in org.apache.juneau.annotation"><code>@Beanp</code></a> annotation can also be used on methods to individually identify them as fluent setters.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html#findFluentSetters--"><code>@Bean.fluentSetters()</code></a> annotation can also be used on classes to specify to look for fluent setters.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#findFluentSetters--"><code>Bean.findFluentSetters()</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#findFluentSetters--"><code>BeanConfig.findFluentSetters()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#findFluentSetters--"><code>BeanContext.Builder.findFluentSetters()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#findFluentSetters--">findFluentSetters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="findFluentSetters-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFluentSetters</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.833">findFluentSetters</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#findFluentSetters-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Find fluent setters.
<p>
Identical to <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#findFluentSetters--"><code>BeanContextable.Builder.findFluentSetters()</code></a> but enables it on a specific class only.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a fluent setter.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> MyBean foo(String <jv>value</jv>) {...}
}
<jc>// Create a parser that finds fluent setters.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.findFluentSetters(MyBean.<jk>class</jk>)
.build();
<jc>// Parse into bean using fluent setter.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'bar'}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='notes'>
<li class='note'>This method is functionally equivalent to using the <a href="../../../../../org/apache/juneau/annotation/Bean.html#findFluentSetters--"><code>Bean.findFluentSetters()</code></a> annotation.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#findFluentSetters--"><code>Bean.findFluentSetters()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#findFluentSetters--"><code>BeanContext.Builder.findFluentSetters()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#findFluentSetters-java.lang.Class-">findFluentSetters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class that this applies to.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="ignoreInvocationExceptionsOnGetters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreInvocationExceptionsOnGetters</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.839">ignoreInvocationExceptionsOnGetters</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreInvocationExceptionsOnGetters--">BeanContextable.Builder</a></code></span></div>
<div class="block">Ignore invocation errors on getters.
<p>
When enabled, errors thrown when calling bean getter methods will silently be ignored.
Otherwise, a <code>BeanRuntimeException</code> is thrown.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a property that throws an exception.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String getFoo() {
<jk>throw new</jk> RuntimeException(<js>"foo"</js>);
}
}
<jc>// Create a serializer that ignores bean getter exceptions.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.ingoreInvocationExceptionsOnGetters()
.build();
<jc>// Exception is ignored.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#ignoreInvocationExceptionsOnGetters--"><code>BeanConfig.ignoreInvocationExceptionsOnGetters()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#ignoreInvocationExceptionsOnGetters--"><code>BeanContext.Builder.ignoreInvocationExceptionsOnGetters()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreInvocationExceptionsOnGetters--">ignoreInvocationExceptionsOnGetters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="ignoreInvocationExceptionsOnSetters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreInvocationExceptionsOnSetters</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.845">ignoreInvocationExceptionsOnSetters</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreInvocationExceptionsOnSetters--">BeanContextable.Builder</a></code></span></div>
<div class="block">Ignore invocation errors on setters.
<p>
When enabled, errors thrown when calling bean setter methods will silently be ignored.
Otherwise, a <code>BeanRuntimeException</code> is thrown.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a property that throws an exception.</jc>
<jk>public class</jk> MyBean {
<jk>public void</jk> setFoo(String <jv>foo</jv>) {
<jk>throw new</jk> RuntimeException(<js>"foo"</js>);
}
}
<jc>// Create a parser that ignores bean setter exceptions.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.ignoreInvocationExceptionsOnSetters()
.build();
<jc>// Exception is ignored.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'bar'}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#ignoreInvocationExceptionsOnSetters--"><code>BeanConfig.ignoreInvocationExceptionsOnSetters()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#ignoreInvocationExceptionsOnSetters--"><code>BeanContext.Builder.ignoreInvocationExceptionsOnSetters()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreInvocationExceptionsOnSetters--">ignoreInvocationExceptionsOnSetters</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="ignoreUnknownBeanProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreUnknownBeanProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.851">ignoreUnknownBeanProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreUnknownBeanProperties--">BeanContextable.Builder</a></code></span></div>
<div class="block">Ignore unknown properties.
<p>
When enabled, trying to set a value on a non-existent bean property will silently be ignored.
Otherwise, a <code>BeanRuntimeException</code> is thrown.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a single property.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf>;
}
<jc>// Create a parser that ignores missing bean properties.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.ignoreUnknownBeanProperties()
.build();
<jc>// Doesn't throw an exception on unknown 'bar' property.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"{foo:'foo',bar:'bar'}"</js>, MyBean.<jk>class</jk>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#ignoreUnknownBeanProperties--"><code>BeanConfig.ignoreUnknownBeanProperties()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#ignoreUnknownBeanProperties--"><code>BeanContext.Builder.ignoreUnknownBeanProperties()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreUnknownBeanProperties--">ignoreUnknownBeanProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="ignoreUnknownEnumValues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreUnknownEnumValues</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.857">ignoreUnknownEnumValues</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#ignoreUnknownEnumValues--">BeanContextable.Builder</a></code></span></div>
<div class="block">Ignore unknown enum values.
<p>
When enabled, unknown enum values are set to <jk>null</jk> instead of throwing a parse exception.
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#ignoreUnknownEnumValues--"><code>BeanConfig.ignoreUnknownEnumValues()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#ignoreUnknownEnumValues--"><code>BeanContext.Builder.ignoreUnknownEnumValues()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreUnknownEnumValues--">ignoreUnknownEnumValues</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="implClass-java.lang.Class-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>implClass</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.863">implClass</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;interfaceClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;implClass)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#implClass-java.lang.Class-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Implementation classes.
<p>
For interfaces and abstract classes this method can be used to specify an implementation class for the
interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a
parse).
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean interface.</jc>
<jk>public interface</jk> MyBean {
...
}
<jc>// A bean implementation.</jc>
<jk>public class</jk> MyBeanImpl <jk>implements</jk> MyBean {
...
}
<jc>// Create a parser that instantiates MyBeanImpls when parsing MyBeans.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.implClass(MyBean.<jk>class</jk>, MyBeanImpl.<jk>class</jk>)
.build();
<jc>// Instantiates a MyBeanImpl,</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"..."</js>, MyBean.<jk>class</jk>);
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#implClass-java.lang.Class-java.lang.Class-">implClass</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interfaceClass</code> - The interface class.</dd>
<dd><code>implClass</code> - The implementation class.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="implClasses-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>implClasses</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.869">implClasses</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&gt;&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#implClasses-java.util.Map-">BeanContextable.Builder</a></code></span></div>
<div class="block">Implementation classes.
<p>
For interfaces and abstract classes this method can be used to specify an implementation class for the
interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a
parse).
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a single property.</jc>
<jk>public interface</jk> MyBean {
...
}
<jc>// A bean with a single property.</jc>
<jk>public class</jk> MyBeanImpl <jk>implements</jk> MyBean {
...
}
<jc>// Create a parser that instantiates MyBeanImpls when parsing MyBeans.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.implClasses(AMap.<jsm>of</jsm>(MyBean.<jk>class</jk>, MyBeanImpl.<jk>class</jk>))
.build();
<jc>// Instantiates a MyBeanImpl,</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"..."</js>, MyBean.<jk>class</jk>);
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#implClasses-java.util.Map-">implClasses</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="interfaceClass-java.lang.Class-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceClass</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.875">interfaceClass</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#interfaceClass-java.lang.Class-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Identifies a class to be used as the interface class for the specified class and all subclasses.
<p>
When specified, only the list of properties defined on the interface class will be used during serialization.
Additional properties on subclasses will be ignored.
<p class='bjava'>
<jc>// Parent class or interface</jc>
<jk>public abstract class</jk> A {
<jk>public</jk> String <jf>foo</jf> = <js>"foo"</js>;
}
<jc>// Sub class</jc>
<jk>public class</jk> A1 <jk>extends</jk> A {
<jk>public</jk> String <jf>bar</jf> = <js>"bar"</js>;
}
<jc>// Create a serializer and define our interface class mapping.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.interfaceClass(A1.<jk>class</jk>, A.<jk>class</jk>)
.build();
<jc>// Produces "{"foo":"foo"}"</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> A1());
</p>
<p>
This annotation can be used on the parent class so that it filters to all child classes, or can be set
individually on the child classes.
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html#interfaceClass--"><code>@Bean(interfaceClass)</code></a> annotation is the equivalent annotation-based solution.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#interfaceClass-java.lang.Class-java.lang.Class-">interfaceClass</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class that the interface class applies to.</dd>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="interfaces-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaces</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.881">interfaces</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#interfaces-java.lang.Class...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Identifies a set of interfaces.
<p>
When specified, only the list of properties defined on the interface class will be used during serialization
of implementation classes. Additional properties on subclasses will be ignored.
<p class='bjava'>
<jc>// Parent class or interface</jc>
<jk>public abstract class</jk> A {
<jk>public</jk> String <jf>foo</jf> = <js>"foo"</js>;
}
<jc>// Sub class</jc>
<jk>public class</jk> A1 <jk>extends</jk> A {
<jk>public</jk> String <jf>bar</jf> = <js>"bar"</js>;
}
<jc>// Create a serializer and define our interface class mapping.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.interfaces(A.<jk>class</jk>)
.build();
<jc>// Produces "{"foo":"foo"}"</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> A1());
</p>
<p>
This annotation can be used on the parent class so that it filters to all child classes, or can be set
individually on the child classes.
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html#interfaceClass--"><code>@Bean(interfaceClass)</code></a> annotation is the equivalent annotation-based solution.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#interfaces-java.lang.Class...-">interfaces</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="locale-java.util.Locale-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>locale</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.887">locale</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#locale-java.util.Locale-">BeanContextable.Builder</a></code></span></div>
<div class="block"><i><l>Context</l> configuration property:&emsp;</i> Locale.
<p>
Specifies the default locale for serializer and parser sessions when not specified via <a href="../../../../../org/apache/juneau/BeanSession.Builder.html#locale-java.util.Locale-"><code>BeanSession.Builder.locale(Locale)</code></a>.
Typically used for POJO swaps that need to deal with locales such as swaps that convert <l>Date</l> and <l>Calendar</l>
objects to strings by accessing it via the session passed into the <a href="../../../../../org/apache/juneau/swap/ObjectSwap.html#swap-org.apache.juneau.BeanSession-T-"><code>ObjectSwap.swap(BeanSession, Object)</code></a> and
<a href="../../../../../org/apache/juneau/swap/ObjectSwap.html#unswap-org.apache.juneau.BeanSession-S-org.apache.juneau.ClassMeta-java.lang.String-"><code>ObjectSwap.unswap(BeanSession, Object, ClassMeta, String)</code></a> methods.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define a POJO swap that skips serializing beans if we're in the UK.</jc>
<jk>public class</jk> MyBeanSwap <jk>extends</jk> StringSwap&lt;MyBean&gt; {
<ja>@Override</ja>
<jk>public</jk> String swap(BeanSession <jv>session</jv>, MyBean <jv>bean</jv>) <jk>throws</jk> Exception {
<jk>if</jk> (<jv>session</jv>.getLocale().equals(Locale.<jsf>UK</jsf>))
<jk>return null</jk>;
<jk>return</jk> <jv>bean</jv>.toString();
}
}
<jc>// Create a serializer that uses the specified locale if it's not passed in through session args.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.locale(Locale.<jsf>UK</jsf>)
.swaps(MyBeanSwap.<jk>class</jk>)
.build();
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#locale--"><code>BeanConfig.locale()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#locale-java.util.Locale-"><code>BeanContext.Builder.locale(Locale)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanSession.Builder.html#locale-java.util.Locale-"><code>BeanSession.Builder.locale(Locale)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#locale-java.util.Locale-">locale</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="mediaType-org.apache.juneau.http.header.MediaType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mediaType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.893">mediaType</a>(<a href="../../../../../org/apache/juneau/http/header/MediaType.html" title="class in org.apache.juneau.http.header">MediaType</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#mediaType-org.apache.juneau.http.header.MediaType-">RestClient.Builder</a></code></span></div>
<div class="block">Appends the <c>Accept</c> and <c>Content-Type</c> headers on all requests made by this client.
<p>
Headers are appended to the end of the current header list.
<p>
This is a shortcut for calling <c>headerData().append(Accept.<jsm>of</jsm>(<jv>value</jv>), ContentType.<jsm>of</jsm>(<jv>value</jv>))</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#mediaType-org.apache.juneau.http.header.MediaType-">mediaType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new header values.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="notBeanClasses-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notBeanClasses</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.899">notBeanClasses</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#notBeanClasses-java.lang.Class...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean class exclusions.
<p>
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to <c>Strings</c> during serialization.
<p>
Values can consist of any of the following types:
<ul>
<li>Classes.
<li>Arrays and collections of classes.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a single property.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
<jk>public</jk> String toString() {
<jk>return</jk> <js>"baz"</js>;
}
}
<jc>// Create a serializer that doesn't treat MyBean as a bean class.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.notBeanClasses(MyBean.<jk>class</jk>)
.build();
<jc>// Produces "baz" instead of {"foo":"bar"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>@BeanIgnore</code></a> annotation can also be used on classes to prevent them from being recognized as beans.
</ul>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanIgnore.html" title="annotation in org.apache.juneau.annotation"><code>BeanIgnore</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#notBeanClasses--"><code>BeanConfig.notBeanClasses()</code></a>
<li class='jf'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#notBeanClasses--"><code>BeanContext.Builder.notBeanClasses()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#notBeanClasses-java.lang.Class...-">notBeanClasses</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this setting.
<br>Values can consist of any of the following types:
<ul>
<li>Classes.
<li>Arrays and collections of classes.
</ul></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="notBeanPackages-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>notBeanPackages</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.905">notBeanPackages</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#notBeanPackages-java.lang.String...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean package exclusions.
<p>
Used as a convenient way of defining the <a href="../../../../../org/apache/juneau/BeanContext.Builder.html#notBeanClasses-java.lang.Class...-"><code>BeanContext.Builder.notBeanClasses(Class...)</code></a> property for entire packages.
Any classes within these packages will be serialized to strings using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>.
<p>
Note that you can specify suffix patterns to include all subpackages.
<p>
Values can consist of any of the following types:
<ul>
<li>Strings.
<li>Arrays and collections of strings.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that ignores beans in the specified packages.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.notBeanPackages(<js>"org.apache.foo"</js>, <js>"org.apache.bar.*"</js>)
.build();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#notBeanPackages-java.lang.String...-"><code>BeanContext.Builder.notBeanPackages(String...)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#notBeanPackages-java.lang.String...-">notBeanPackages</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this setting.
<br>Values can consist of any of the following types:
<ul>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Package.html?is-external=true" title="class or interface in java.lang"><code>Package</code></a> objects.
<li>Strings.
<li>Arrays and collections of anything in this list.
</ul></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="propertyNamer-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propertyNamer</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.911">propertyNamer</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#propertyNamer-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property namer
<p>
The class to use for calculating bean property names.
<p>
Predefined classes:
<ul>
<li><a href="../../../../../org/apache/juneau/BasicPropertyNamer.html" title="class in org.apache.juneau"><code>BasicPropertyNamer</code></a> - Default.
<li><a href="../../../../../org/apache/juneau/PropertyNamerDLC.html" title="class in org.apache.juneau"><code>PropertyNamerDLC</code></a> - Dashed-lower-case names.
<li><a href="../../../../../org/apache/juneau/PropertyNamerULC.html" title="class in org.apache.juneau"><code>PropertyNamerULC</code></a> - Dashed-upper-case names.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a single property.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>fooBarBaz</jf> = <js>"fooBarBaz"</js>;
}
<jc>// Create a serializer that uses Dashed-Lower-Case property names.</jc>
<jc>// (e.g. "foo-bar-baz" instead of "fooBarBaz")</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.propertyNamer(PropertyNamerDLC.<jk>class</jk>)
.build();
<jc>// Produces: {"foo-bar-baz":"fooBarBaz"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#propertyNamer-java.lang.Class-"><code>BeanContext.Builder.propertyNamer(Class)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#propertyNamer-java.lang.Class-">propertyNamer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/BasicPropertyNamer.html" title="class in org.apache.juneau"><code>BasicPropertyNamer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="propertyNamer-java.lang.Class-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propertyNamer</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.917">propertyNamer</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#propertyNamer-java.lang.Class-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean property namer
<p>
Same as <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#propertyNamer-java.lang.Class-"><code>BeanContextable.Builder.propertyNamer(Class)</code></a> but allows you to specify a namer for a specific class.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with a single property.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>fooBarBaz</jf> = <js>"fooBarBaz"</js>;
}
<jc>// Create a serializer that uses Dashed-Lower-Case property names for the MyBean class only.</jc>
<jc>// (e.g. "foo-bar-baz" instead of "fooBarBaz")</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.propertyNamer(MyBean.<jk>class</jk>, PropertyNamerDLC.<jk>class</jk>)
.build();
<jc>// Produces: {"foo-bar-baz":"fooBarBaz"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#propertyNamer--"><code>Bean(propertyNamer)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#propertyNamer-java.lang.Class-"><code>BeanContext.Builder.propertyNamer(Class)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#propertyNamer-java.lang.Class-java.lang.Class-">propertyNamer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class that the namer applies to.</dd>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/BasicPropertyNamer.html" title="class in org.apache.juneau"><code>BasicPropertyNamer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sortProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.923">sortProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#sortProperties--">BeanContextable.Builder</a></code></span></div>
<div class="block">Sort bean properties.
<p>
When enabled, all bean properties will be serialized and access in alphabetical order.
Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.
On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).
<p>
this setting is disabled by default so that IBM JVM users don't have to use <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations
to force bean properties to be in a particular order and can just alter the order of the fields/methods
in the Java file.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>c</jf> = <js>"1"</js>;
<jk>public</jk> String <jf>b</jf> = <js>"2"</js>;
<jk>public</jk> String <jf>a</jf> = <js>"3"</js>;
}
<jc>// Create a serializer that sorts bean properties.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.sortProperties()
.build();
<jc>// Produces: {"a":"3","b":"2","c":"1"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Bean.html#sort--"><code>@Bean.sort()</code></a> annotation can also be used to sort properties on just a single class.
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#sortProperties--"><code>BeanContext.Builder.sortProperties()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortProperties--">sortProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sortProperties-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.929">sortProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;on)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#sortProperties-java.lang.Class...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Sort bean properties.
<p>
Same as <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#sortProperties--"><code>BeanContextable.Builder.sortProperties()</code></a> but allows you to specify individual bean classes instead of globally.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// A bean with 3 properties.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>c</jf> = <js>"1"</js>;
<jk>public</jk> String <jf>b</jf> = <js>"2"</js>;
<jk>public</jk> String <jf>a</jf> = <js>"3"</js>;
}
<jc>// Create a serializer that sorts properties on MyBean.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.sortProperties(MyBean.<jk>class</jk>)
.build();
<jc>// Produces: {"a":"3","b":"2","c":"1"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#sort--"><code>Bean(sort)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#sortProperties--"><code>BeanContext.Builder.sortProperties()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortProperties-java.lang.Class...-">sortProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The bean classes to sort properties on.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="stopClass-java.lang.Class-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopClass</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.935">stopClass</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#stopClass-java.lang.Class-java.lang.Class-">BeanContextable.Builder</a></code></span></div>
<div class="block">Identifies a stop class for the annotated class.
<p>
Identical in purpose to the stop class specified by <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#getBeanInfo-java.lang.Class-java.lang.Class-" title="class or interface in java.beans"><code>Introspector.getBeanInfo(Class, Class)</code></a>.
Any properties in the stop class or in its base classes will be ignored during analysis.
<p>
For example, in the following class hierarchy, instances of <c>C3</c> will include property <c>p3</c>,
but not <c>p1</c> or <c>p2</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jk>public class</jk> C1 {
<jk>public int</jk> getP1();
}
<jk>public class</jk> C2 <jk>extends</jk> C1 {
<jk>public int</jk> getP2();
}
<jk>public class</jk> C3 <jk>extends</jk> C2 {
<jk>public int</jk> getP3();
}
<jc>// Create a serializer specifies a stop class for C3.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.stopClass(C3.<jk>class</jk>, C2.<jk>class</jk>)
.build();
<jc>// Produces: {"p3":"..."}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> C3());
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#stopClass-java.lang.Class-java.lang.Class-">stopClass</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class on which the stop class is being applied.</dd>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>swap</h4>
<pre>public&nbsp;&lt;T,S&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.941">swap</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;normalClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;S&gt;&nbsp;swappedClass,
<a href="../../../../../org/apache/juneau/utils/ThrowingFunction.html" title="interface in org.apache.juneau.utils">ThrowingFunction</a>&lt;T,S&gt;&nbsp;swapFunction)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-">BeanContextable.Builder</a></code></span></div>
<div class="block">A shortcut for defining a <a href="../../../../../org/apache/juneau/swap/FunctionalSwap.html" title="class in org.apache.juneau.swap"><code>FunctionalSwap</code></a>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that performs a custom format for Date objects.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.swap(Date.<jk>class</jk>, String.<jk>class</jk>, <jv>x</jv> -&gt; <jsm>format</jsm>(<jv>x</jv>))
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-">swap</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The object type being swapped out.</dd>
<dd><code>S</code> - The object type being swapped in.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>normalClass</code> - The object type being swapped out.</dd>
<dd><code>swappedClass</code> - The object type being swapped in.</dd>
<dd><code>swapFunction</code> - The function to convert the object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-org.apache.juneau.utils.ThrowingFunction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>swap</h4>
<pre>public&nbsp;&lt;T,S&gt;&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.947">swap</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;normalClass,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;S&gt;&nbsp;swappedClass,
<a href="../../../../../org/apache/juneau/utils/ThrowingFunction.html" title="interface in org.apache.juneau.utils">ThrowingFunction</a>&lt;T,S&gt;&nbsp;swapFunction,
<a href="../../../../../org/apache/juneau/utils/ThrowingFunction.html" title="interface in org.apache.juneau.utils">ThrowingFunction</a>&lt;S,T&gt;&nbsp;unswapFunction)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-org.apache.juneau.utils.ThrowingFunction-">BeanContextable.Builder</a></code></span></div>
<div class="block">A shortcut for defining a <a href="../../../../../org/apache/juneau/swap/FunctionalSwap.html" title="class in org.apache.juneau.swap"><code>FunctionalSwap</code></a>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that performs a custom format for Date objects.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.swap(Date.<jk>class</jk>, String.<jk>class</jk>, <jv>x</jv> -&gt; <jsm>format</jsm>(<jv>x</jv>), <jv>x</jv> -&gt; <jsm>parse</jsm>(<jv>x</jv>))
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swap-java.lang.Class-java.lang.Class-org.apache.juneau.utils.ThrowingFunction-org.apache.juneau.utils.ThrowingFunction-">swap</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - The object type being swapped out.</dd>
<dd><code>S</code> - The object type being swapped in.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>normalClass</code> - The object type being swapped out.</dd>
<dd><code>swappedClass</code> - The object type being swapped in.</dd>
<dd><code>swapFunction</code> - The function to convert the object during serialization.</dd>
<dd><code>unswapFunction</code> - The function to convert the object during parsing.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="swaps-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>swaps</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.953">swaps</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#swaps-java.lang.Class...-">BeanContextable.Builder</a></code></span></div>
<div class="block">Java object swaps.
<p>
Swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization,
and "swap in" the non-serializable class during parsing.
<p>
An example of a swap would be a <c>Calendar</c> object that gets swapped out for an ISO8601 string.
<p>
Multiple swaps can be associated with a single class.
When multiple swaps are applicable to the same class, the media type pattern defined by
<a href="../../../../../org/apache/juneau/swap/ObjectSwap.html#forMediaTypes--"><code>ObjectSwap.forMediaTypes()</code></a> or <a href="../../../../../org/apache/juneau/annotation/Swap.html#mediaTypes--"><code>@Swap(mediaTypes)</code></a> are used to come up with the best match.
<p>
Values can consist of any of the following types:
<ul>
<li>Any subclass of <a href="../../../../../org/apache/juneau/swap/ObjectSwap.html" title="class in org.apache.juneau.swap"><code>ObjectSwap</code></a>.
<li>Any instance of <a href="../../../../../org/apache/juneau/swap/ObjectSwap.html" title="class in org.apache.juneau.swap"><code>ObjectSwap</code></a>.
<li>Any surrogate class. A shortcut for defining a <a href="../../../../../org/apache/juneau/swap/SurrogateSwap.html" title="class in org.apache.juneau.swap"><code>SurrogateSwap</code></a>.
<li>Any array or collection of the objects above.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Sample swap for converting Dates to ISO8601 strings.</jc>
<jk>public class</jk> MyDateSwap <jk>extends</jk> StringSwap&lt;Date&gt; {
<jc>// ISO8601 formatter.</jc>
<jk>private</jk> DateFormat <jf>format</jf> = <jk>new</jk> SimpleDateFormat(<js>"yyyy-MM-dd'T'HH:mm:ssZ"</js>);
<ja>@Override</ja>
<jk>public</jk> String swap(BeanSession <jv>session</jv>, Date <jv>date</jv>) {
<jk>return</jk> <jf>format</jf>.format(<jv>date</jv>);
}
<ja>@Override</ja>
<jk>public</jk> Date unswap(BeanSession <jv>session</jv>, String <jv>string</jv>, ClassMeta <jv>hint</jv>) <jk>throws</jk> Exception {
<jk>return</jk> <jf>format</jf>.parse(<jv>string</jv>);
}
}
<jc>// Sample bean with a Date field.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> Date <jf>date</jf> = <jk>new</jk> Date(112, 2, 3, 4, 5, 6);
}
<jc>// Create a serializer that uses our date swap.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.swaps(MyDateSwap.<jk>class</jk>)
.build();
<jc>// Produces: {"date":"2012-03-03T04:05:06-0500"}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Create a serializer that uses our date swap.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.swaps(MyDateSwap.<jk>class</jk>)
.build();
<jc>// Use our parser to parse a bean.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<jv>json</jv>, MyBean.<jk>class</jk>);
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Swap.html" title="annotation in org.apache.juneau.annotation"><code>@Swap</code></a> annotation can also be used on classes to identify swaps for the class.
<li class='note'>The <a href="../../../../../org/apache/juneau/annotation/Swap.html" title="annotation in org.apache.juneau.annotation"><code>@Swap</code></a> annotation can also be used on bean methods and fields to identify swaps for values of those bean properties.
</ul>
<ul class='seealso'>
<li class='jf'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#swaps-java.lang.Class...-"><code>BeanContext.Builder.swaps(Class...)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-">swaps</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this setting.
<br>Values can consist of any of the following types:
<ul>
<li>Any subclass of <a href="../../../../../org/apache/juneau/swap/ObjectSwap.html" title="class in org.apache.juneau.swap"><code>ObjectSwap</code></a>.
<li>Any surrogate class. A shortcut for defining a <a href="../../../../../org/apache/juneau/swap/SurrogateSwap.html" title="class in org.apache.juneau.swap"><code>SurrogateSwap</code></a>.
<li>Any array or collection of the objects above.
</ul></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="timeZone-java.util.TimeZone-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeZone</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.959">timeZone</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html?is-external=true" title="class or interface in java.util">TimeZone</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#timeZone-java.util.TimeZone-">BeanContextable.Builder</a></code></span></div>
<div class="block"><i><l>Context</l> configuration property:&emsp;</i> TimeZone.
<p>
Specifies the default time zone for serializer and parser sessions when not specified via <a href="../../../../../org/apache/juneau/BeanSession.Builder.html#timeZone-java.util.TimeZone-"><code>BeanSession.Builder.timeZone(TimeZone)</code></a>.
Typically used for POJO swaps that need to deal with timezones such as swaps that convert <l>Date</l> and <l>Calendar</l>
objects to strings by accessing it via the session passed into the <a href="../../../../../org/apache/juneau/swap/ObjectSwap.html#swap-org.apache.juneau.BeanSession-T-"><code>ObjectSwap.swap(BeanSession, Object)</code></a> and
<a href="../../../../../org/apache/juneau/swap/ObjectSwap.html#unswap-org.apache.juneau.BeanSession-S-org.apache.juneau.ClassMeta-java.lang.String-"><code>ObjectSwap.unswap(BeanSession, Object, ClassMeta, String)</code></a> methods.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define a POJO swap that skips serializing beans if the time zone is GMT.</jc>
<jk>public class</jk> MyBeanSwap <jk>extends</jk> StringSwap&lt;MyBean&gt; {
<ja>@Override</ja>
<jk>public</jk> String swap(BeanSession <jv>session</jv>, MyBean <jv>bean</jv>) <jk>throws</jk> Exception {
<jk>if</jk> (<jv>session</jv>.getTimeZone().equals(TimeZone.<jsf>GMT</jsf>))
<jk>return null</jk>;
<jk>return</jk> <jv>bean</jv>.toString();
}
}
<jc>// Create a serializer that uses GMT if the timezone is not specified in the session args.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.timeZone(TimeZone.<jsf>GMT</jsf>)
.build();
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#timeZone--"><code>BeanConfig.timeZone()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#timeZone-java.util.TimeZone-"><code>BeanContext.Builder.timeZone(TimeZone)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanSession.Builder.html#timeZone-java.util.TimeZone-"><code>BeanSession.Builder.timeZone(TimeZone)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#timeZone-java.util.TimeZone-">timeZone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="typeName-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typeName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.965">typeName</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#typeName-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">An identifying name for this class.
<p>
The name is used to identify the class type during parsing when it cannot be inferred through reflection.
For example, if a bean property is of type <c>Object</c>, then the serializer will add the name to the
output so that the class can be determined during parsing.
<p>
It is also used to specify element names in XML.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Use _type='mybean' to identify this bean.</jc>
<jk>public class</jk> MyBean {...}
<jc>// Create a serializer and specify the type name..</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.typeName(MyBean.<jk>class</jk>, <js>"mybean"</js>)
.build();
<jc>// Produces: {"_type":"mybean",...}</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='notes'>
<li class='note'>Equivalent to the <a href="../../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean(typeName)</code></a> annotation.
</ul>
<ul class='seealso'>
<li class='jc'><a href="../../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean(typeName)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#beanDictionary-java.lang.Class...-"><code>BeanContext.Builder.beanDictionary(Class...)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#typeName-java.lang.Class-java.lang.String-">typeName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class the type name is being defined on.</dd>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="typePropertyName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typePropertyName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.971">typePropertyName</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#typePropertyName-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean type property name.
<p>
This specifies the name of the bean property used to store the dictionary name of a bean type so that the
parser knows the data type to reconstruct.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// POJOs with @Bean(name) annotations.</jc>
<ja>@Bean</ja>(typeName=<js>"foo"</js>)
<jk>public class</jk> Foo {...}
<ja>@Bean</ja>(typeName=<js>"bar"</js>)
<jk>public class</jk> Bar {...}
<jc>// Create a serializer that uses 't' instead of '_type' for dictionary names.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.typePropertyName(<js>"t"</js>)
.dictionary(Foo.<jk>class</jk>, Bar.<jk>class</jk>)
.build();
<jc>// Create a serializer that uses 't' instead of '_type' for dictionary names.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.typePropertyName(<js>"t"</js>)
.dictionary(Foo.<jk>class</jk>, Bar.<jk>class</jk>)
.build();
<jc>// A bean with a field with an indeterminate type.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> Object <jf>mySimpleField</jf>;
}
<jc>// Produces "{mySimpleField:{t:'foo',...}}".</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
<jc>// Parse bean.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<jv>json</jv>, MyBean.<jk>class</jk>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#typePropertyName--"><code>Bean.typePropertyName()</code></a>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/BeanConfig.html#typePropertyName--"><code>BeanConfig.typePropertyName()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#typePropertyName-java.lang.String-"><code>BeanContext.Builder.typePropertyName(String)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#typePropertyName-java.lang.String-">typePropertyName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <js>"_type"</js>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="typePropertyName-java.lang.Class-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typePropertyName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.977">typePropertyName</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;on,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#typePropertyName-java.lang.Class-java.lang.String-">BeanContextable.Builder</a></code></span></div>
<div class="block">Bean type property name.
<p>
Same as <a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#typePropertyName-java.lang.String-"><code>BeanContextable.Builder.typePropertyName(String)</code></a> except targets a specific bean class instead of globally.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// POJOs with @Bean(name) annotations.</jc>
<ja>@Bean</ja>(typeName=<js>"foo"</js>)
<jk>public class</jk> Foo {...}
<ja>@Bean</ja>(typeName=<js>"bar"</js>)
<jk>public class</jk> Bar {...}
<jc>// A bean with a field with an indeterminate type.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> Object <jf>mySimpleField</jf>;
}
<jc>// Create a serializer that uses 't' instead of '_type' for dictionary names.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.typePropertyName(MyBean.<jk>class</jk>, <js>"t"</js>)
.dictionary(Foo.<jk>class</jk>, Bar.<jk>class</jk>)
.build();
<jc>// Produces "{mySimpleField:{t:'foo',...}}".</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../../../org/apache/juneau/annotation/Bean.html#typePropertyName--"><code>Bean(typePropertyName)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#typePropertyName-java.lang.String-"><code>BeanContext.Builder.typePropertyName(String)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#typePropertyName-java.lang.Class-java.lang.String-">typePropertyName</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>on</code> - The class the type property name applies to.</dd>
<dd><code>value</code> - The new value for this setting.
<br>The default is <js>"_type"</js>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="useEnumNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useEnumNames</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.983">useEnumNames</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#useEnumNames--">BeanContextable.Builder</a></code></span></div>
<div class="block">Use enum names.
<p>
When enabled, enums are always serialized by name, not using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer with debug enabled.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.useEnumNames()
.build();
<jc>// Enum with overridden toString().</jc>
<jc>// Will be serialized as ONE/TWO/THREE even though there's a toString() method.</jc>
<jk>public enum</jk> Option {
<jsf>ONE</jsf>(1),
<jsf>TWO</jsf>(2),
<jsf>THREE</jsf>(3);
<jk>private int</jk> <jf>value</jf>;
Option(<jk>int</jk> <jv>value</jv>) {
<jk>this</jk>.<jf>value</jf> = <jv>value</jv>;
}
<ja>@Override</ja>
<jk>public</jk> String toString() {
<jk>return</jk> String.<jsm>valueOf</jsm>(<jf>value</jf>);
}
}
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#useEnumNames--"><code>BeanContext.Builder.useEnumNames()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#useEnumNames--">useEnumNames</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="useJavaBeanIntrospector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useJavaBeanIntrospector</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.989">useJavaBeanIntrospector</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/BeanContextable.Builder.html#useJavaBeanIntrospector--">BeanContextable.Builder</a></code></span></div>
<div class="block">Use Java Introspector.
<p>
Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
<br>Most <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations will be ignored.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that only uses the built-in java bean introspector for finding properties.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.useJavaBeanIntrospector()
.build();
</p>
<ul class='seealso'>
<li class='jmf'><a href="../../../../../org/apache/juneau/BeanContext.Builder.html#useJavaBeanIntrospector--"><code>BeanContext.Builder.useJavaBeanIntrospector()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#useJavaBeanIntrospector--">useJavaBeanIntrospector</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="accept-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.995">accept</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#accept-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Appends an <c>Accept</c> header on this request.
<p>
This is a shortcut for calling <c>headerData().append(Accept.<jsm>of</jsm>(<jv>value</jv>))</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#accept-java.lang.String-">accept</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new header value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="acceptCharset-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptCharset</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1001">acceptCharset</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#acceptCharset-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Sets the value for the <c>Accept-Charset</c> request header on all requests.
<p>
This is a shortcut for calling <c>headerData().append(AcceptCharset.<jsm>of</jsm>(<jv>value</jv>))</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#acceptCharset-java.lang.String-">acceptCharset</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new header value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="addBeanTypes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addBeanTypes</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1007">addBeanTypes</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addBeanTypes--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Add <js>"_type"</js> properties when needed.
<p>
When enabled, <js>"_type"</js> properties will be added to beans if their type cannot be inferred
through reflection.
<p>
This is used to recreate the correct objects during parsing if the object types cannot be inferred.
<br>For example, when serializing a <c>Map&lt;String,Object&gt;</c> field where the bean class cannot be determined from
the type of the values.
<p>
Note the differences between the following settings:
<ul class='javatree'>
<li class='jf'><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addRootType--"><code>RestClient.Builder.addRootType()</code></a> - Affects whether <js>'_type'</js> is added to root node.
<li class='jf'><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addBeanTypes--"><code>RestClient.Builder.addBeanTypes()</code></a> - Affects whether <js>'_type'</js> is added to any nodes.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a JSON client that adds _type to nodes in the request body.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.addBeanTypes()
.build();
<jc>// Our map of beans to serialize.</jc>
<ja>@Bean</ja>(typeName=<js>"mybean"</js>)
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
AMap <jv>map</jv> = AMap.of(<js>"foo"</js>, <jk>new</jk> MyBean());
<jc>// Request body will contain: {"foo":{"_type":"mybean","foo":"bar"}}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>map</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#addBeanTypes--"><code>Serializer.Builder.addBeanTypes()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addBeanTypes--">addBeanTypes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="addInterceptorFirst-org.apache.http.HttpRequestInterceptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInterceptorFirst</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1013">addInterceptorFirst</a>(org.apache.http.HttpRequestInterceptor&nbsp;itcp)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorFirst-org.apache.http.HttpRequestInterceptor-">RestClient.Builder</a></code></span></div>
<div class="block">Adds this protocol interceptor to the head of the protocol processing list.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorFirst-org.apache.http.HttpRequestInterceptor-">addInterceptorFirst</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>itcp</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.addInterceptorFirst(HttpRequestInterceptor)</code></dd>
</dl>
</li>
</ul>
<a name="addInterceptorFirst-org.apache.http.HttpResponseInterceptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInterceptorFirst</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1019">addInterceptorFirst</a>(org.apache.http.HttpResponseInterceptor&nbsp;itcp)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorFirst-org.apache.http.HttpResponseInterceptor-">RestClient.Builder</a></code></span></div>
<div class="block">Adds this protocol interceptor to the head of the protocol processing list.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorFirst-org.apache.http.HttpResponseInterceptor-">addInterceptorFirst</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>itcp</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.addInterceptorFirst(HttpResponseInterceptor)</code></dd>
</dl>
</li>
</ul>
<a name="addInterceptorLast-org.apache.http.HttpRequestInterceptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInterceptorLast</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1025">addInterceptorLast</a>(org.apache.http.HttpRequestInterceptor&nbsp;itcp)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorLast-org.apache.http.HttpRequestInterceptor-">RestClient.Builder</a></code></span></div>
<div class="block">Adds this protocol interceptor to the tail of the protocol processing list.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorLast-org.apache.http.HttpRequestInterceptor-">addInterceptorLast</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>itcp</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.addInterceptorLast(HttpRequestInterceptor)</code></dd>
</dl>
</li>
</ul>
<a name="addInterceptorLast-org.apache.http.HttpResponseInterceptor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInterceptorLast</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1031">addInterceptorLast</a>(org.apache.http.HttpResponseInterceptor&nbsp;itcp)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorLast-org.apache.http.HttpResponseInterceptor-">RestClient.Builder</a></code></span></div>
<div class="block">Adds this protocol interceptor to the tail of the protocol processing list.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addInterceptorLast-org.apache.http.HttpResponseInterceptor-">addInterceptorLast</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>itcp</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.addInterceptorLast(HttpResponseInterceptor)</code></dd>
</dl>
</li>
</ul>
<a name="addRootType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRootType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1037">addRootType</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addRootType--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Add type attribute to root nodes.
<p>
When enabled, <js>"_type"</js> properties will be added to top-level beans.
<p>
When disabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level
type information that might normally be included to determine the data type will not be serialized.
<p>
For example, when serializing a top-level POJO with a <a href="../../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>@Bean(typeName)</code></a> value, a
<js>'_type'</js> attribute will only be added when this setting is enabled.
<p>
Note the differences between the following settings:
<ul class='javatree'>
<li class='jf'><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addRootType--"><code>RestClient.Builder.addRootType()</code></a> - Affects whether <js>'_type'</js> is added to root node.
<li class='jf'><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addBeanTypes--"><code>RestClient.Builder.addBeanTypes()</code></a> - Affects whether <js>'_type'</js> is added to any nodes.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a JSON client that adds _type to root node.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.addRootType()
.build();
<jc>// Our bean to serialize.</jc>
<ja>@Bean</ja>(typeName=<js>"mybean"</js>)
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Request body will contain: {"_type":"mybean","foo":"bar"}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#addRootType--"><code>Serializer.Builder.addRootType()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#addRootType--">addRootType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="backoffManager-org.apache.http.client.BackoffManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backoffManager</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1043">backoffManager</a>(org.apache.http.client.BackoffManager&nbsp;backoffManager)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#backoffManager-org.apache.http.client.BackoffManager-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>BackoffManager</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#backoffManager-org.apache.http.client.BackoffManager-">backoffManager</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>backoffManager</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setBackoffManager(BackoffManager)</code></dd>
</dl>
</li>
</ul>
<a name="basicAuth-java.lang.String-int-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>basicAuth</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1049">basicAuth</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;host,
int&nbsp;port,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pw)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#basicAuth-java.lang.String-int-java.lang.String-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Set up this client to use BASIC auth.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses BASIC authentication.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.basicAuth(<js>"http://localhost"</js>, 80, <js>"me"</js>, <js>"mypassword"</js>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#basicAuth-java.lang.String-int-java.lang.String-java.lang.String-">basicAuth</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>host</code> - The auth scope hostname.</dd>
<dd><code>port</code> - The auth scope port.</dd>
<dd><code>user</code> - The username.</dd>
<dd><code>pw</code> - The password.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="callHandler-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>callHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1055">callHandler</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/rest/client/RestCallHandler.html" title="interface in org.apache.juneau.rest.client">RestCallHandler</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#callHandler-java.lang.Class-">RestClient.Builder</a></code></span></div>
<div class="block">REST call handler class.
<p>
Specifies a custom handler for making HTTP calls.
<p>
This is a shortcut for <c>callHandler().type(<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#callHandler-java.lang.Class-">callHandler</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#callHandler--"><code>RestClient.Builder.callHandler()</code></a></dd>
</dl>
</li>
</ul>
<a name="clientVersion-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clientVersion</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1061">clientVersion</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#clientVersion-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Sets the client version by setting the value for the <js>"Client-Version"</js> header.
<p>
This is a shortcut for calling <c>headerData().append(ClientVersion.<jsm>of</jsm>(<jv>value</jv>))</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#clientVersion-java.lang.String-">clientVersion</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The version string (e.g. <js>"1.2.3"</js>)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="connectionBackoffStrategy-org.apache.http.client.ConnectionBackoffStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionBackoffStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1067">connectionBackoffStrategy</a>(org.apache.http.client.ConnectionBackoffStrategy&nbsp;connectionBackoffStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionBackoffStrategy-org.apache.http.client.ConnectionBackoffStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>ConnectionBackoffStrategy</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionBackoffStrategy-org.apache.http.client.ConnectionBackoffStrategy-">connectionBackoffStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionBackoffStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setConnectionBackoffStrategy(ConnectionBackoffStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="connectionManager-org.apache.http.conn.HttpClientConnectionManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionManager</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1073">connectionManager</a>(org.apache.http.conn.HttpClientConnectionManager&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>HttpClientConnectionManager</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-">connectionManager</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setConnectionManager(HttpClientConnectionManager)</code></dd>
</dl>
</li>
</ul>
<a name="connectionManagerShared-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionManagerShared</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1079">connectionManagerShared</a>(boolean&nbsp;shared)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManagerShared-boolean-">RestClient.Builder</a></code></span></div>
<div class="block">Defines the connection manager is to be shared by multiple client instances.
<ul class='notes'>
<li class='note'>If the connection manager is shared its life-cycle is expected to be managed by the caller and it will not be shut down if the client is closed.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManagerShared-boolean-">connectionManagerShared</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shared</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setConnectionManagerShared(boolean)</code></dd>
</dl>
</li>
</ul>
<a name="connectionReuseStrategy-org.apache.http.ConnectionReuseStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionReuseStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1085">connectionReuseStrategy</a>(org.apache.http.ConnectionReuseStrategy&nbsp;reuseStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionReuseStrategy-org.apache.http.ConnectionReuseStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>ConnectionReuseStrategy</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionReuseStrategy-org.apache.http.ConnectionReuseStrategy-">connectionReuseStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reuseStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setConnectionReuseStrategy(ConnectionReuseStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="connectionTimeToLive-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionTimeToLive</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1091">connectionTimeToLive</a>(long&nbsp;connTimeToLive,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;connTimeToLiveTimeUnit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionTimeToLive-long-java.util.concurrent.TimeUnit-">RestClient.Builder</a></code></span></div>
<div class="block">Sets maximum time to live for persistent connections.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionTimeToLive-long-java.util.concurrent.TimeUnit-">connectionTimeToLive</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connTimeToLive</code> - New property value.</dd>
<dd><code>connTimeToLiveTimeUnit</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setConnectionTimeToLive(long,TimeUnit)</code></dd>
</dl>
</li>
</ul>
<a name="console-java.io.PrintStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>console</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1097">console</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#console-java.io.PrintStream-">RestClient.Builder</a></code></span></div>
<div class="block">Console print stream
<p>
Allows you to redirect the console output to a different print stream.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#console-java.io.PrintStream-">console</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="contentDecoderRegistry-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentDecoderRegistry</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1103">contentDecoderRegistry</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,org.apache.http.client.entity.InputStreamFactory&gt;&nbsp;contentDecoderMap)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#contentDecoderRegistry-java.util.Map-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns a map of <code>InputStreamFactories</code> to be used for automatic content decompression.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#contentDecoderRegistry-java.util.Map-">contentDecoderRegistry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contentDecoderMap</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setContentDecoderRegistry(Map)</code></dd>
</dl>
</li>
</ul>
<a name="contentType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contentType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1109">contentType</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#contentType-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Sets the value for the <c>Content-Type</c> request header on all requests.
<p>
This is a shortcut for calling <c>headerData().append(ContentType.<jsm>of</jsm>(<jv>value</jv>))</c>.
<p>
This overrides the media type specified on the serializer.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#contentType-java.lang.String-">contentType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new header value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="debugOutputLines-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debugOutputLines</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1115">debugOutputLines</a>(int&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#debugOutputLines-int-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Parser</l> configuration property:&emsp;</i> Debug output lines.
<p>
When parse errors occur, this specifies the number of lines of input before and after the
error location to be printed as part of the exception message.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a parser whose exceptions print out 100 lines before and after the parse error location.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.debug() <jc>// Enable debug mode to capture Reader contents as strings.</jc>
.debugOuputLines(100)
.build();
<jc>// Try to parse some bad JSON.</jc>
<jk>try</jk> {
<jv>client</jv>
.get(<js>"/pathToBadJson"</js>)
.run()
.getContent().as(Object.<jk>class</jk>); <jc>// Try to parse it.</jc>
} <jk>catch</jk> (RestCallException <jv>e</jv>) {
System.<jsf>err</jsf>.println(<jv>e</jv>.getMessage()); <jc>// Will display 200 lines of the output.</jc>
}
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/parser/Parser.Builder.html#debugOutputLines-int-"><code>Parser.Builder.debugOutputLines(int)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#debugOutputLines-int-">debugOutputLines</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default value is <c>5</c>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="defaultAuthSchemeRegistry-org.apache.http.config.Lookup-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultAuthSchemeRegistry</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1121">defaultAuthSchemeRegistry</a>(org.apache.http.config.Lookup&lt;org.apache.http.auth.AuthSchemeProvider&gt;&nbsp;authSchemeRegistry)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultAuthSchemeRegistry-org.apache.http.config.Lookup-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>AuthScheme</code> registry which will be used for request execution if not explicitly set in the client execution context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultAuthSchemeRegistry-org.apache.http.config.Lookup-">defaultAuthSchemeRegistry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authSchemeRegistry</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultAuthSchemeRegistry(Lookup)</code></dd>
</dl>
</li>
</ul>
<a name="defaultConnectionConfig-org.apache.http.config.ConnectionConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultConnectionConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1127">defaultConnectionConfig</a>(org.apache.http.config.ConnectionConfig&nbsp;config)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultConnectionConfig-org.apache.http.config.ConnectionConfig-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>ConnectionConfig</code>.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultConnectionConfig-org.apache.http.config.ConnectionConfig-">defaultConnectionConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultConnectionConfig(ConnectionConfig)</code></dd>
</dl>
</li>
</ul>
<a name="defaultCookieSpecRegistry-org.apache.http.config.Lookup-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCookieSpecRegistry</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1133">defaultCookieSpecRegistry</a>(org.apache.http.config.Lookup&lt;org.apache.http.cookie.CookieSpecProvider&gt;&nbsp;cookieSpecRegistry)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultCookieSpecRegistry-org.apache.http.config.Lookup-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>CookieSpec</code> registry which will be used for request execution if not explicitly set in the client execution context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultCookieSpecRegistry-org.apache.http.config.Lookup-">defaultCookieSpecRegistry</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cookieSpecRegistry</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultCookieSpecRegistry(Lookup)</code></dd>
</dl>
</li>
</ul>
<a name="defaultCookieStore-org.apache.http.client.CookieStore-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCookieStore</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1139">defaultCookieStore</a>(org.apache.http.client.CookieStore&nbsp;cookieStore)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultCookieStore-org.apache.http.client.CookieStore-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>CookieStore</code> instance which will be used for request execution if not explicitly set in the client execution context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultCookieStore-org.apache.http.client.CookieStore-">defaultCookieStore</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cookieStore</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultCookieStore(CookieStore)</code></dd>
</dl>
</li>
</ul>
<a name="defaultCredentialsProvider-org.apache.http.client.CredentialsProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultCredentialsProvider</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1145">defaultCredentialsProvider</a>(org.apache.http.client.CredentialsProvider&nbsp;credentialsProvider)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultCredentialsProvider-org.apache.http.client.CredentialsProvider-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>CredentialsProvider</code> instance which will be used for request execution if not explicitly set in the client execution context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultCredentialsProvider-org.apache.http.client.CredentialsProvider-">defaultCredentialsProvider</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>credentialsProvider</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultCredentialsProvider(CredentialsProvider)</code></dd>
</dl>
</li>
</ul>
<a name="defaultRequestConfig-org.apache.http.client.config.RequestConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultRequestConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1151">defaultRequestConfig</a>(org.apache.http.client.config.RequestConfig&nbsp;config)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultRequestConfig-org.apache.http.client.config.RequestConfig-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>RequestConfig</code> instance which will be used for request execution if not explicitly set in the client execution context.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultRequestConfig-org.apache.http.client.config.RequestConfig-">defaultRequestConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultRequestConfig(RequestConfig)</code></dd>
</dl>
</li>
</ul>
<a name="defaultSocketConfig-org.apache.http.config.SocketConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>defaultSocketConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1157">defaultSocketConfig</a>(org.apache.http.config.SocketConfig&nbsp;config)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultSocketConfig-org.apache.http.config.SocketConfig-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default <code>SocketConfig</code>.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#defaultSocketConfig-org.apache.http.config.SocketConfig-">defaultSocketConfig</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setDefaultSocketConfig(SocketConfig)</code></dd>
</dl>
</li>
</ul>
<a name="detectLeaks--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detectLeaks</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1163">detectLeaks</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#detectLeaks--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Enable leak detection.
<p>
Enable client and request/response leak detection.
<p>
Causes messages to be logged to the console if clients or request/response objects are not properly closed
when the <c>finalize</c> methods are invoked.
<p>
Automatically enabled with <a href="../../../../../org/apache/juneau/Context.Builder.html#debug--"><code>Context.Builder.debug()</code></a>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that logs a message if </jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.detectLeaks()
.logToConsole() <jc>// Also log the error message to System.err</jc>
.build();
<jv>client</jv>.closeQuietly(); <jc>// Customized HttpClient won't be closed.</jc>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#detectLeaks--">detectLeaks</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="detectRecursions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detectRecursions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1169">detectRecursions</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#detectRecursions--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Automatically detect POJO recursions.
<p>
When enabled, specifies that recursions should be checked for during traversal.
<p>
Recursions can occur when traversing models that aren't true trees but rather contain loops.
<br>In general, unchecked recursions cause stack-overflow-errors.
<br>These show up as <a href="../../../../../org/apache/juneau/BeanRecursionException.html" title="class in org.apache.juneau"><code>BeanRecursionException</code></a> with the message <js>"Depth too deep. Stack overflow occurred."</js>.
<ul class='notes'>
<li class='note'>
Checking for recursion can cause a small performance penalty.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a JSON client that automatically checks for recursions.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.detectRecursions()
.build();
<jc>// Create a POJO model with a recursive loop.</jc>
<jk>public class</jk> A {
<jk>public</jk> Object <jf>f</jf>;
}
A <jv>a</jv> = <jk>new</jk> A();
<jv>a</jv>.<jf>f</jf> = <jv>a</jv>;
<jk>try</jk> {
<jc>// Throws a RestCallException with an inner SerializeException and not a StackOverflowError</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>a</jv>)
.run();
} <jk>catch</jk> (RestCallException <jv>e</jv>} {
<jc>// Handle exception.</jc>
}
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanTraverseContext.Builder.html#detectRecursions--"><code>BeanTraverseContext.Builder.detectRecursions()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#detectRecursions--">detectRecursions</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="disableAuthCaching--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableAuthCaching</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1175">disableAuthCaching</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableAuthCaching--">RestClient.Builder</a></code></span></div>
<div class="block">Disables authentication scheme caching.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableAuthCaching--">disableAuthCaching</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.disableAuthCaching()</code></dd>
</dl>
</li>
</ul>
<a name="disableAutomaticRetries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableAutomaticRetries</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1181">disableAutomaticRetries</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableAutomaticRetries--">RestClient.Builder</a></code></span></div>
<div class="block">Disables automatic request recovery and re-execution.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableAutomaticRetries--">disableAutomaticRetries</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.disableAutomaticRetries()</code></dd>
</dl>
</li>
</ul>
<a name="disableConnectionState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableConnectionState</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1187">disableConnectionState</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableConnectionState--">RestClient.Builder</a></code></span></div>
<div class="block">Disables connection state tracking.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableConnectionState--">disableConnectionState</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.disableConnectionState()</code></dd>
</dl>
</li>
</ul>
<a name="disableContentCompression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableContentCompression</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1193">disableContentCompression</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableContentCompression--">RestClient.Builder</a></code></span></div>
<div class="block">Disables automatic content decompression.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableContentCompression--">disableContentCompression</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.disableContentCompression()</code></dd>
</dl>
</li>
</ul>
<a name="disableCookieManagement--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableCookieManagement</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1199">disableCookieManagement</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableCookieManagement--">RestClient.Builder</a></code></span></div>
<div class="block">Disables state (cookie) management.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-"><code>RestClient.Builder.httpProcessor(HttpProcessor)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableCookieManagement--">disableCookieManagement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.disableCookieManagement()</code></dd>
</dl>
</li>
</ul>
<a name="disableRedirectHandling--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disableRedirectHandling</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1205">disableRedirectHandling</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableRedirectHandling--">RestClient.Builder</a></code></span></div>
<div class="block">Disables automatic redirect handling.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableRedirectHandling--">disableRedirectHandling</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.disableRedirectHandling()</code></dd>
</dl>
</li>
</ul>
<a name="errorCodes-java.util.function.Predicate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>errorCodes</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1211">errorCodes</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#errorCodes-java.util.function.Predicate-">RestClient.Builder</a></code></span></div>
<div class="block">Errors codes predicate.
<p>
Defines a predicate to test for error codes.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that considers any 300+ responses to be errors.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.errorCodes(<jv>x</jv> -&gt; <jv>x</jv>&gt;=300)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#errorCodes-java.util.function.Predicate-">errorCodes</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <code>x -&gt; x &gt;= 400</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="evictExpiredConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evictExpiredConnections</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1217">evictExpiredConnections</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#evictExpiredConnections--">RestClient.Builder</a></code></span></div>
<div class="block">Makes this instance of <code>HttpClient</code> proactively evict expired connections from the connection pool using a background thread.
<ul class='notes'>
<li class='note'>One MUST explicitly close HttpClient with <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io"><code>Closeable.close()</code></a> in order to stop and release the background thread.
<li class='note'>This method has no effect if the instance of <code>HttpClient</code> is configured to use a shared connection manager.
<li class='note'>This method may not be used when the instance of <code>HttpClient</code> is created inside an EJB container.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#evictExpiredConnections--">evictExpiredConnections</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.evictExpiredConnections()</code></dd>
</dl>
</li>
</ul>
<a name="evictIdleConnections-long-java.util.concurrent.TimeUnit-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evictIdleConnections</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1223">evictIdleConnections</a>(long&nbsp;maxIdleTime,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;maxIdleTimeUnit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#evictIdleConnections-long-java.util.concurrent.TimeUnit-">RestClient.Builder</a></code></span></div>
<div class="block">Makes this instance of <code>HttpClient</code> proactively evict idle connections from the connection pool using a background thread.
<ul class='notes'>
<li class='note'>One MUST explicitly close HttpClient with <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io"><code>Closeable.close()</code></a> in order to stop and release the background thread.
<li class='note'>This method has no effect if the instance of <code>HttpClient</code> is configured to use a shared connection manager.
<li class='note'>This method may not be used when the instance of <code>HttpClient</code> is created inside an EJB container.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#evictIdleConnections-long-java.util.concurrent.TimeUnit-">evictIdleConnections</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxIdleTime</code> - New property value.</dd>
<dd><code>maxIdleTimeUnit</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.evictIdleConnections(long,TimeUnit)</code></dd>
</dl>
</li>
</ul>
<a name="executorService-java.util.concurrent.ExecutorService-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executorService</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1229">executorService</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ExecutorService</a>&nbsp;executorService,
boolean&nbsp;shutdownOnClose)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#executorService-java.util.concurrent.ExecutorService-boolean-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Executor service.
<p>
Defines the executor service to use when calling future methods on the <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html" title="class in org.apache.juneau.rest.client"><code>RestRequest</code></a> class.
<p>
This executor service is used to create <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent"><code>Future</code></a> objects on the following methods:
<ul>
<li class='jm'><a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#runFuture--"><code>RestRequest.runFuture()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#completeFuture--"><code>RestRequest.completeFuture()</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/rest/client/ResponseContent.html#asFuture-java.lang.Class-"><code>ResponseContent.asFuture(Class)</code></a> (and similar methods)
</ul>
<p>
The default executor service is a single-threaded <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadPoolExecutor.html?is-external=true" title="class or interface in java.util.concurrent"><code>ThreadPoolExecutor</code></a> with a 30 second timeout
and a queue size of 10.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client with a customized executor service.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.executorService(<jk>new</jk> ThreadPoolExecutor(1, 1, 30, TimeUnit.<jsf>SECONDS</jsf>, <jk>new</jk> ArrayBlockingQueue&lt;Runnable&gt;(10)), <jk>true</jk>)
.build();
<jc>// Use it to asynchronously run a request.</jc>
Future&lt;RestResponse&gt; <jv>responseFuture</jv> = <jv>client</jv>.get(<jsf>URI</jsf>).runFuture();
<jc>// Do some other stuff.</jc>
<jc>// Now read the response.</jc>
String <jv>body</jv> = <jv>responseFuture</jv>.get().getContent().asString();
<jc>// Use it to asynchronously retrieve a response.</jc>
Future&lt;MyBean&gt; <jv>myBeanFuture</jv> = <jv>client</jv>
.get(<jsf>URI</jsf>)
.run()
.getContent().asFuture(MyBean.<jk>class</jk>);
<jc>// Do some other stuff.</jc>
<jc>// Now read the response.</jc>
MyBean <jv>bean</jv> = <jv>myBeanFuture</jv>.get();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#executorService-java.util.concurrent.ExecutorService-boolean-">executorService</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executorService</code> - The executor service.</dd>
<dd><code>shutdownOnClose</code> - Call <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true#shutdown--" title="class or interface in java.util.concurrent"><code>ExecutorService.shutdown()</code></a> when <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#close--"><code>RestClient.close()</code></a> is called.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="formData-org.apache.http.NameValuePair...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1235">formData</a>(org.apache.http.NameValuePair...&nbsp;parts)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-org.apache.http.NameValuePair...-">RestClient.Builder</a></code></span></div>
<div class="block">Appends multiple form-data parameters to the request bodies of all URL-encoded form posts.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jk>import static</jk> org.apache.juneau.http.HttpParts.*;
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.formData(
<jsm>stringPart</jsm>(<js>"foo"</js>, <js>"bar"</js>),
<jsm>booleanPart</jsm>(<js>"baz"</js>, <jk>true</jk>)
)
.build();
</p>
<p>
This is a shortcut for calling <c>formData().append(<jv>parts</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-org.apache.http.NameValuePair...-">formData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parts</code> - The form-data parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData--"><code>RestClient.Builder.formData()</code></a></dd>
</dl>
</li>
</ul>
<a name="formData-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1241">formData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-java.lang.String-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a form-data parameter to all request bodies.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.formData(<js>"foo"</js>, <js>"bar"</js>)
.build();
</p>
<p>
This is a shortcut for calling <c>formData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-java.lang.String-java.lang.String-">formData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The parameter name.</dd>
<dd><code>value</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData--"><code>RestClient.Builder.formData()</code></a></dd>
</dl>
</li>
</ul>
<a name="formData-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1247">formData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-java.lang.String-java.util.function.Supplier-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a form-data parameter with a dynamic value to all request bodies.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.formData(<js>"foo"</js>, ()-&gt;<js>"bar"</js>)
.build();
</p>
<p>
This is a shortcut for calling <c>formData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData-java.lang.String-java.util.function.Supplier-">formData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The parameter name.</dd>
<dd><code>value</code> - The parameter value supplier.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#formData--"><code>RestClient.Builder.formData()</code></a></dd>
</dl>
</li>
</ul>
<a name="header-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1253">header</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#header-java.lang.String-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a header to all requests.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.header(<js>"Foo"</js>, <js>"bar"</js>);
.build();
</p>
<p>
This is a shortcut for calling <c>headerData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#header-java.lang.String-java.lang.String-">header</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dd><code>value</code> - The header value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="header-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1259">header</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#header-java.lang.String-java.util.function.Supplier-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a header to all requests using a dynamic value.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.header(<js>"Foo"</js>, ()-&gt;<js>"bar"</js>);
.build();
</p>
<p>
This is a shortcut for calling <c>headerData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#header-java.lang.String-java.util.function.Supplier-">header</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The header name.</dd>
<dd><code>value</code> - The header value supplier.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="headers-org.apache.http.Header...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1265">headers</a>(org.apache.http.Header...&nbsp;parts)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers-org.apache.http.Header...-">RestClient.Builder</a></code></span></div>
<div class="block">Appends multiple headers to all requests.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jk>import static</jk> org.apache.juneau.http.HttpHeaders.*;
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.headers(
<jsf>ACCEPT_TEXT_XML</jsf>,
<jsm>stringHeader</jsm>(<js>"Foo"</js>, <js>"bar"</js>)
)
.build();
</p>
<p>
This is a shortcut for calling <c>headerData().append(<jv>parts</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers-org.apache.http.Header...-">headers</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parts</code> - The header to set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="html--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>html</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1271">html</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#html--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying HTML as the marshalling transmission media type.
<p>
POJOs are converted to HTML without any sort of doc wrappers.
<p>
<a href="../../../../../org/apache/juneau/html/HtmlSerializer.html" title="class in org.apache.juneau.html"><code>HtmlSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/html/HtmlParser.html" title="class in org.apache.juneau.html"><code>HtmlParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/html"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/html"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(HtmlSerializer.<jk>class</jk>).parser(HtmlParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses HTML marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().html().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#html--">html</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="htmlDoc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>htmlDoc</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1277">htmlDoc</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#htmlDoc--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying HTML DOC as the marshalling transmission media type.
<p>
POJOs are converted to fully renderable HTML pages.
<p>
<a href="../../../../../org/apache/juneau/html/HtmlDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlDocSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a> or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/html/HtmlParser.html" title="class in org.apache.juneau.html"><code>HtmlParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/html"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/html"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(HtmlDocSerializer.<jk>class</jk>).parser(HtmlParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses HTML Doc marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().htmlDoc().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#htmlDoc--">htmlDoc</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="htmlStrippedDoc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>htmlStrippedDoc</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1283">htmlStrippedDoc</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#htmlStrippedDoc--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying Stripped HTML DOC as the marshalling transmission media type.
<p>
Same as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#htmlDoc--"><code>RestClient.Builder.htmlDoc()</code></a> but without the header and body tags and page title and description.
<p>
<a href="../../../../../org/apache/juneau/html/HtmlStrippedDocSerializer.html" title="class in org.apache.juneau.html"><code>HtmlStrippedDocSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/html/HtmlParser.html" title="class in org.apache.juneau.html"><code>HtmlParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/html+stripped"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/html+stripped"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(HtmlStrippedDocSerializer.<jk>class</jk>).parser(HtmlParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses HTML Stripped Doc marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().htmlStrippedDoc().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#htmlStrippedDoc--">htmlStrippedDoc</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="httpClient-org.apache.http.impl.client.CloseableHttpClient-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>httpClient</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1289">httpClient</a>(org.apache.http.impl.client.CloseableHttpClient&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpClient-org.apache.http.impl.client.CloseableHttpClient-">RestClient.Builder</a></code></span></div>
<div class="block">Sets the <code>HttpClient</code> to be used to handle all HTTP communications with the target server.
<p>
This can be used to bypass the client created by <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createHttpClient--"><code>RestClient.Builder.createHttpClient()</code></a> method.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses a customized HttpClient.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.httpClient(HttpClientBuilder.<jsm>create</jsm>().build())
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpClient-org.apache.http.impl.client.CloseableHttpClient-">httpClient</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The <code>HttpClient</code> to be used to handle all HTTP communications with the target server.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="httpClientBuilder-org.apache.http.impl.client.HttpClientBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>httpClientBuilder</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1295">httpClientBuilder</a>(org.apache.http.impl.client.HttpClientBuilder&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpClientBuilder-org.apache.http.impl.client.HttpClientBuilder-">RestClient.Builder</a></code></span></div>
<div class="block">Sets the <code>HttpClientBuilder</code> that will be used to create the <code>HttpClient</code> used by <a href="../../../../../org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>.
<p>
This can be used to bypass the builder created by <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createHttpClientBuilder--"><code>RestClient.Builder.createHttpClientBuilder()</code></a> method.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses a customized HttpClientBuilder.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.httpClientBuilder(HttpClientBuilder.<jsm>create</jsm>())
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpClientBuilder-org.apache.http.impl.client.HttpClientBuilder-">httpClientBuilder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The <code>HttpClientBuilder</code> that will be used to create the <code>HttpClient</code> used by <a href="../../../../../org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="httpProcessor-org.apache.http.protocol.HttpProcessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>httpProcessor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1301">httpProcessor</a>(org.apache.http.protocol.HttpProcessor&nbsp;httpprocessor)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>HttpProcessor</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#httpProcessor-org.apache.http.protocol.HttpProcessor-">httpProcessor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>httpprocessor</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setHttpProcessor(HttpProcessor)</code></dd>
</dl>
</li>
</ul>
<a name="ignoreErrors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreErrors</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1307">ignoreErrors</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreErrors--">RestClient.Builder</a></code></span></div>
<div class="block">Ignore errors.
<p>
When enabled, HTTP error response codes (e.g. <l>&gt;=400</l>) will not cause a <a href="../../../../../org/apache/juneau/rest/client/RestCallException.html" title="class in org.apache.juneau.rest.client"><code>RestCallException</code></a> to
be thrown.
<p>
Note that this is equivalent to <c>builder.errorCodes(x -&gt; <jk>false</jk>);</c>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that doesn't throws a RestCallException when a 500 error occurs.</jc>
RestClient
.<jsm>create</jsm>()
.ignoreErrors()
.build()
.get(<js>"/error"</js>) <jc>// Throws a 500 error</jc>
.run()
.assertStatus().is(500);
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreErrors--">ignoreErrors</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="ignoreRecursions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ignoreRecursions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1313">ignoreRecursions</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreRecursions--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Ignore recursion errors.
<p>
When enabled, when we encounter the same object when traversing a tree, we set the value to <jk>null</jk>.
<p>
For example, if a model contains the links A-&gt;B-&gt;C-&gt;A, then the JSON generated will look like
the following when <jsf>BEANTRAVERSE_ignoreRecursions</jsf> is <jk>true</jk>...
<p class='bjson'>
{A:{B:{C:<jk>null</jk>}}}
</p>
<ul class='notes'>
<li class='note'>
Checking for recursion can cause a small performance penalty.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a JSON client that ignores recursions.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.ignoreRecursions()
.build();
<jc>// Create a POJO model with a recursive loop.</jc>
<jk>public class</jk> A {
<jk>public</jk> Object <jf>f</jf>;
}
A <jv>a</jv> = <jk>new</jk> A();
<jv>a</jv>.<jf>f</jf> = <jv>a</jv>;
<jc>// Produces request body "{f:null}"</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>a</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanTraverseContext.Builder.html#ignoreRecursions--"><code>BeanTraverseContext.Builder.ignoreRecursions()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ignoreRecursions--">ignoreRecursions</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="initialDepth-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialDepth</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1319">initialDepth</a>(int&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#initialDepth-int-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Initial depth.
<p>
The initial indentation level at the root.
<p>
Useful when constructing document fragments that need to be indented at a certain level when whitespace is enabled.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer with whitespace enabled and an initial depth of 2.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.ws()
.initialDepth(2)
.build();
<jc>// Our bean to serialize.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <jk>null</jk>;
}
<jc>// Produces request body "\t\t{\n\t\t\t'foo':'bar'\n\t\t}\n"</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanTraverseContext.Builder.html#initialDepth-int-"><code>BeanTraverseContext.Builder.initialDepth(int)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#initialDepth-int-">initialDepth</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <c>0</c>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="interceptors-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interceptors</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1325">interceptors</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#interceptors-java.lang.Class...-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Call interceptors.
<p>
Adds an interceptor that can be called to hook into specified events in the lifecycle of a single request.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Customized interceptor (note you can also extend from BasicRestCallInterceptor as well.</jc>
<jk>public class</jk> MyRestCallInterceptor <jk>implements</jk> RestCallInterceptor {
<ja>@Override</ja>
<jk>public void</jk> onInit(RestRequest <jv>req</jv>) <jk>throws</jk> Exception {
<jc>// Intercept immediately after RestRequest object is created and all headers/query/form-data has been
// set on the request from the client.</jc>
}
<ja>@Override</ja>
<jk>public void</jk> onConnect(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>) <jk>throws</jk> Exception {
<jc>// Intercept immediately after an HTTP response has been received.</jc>
}
<ja>@Override</ja>
<jk>public void</jk> onClose(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>) <jk>throws</jk> Exception {
<jc>// Intercept when the response body is consumed.</jc>
}
}
<jc>// Create a client with a customized interceptor.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.interceptors(MyRestCallInterceptor.<jk>class</jk>)
.build();
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#onInit-org.apache.juneau.rest.client.RestRequest-"><code>RestClient.onInit(RestRequest)</code></a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#onConnect-org.apache.juneau.rest.client.RestRequest-org.apache.juneau.rest.client.RestResponse-"><code>RestClient.onConnect(RestRequest,RestResponse)</code></a>, and
<a href="../../../../../org/apache/juneau/rest/client/RestClient.html#onClose-org.apache.juneau.rest.client.RestRequest-org.apache.juneau.rest.client.RestResponse-"><code>RestClient.onClose(RestRequest,RestResponse)</code></a> methods can also be overridden to produce the same results.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#interceptors-java.lang.Class...-">interceptors</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this setting.
<br>Can be implementations of any of the following:
<ul>
<li class='jic'><a href="../../../../../org/apache/juneau/rest/client/RestCallInterceptor.html" title="interface in org.apache.juneau.rest.client"><code>RestCallInterceptor</code></a>
<li class='jic'><code>HttpRequestInterceptor</code>
<li class='jic'><code>HttpResponseInterceptor</code>
</ul></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - If one or more interceptors could not be created.</dd>
</dl>
</li>
</ul>
<a name="interceptors-java.lang.Object...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interceptors</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1331">interceptors</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#interceptors-java.lang.Object...-">RestClient.Builder</a></code></span></div>
<div class="block">Call interceptors.
<p>
Adds an interceptor that gets called immediately after a connection is made.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client with a customized interceptor.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.interceptors(
<jk>new</jk> RestCallInterceptor() {
<ja>@Override</ja>
<jk>public void</jk> onInit(RestRequest <jv>req</jv>) <jk>throws</jk> Exception {
<jc>// Intercept immediately after RestRequest object is created and all headers/query/form-data has been
// set on the request from the client.</jc>
}
<ja>@Override</ja>
<jk>public void</jk> onConnect(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>) <jk>throws</jk> Exception {
<jc>// Intercept immediately after an HTTP response has been received.</jc>
}
<ja>@Override</ja>
<jk>public void</jk> onClose(RestRequest <jv>req</jv>, RestResponse <jv>res</jv>) <jk>throws</jk> Exception {
<jc>// Intercept when the response body is consumed.</jc>
}
}
)
.build();
</p>
<ul class='notes'>
<li class='note'>The <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#onInit-org.apache.juneau.rest.client.RestRequest-"><code>RestClient.onInit(RestRequest)</code></a>, <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#onConnect-org.apache.juneau.rest.client.RestRequest-org.apache.juneau.rest.client.RestResponse-"><code>RestClient.onConnect(RestRequest,RestResponse)</code></a>, and
<a href="../../../../../org/apache/juneau/rest/client/RestClient.html#onClose-org.apache.juneau.rest.client.RestRequest-org.apache.juneau.rest.client.RestResponse-"><code>RestClient.onClose(RestRequest,RestResponse)</code></a> methods can also be overridden to produce the same results.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#interceptors-java.lang.Object...-">interceptors</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The values to add to this setting.
<br>Can be implementations of any of the following:
<ul>
<li class='jic'><a href="../../../../../org/apache/juneau/rest/client/RestCallInterceptor.html" title="interface in org.apache.juneau.rest.client"><code>RestCallInterceptor</code></a>
<li class='jic'><code>HttpRequestInterceptor</code>
<li class='jic'><code>HttpResponseInterceptor</code>
</ul></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="json--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>json</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1337">json</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying JSON as the marshalling transmission media type.
<p>
<a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"application/json"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>}.
<p>
<c>Content-Type</c> request header will be set to <js>"application/json"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#xml--"><code>RestClient.Builder.xml()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(JsonSerializer.<jk>class</jk>).parser(JsonParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses JSON marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().json().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--">json</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="keepAliveStrategy-org.apache.http.conn.ConnectionKeepAliveStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepAliveStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1343">keepAliveStrategy</a>(org.apache.http.conn.ConnectionKeepAliveStrategy&nbsp;keepAliveStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#keepAliveStrategy-org.apache.http.conn.ConnectionKeepAliveStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>ConnectionKeepAliveStrategy</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#keepAliveStrategy-org.apache.http.conn.ConnectionKeepAliveStrategy-">keepAliveStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keepAliveStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setKeepAliveStrategy(ConnectionKeepAliveStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="keepHttpClientOpen--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepHttpClientOpen</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1349">keepHttpClientOpen</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#keepHttpClientOpen--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Keep HttpClient open.
<p>
Don't close this client when the <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#close--"><code>RestClient.close()</code></a> method is called.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client with a customized client and don't close the client service.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.httpClient(<jv>myHttpClient</jv>)
.keepHttpClientOpen()
.build();
<jv>client</jv>.closeQuietly(); <jc>// Customized HttpClient won't be closed.</jc>
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#keepHttpClientOpen--">keepHttpClientOpen</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="keepNullProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keepNullProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1355">keepNullProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#keepNullProperties--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Don't trim null bean property values.
<p>
When enabled, null bean values will be serialized to the output.
<ul class='notes'>
<li class='note'>Not enabling this setting will cause <c>Map</c>s with <jk>null</jk> values to be lost during parsing.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that serializes null properties.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.keepNullProperties()
.build();
<jc>// Our bean to serialize.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <jk>null</jk>;
}
<jc>// Request body will contain: {foo:null}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#keepNullProperties--"><code>Serializer.Builder.keepNullProperties()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#keepNullProperties--">keepNullProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="logRequests-org.apache.juneau.DetailLevel-java.util.logging.Level-java.util.function.BiPredicate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logRequests</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1361">logRequests</a>(<a href="../../../../../org/apache/juneau/DetailLevel.html" title="enum in org.apache.juneau">DetailLevel</a>&nbsp;detail,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Level.html?is-external=true" title="class or interface in java.util.logging">Level</a>&nbsp;level,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiPredicate.html?is-external=true" title="class or interface in java.util.function">BiPredicate</a>&lt;<a href="../../../../../org/apache/juneau/rest/client/RestRequest.html" title="class in org.apache.juneau.rest.client">RestRequest</a>,<a href="../../../../../org/apache/juneau/rest/client/RestResponse.html" title="class in org.apache.juneau.rest.client">RestResponse</a>&gt;&nbsp;test)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logRequests-org.apache.juneau.DetailLevel-java.util.logging.Level-java.util.function.BiPredicate-">RestClient.Builder</a></code></span></div>
<div class="block">Log requests.
<p>
Causes requests/responses to be logged at the specified log level at the end of the request.
<p>
<jsf>SIMPLE</jsf> detail produces a log message like the following:
<p class='bconsole'>
POST http://localhost:10000/testUrl, HTTP/1.1 200 OK
</p>
<p>
<jsf>FULL</jsf> detail produces a log message like the following:
<p class='bconsole'>
=== HTTP Call (outgoing) =======================================================
=== REQUEST ===
POST http://localhost:10000/testUrl
---request headers---
Debug: true
No-Trace: true
Accept: application/json
---request entity---
Content-Type: application/json
---request content---
{"foo":"bar","baz":123}
=== RESPONSE ===
HTTP/1.1 200 OK
---response headers---
Content-Type: application/json;charset=utf-8
Content-Length: 21
Server: Jetty(8.1.0.v20120127)
---response content---
{"message":"OK then"}
=== END ========================================================================
</p>
<p>
By default, the message is logged to the default logger. It can be logged to a different logger via the
<a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logger-java.util.logging.Logger-"><code>RestClient.Builder.logger(Logger)</code></a> method or logged to the console using the
<a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logToConsole--"><code>RestClient.Builder.logToConsole()</code></a> method.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logRequests-org.apache.juneau.DetailLevel-java.util.logging.Level-java.util.function.BiPredicate-">logRequests</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>detail</code> - The detail level of logging.</dd>
<dd><code>level</code> - The log level.</dd>
<dd><code>test</code> - A predicate to use per-request to see if the request should be logged. If <jk>null</jk>, always logs.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="logToConsole--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logToConsole</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1367">logToConsole</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logToConsole--">RestClient.Builder</a></code></span></div>
<div class="block">Log to console.
<p>
Specifies to log messages to the console.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that logs messages to a special logger.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.logToConsole()
.logRequests(<jsf>FULL</jsf>, <jsf>INFO</jsf>) <jc>// Level is ignored when logging to console.</jc>
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logToConsole--">logToConsole</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="logger-java.util.logging.Logger-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logger</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1373">logger</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html?is-external=true" title="class or interface in java.util.logging">Logger</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logger-java.util.logging.Logger-">RestClient.Builder</a></code></span></div>
<div class="block">Logger.
<p>
Specifies the logger to use for logging.
<p>
If not specified, uses the following logger:
<p class='bjava'>
Logger.<jsm>getLogger</jsm>(RestClient.<jk>class</jk>.getName());
</p>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that logs messages to a special logger.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.logger(Logger.<jsm>getLogger</jsm>(<js>"MyLogger"</js>)) <jc>// Log to MyLogger logger.</jc>
.logToConsole() <jc>// Also log to console.</jc>
.logRequests(<jsf>FULL</jsf>, <jsf>WARNING</jsf>) <jc>// Log requests with full detail at WARNING level.</jc>
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#logger-java.util.logging.Logger-">logger</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The logger to use for logging.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="marshall-org.apache.juneau.marshall.Marshall-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>marshall</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1379">marshall</a>(<a href="../../../../../org/apache/juneau/marshall/Marshall.html" title="class in org.apache.juneau.marshall">Marshall</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#marshall-org.apache.juneau.marshall.Marshall-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Marshall
<p>
Shortcut for specifying the serializers and parsers
using the serializer and parser defined in a marshall.
<ul class='notes'>
<li class='note'>When using this method that takes in a pre-instantiated serializers and parsers, the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>),
parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>), or bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class have no effect.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses Simplified-JSON transport using an existing marshall.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.marshall(SimpleJson.<jsf>DEFAULT_READABLE</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#marshall-org.apache.juneau.marshall.Marshall-">marshall</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The values to add to this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="marshalls-org.apache.juneau.marshall.Marshall...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>marshalls</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1385">marshalls</a>(<a href="../../../../../org/apache/juneau/marshall/Marshall.html" title="class in org.apache.juneau.marshall">Marshall</a>...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#marshalls-org.apache.juneau.marshall.Marshall...-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Marshalls
<p>
Shortcut for specifying the serializers and parsers
using the serializer and parser defined in a marshall.
<ul class='notes'>
<li class='note'>When using this method that takes in a pre-instantiated serializers and parsers, the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>),
parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>), or bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class have no effect.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses JSON and XML transport using existing marshalls.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.marshall(Json.<jsf>DEFAULT_READABLE</jsf>, Xml.<jsf>DEFAULT_READABLE</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#marshalls-org.apache.juneau.marshall.Marshall...-">marshalls</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The values to add to this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="maxConnPerRoute-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxConnPerRoute</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1391">maxConnPerRoute</a>(int&nbsp;maxConnPerRoute)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxConnPerRoute-int-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns maximum connection per route value.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxConnPerRoute-int-">maxConnPerRoute</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxConnPerRoute</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setMaxConnPerRoute(int)</code></dd>
</dl>
</li>
</ul>
<a name="maxConnTotal-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxConnTotal</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1397">maxConnTotal</a>(int&nbsp;maxConnTotal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxConnTotal-int-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns maximum total connection value.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxConnTotal-int-">maxConnTotal</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxConnTotal</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setMaxConnTotal(int)</code></dd>
</dl>
</li>
</ul>
<a name="maxDepth-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxDepth</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1403">maxDepth</a>(int&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxDepth-int-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>BeanTraverse</l> configuration property:&emsp;</i> Max serialization depth.
<p>
When enabled, abort traversal if specified depth is reached in the POJO tree.
<p>
If this depth is exceeded, an exception is thrown.
<p>
This prevents stack overflows from occurring when trying to traverse models with recursive references.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that throws an exception if the depth reaches greater than 20.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.maxDepth(20)
.build();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/BeanTraverseContext.Builder.html#maxDepth-int-"><code>BeanTraverseContext.Builder.maxDepth(int)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxDepth-int-">maxDepth</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <c>100</c>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="maxIndent-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxIndent</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1409">maxIndent</a>(int&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxIndent-int-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Maximum indentation.
<p>
Specifies the maximum indentation level in the serialized document.
<ul class='notes'>
<li class='note'>This setting does not apply to the RDF serializers.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that indents a maximum of 20 tabs.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.ws() <jc>// Enable whitespace</jc>
.maxIndent(20)
.build();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/WriterSerializer.Builder.html#maxIndent-int-"><code>WriterSerializer.Builder.maxIndent(int)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#maxIndent-int-">maxIndent</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <c>100</c>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="mediaType-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mediaType</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1415">mediaType</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#mediaType-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Appends the <c>Accept</c> and <c>Content-Type</c> headers on all requests made by this client.
<p>
Headers are appended to the end of the current header list.
<p>
This is a shortcut for calling <c>headerData().append(Accept.<jsm>of</jsm>(<jv>value</jv>), ContentType.<jsm>of</jsm>(<jv>value</jv>))</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#mediaType-java.lang.String-">mediaType</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new header values.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="msgPack--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>msgPack</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1421">msgPack</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#msgPack--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying MessagePack as the marshalling transmission media type.
<p>
MessagePack is a binary equivalent to JSON that takes up considerably less space than JSON.
<p>
<a href="../../../../../org/apache/juneau/msgpack/MsgPackSerializer.html" title="class in org.apache.juneau.msgpack"><code>MsgPackSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/msgpack/MsgPackParser.html" title="class in org.apache.juneau.msgpack"><code>MsgPackParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"octal/msgpack"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"octal/msgpack"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(MsgPackSerializer.<jk>class</jk>).parser(MsgPackParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses MessagePack marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().msgPack().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#msgPack--">msgPack</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="noTrace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>noTrace</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1427">noTrace</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#noTrace--">RestClient.Builder</a></code></span></div>
<div class="block">When called, <c>No-Trace: true</c> is added to requests.
<p>
This gives the opportunity for the servlet to not log errors on invalid requests.
This is useful for testing purposes when you don't want your log file to show lots of errors that are simply the
results of testing.
<p>
It's up to the server to decide whether to allow for this.
The <c>BasicTestRestLogger</c> class watches for this header and prevents logging of status 400+ responses to
prevent needless logging of test scenarios.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#noTrace--">noTrace</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a></dd>
</dl>
</li>
</ul>
<a name="oapiCollectionFormat-org.apache.juneau.httppart.HttpPartCollectionFormat-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>oapiCollectionFormat</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1433">oapiCollectionFormat</a>(<a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html" title="enum in org.apache.juneau.httppart">HttpPartCollectionFormat</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#oapiCollectionFormat-org.apache.juneau.httppart.HttpPartCollectionFormat-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>OpenApiCommon</l> configuration property:&emsp;</i> Default collection format for HTTP parts.
<p>
Specifies the collection format to use for HTTP parts when not otherwise specified via <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#collectionFormat--"><code>Schema.collectionFormat()</code></a> for the
OpenAPI serializer and parser on this client.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with CSV format for http parts.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.collectionFormat(<jsf>CSV</jsf>)
.build();
<jc>// An arbitrary data structure.</jc>
AList <jv>list</jv> = AList.<jsm>of</jsm>(
<js>"foo"</js>,
<js>"bar"</js>,
AMap.<jsm>of</jsm>(
<js>"baz"</js>, AList.<jsm>of</jsm>(<js>"qux"</js>,<js>"true"</js>,<js>"123"</js>)
)
);
<jc>// Set a header with a comma-separated list.</jc>
<jv>client</jv>
.get(<js>"/uri"</js>)
.header(<js>"Foo"</js>, <jv>list</jv>) <jc>// Will be serialized as: foo=bar,baz=qux\,true\,123</jc>
.run();
</p>
<ul class='values javatree'>
<li class='jc'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html" title="enum in org.apache.juneau.httppart"><code>HttpPartCollectionFormat</code></a>
<ul>
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#CSV"><code>CSV</code></a> - (default) Comma-separated values (e.g. <js>"foo,bar"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#SSV"><code>SSV</code></a> - Space-separated values (e.g. <js>"foo bar"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#TSV"><code>TSV</code></a> - Tab-separated values (e.g. <js>"foo\tbar"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#PIPES"><code>PIPES</code></a> - Pipe-separated values (e.g. <js>"foo|bar"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#MULTI"><code>MULTI</code></a> - Corresponds to multiple parameter instances instead of multiple values for a single instance (e.g. <js>"foo=bar&amp;foo=baz"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#UONC"><code>UONC</code></a> - UON collection notation (e.g. <js>"@(foo,bar)"</js>).
</ul>
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.Builder.html#collectionFormat-org.apache.juneau.httppart.HttpPartCollectionFormat-"><code>OpenApiSerializer.Builder.collectionFormat(HttpPartCollectionFormat)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/oapi/OpenApiParser.Builder.html#collectionFormat-org.apache.juneau.httppart.HttpPartCollectionFormat-"><code>OpenApiParser.Builder.collectionFormat(HttpPartCollectionFormat)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#oapiCollectionFormat-org.apache.juneau.httppart.HttpPartCollectionFormat-">oapiCollectionFormat</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default value is <a href="../../../../../org/apache/juneau/httppart/HttpPartCollectionFormat.html#NO_COLLECTION_FORMAT"><code>HttpPartCollectionFormat.NO_COLLECTION_FORMAT</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="oapiFormat-org.apache.juneau.httppart.HttpPartFormat-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>oapiFormat</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1439">oapiFormat</a>(<a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html" title="enum in org.apache.juneau.httppart">HttpPartFormat</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#oapiFormat-org.apache.juneau.httppart.HttpPartFormat-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>OpenApiCommon</l> configuration property:&emsp;</i> Default OpenAPI format for HTTP parts.
<p>
Specifies the format to use for HTTP parts when not otherwise specified via <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#format--"><code>Schema.format()</code></a> for
the OpenAPI serializer and parser on this client.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with UON part serialization and parsing.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.oapiFormat(<jsf>UON</jsf>)
.build();
<jc>// Set a header with a value in UON format.</jc>
<jv>client</jv>
.get(<js>"/uri"</js>)
.header(<js>"Foo"</js>, <js>"bar baz"</js>) <jc>// Will be serialized as: 'bar baz'</jc>
.run();
</p>
<ul class='values javatree'>
<li class='jc'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html" title="enum in org.apache.juneau.httppart"><code>HttpPartFormat</code></a>
<ul>
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#UON"><code>UON</code></a> - UON notation (e.g. <js>"'foo bar'"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#INT32"><code>INT32</code></a> - Signed 32 bits.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#INT64"><code>INT64</code></a> - Signed 64 bits.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#FLOAT"><code>FLOAT</code></a> - 32-bit floating point number.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#DOUBLE"><code>DOUBLE</code></a> - 64-bit floating point number.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#BYTE"><code>BYTE</code></a> - BASE-64 encoded characters.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#BINARY"><code>BINARY</code></a> - Hexadecimal encoded octets (e.g. <js>"00FF"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#BINARY_SPACED"><code>BINARY_SPACED</code></a> - Spaced-separated hexadecimal encoded octets (e.g. <js>"00 FF"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#DATE"><code>DATE</code></a> - An <a href='http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'>RFC3339 full-date</a>.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#DATE_TIME"><code>DATE_TIME</code></a> - An <a href='http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14'>RFC3339 date-time</a>.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#PASSWORD"><code>PASSWORD</code></a> - Used to hint UIs the input needs to be obscured.
<li class='jf'><a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#NO_FORMAT"><code>NO_FORMAT</code></a> - (default) Not specified.
</ul>
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.Builder.html#format-org.apache.juneau.httppart.HttpPartFormat-"><code>OpenApiSerializer.Builder.format(HttpPartFormat)</code></a>
<li class='jm'><a href="../../../../../org/apache/juneau/oapi/OpenApiParser.Builder.html#format-org.apache.juneau.httppart.HttpPartFormat-"><code>OpenApiParser.Builder.format(HttpPartFormat)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#oapiFormat-org.apache.juneau.httppart.HttpPartFormat-">oapiFormat</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default value is <a href="../../../../../org/apache/juneau/httppart/HttpPartFormat.html#NO_FORMAT"><code>HttpPartFormat.NO_FORMAT</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="openApi--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>openApi</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1445">openApi</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#openApi--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying OpenAPI as the marshalling transmission media type.
<p>
OpenAPI is a language that allows serialization to formats that use <a href="../../../../../org/apache/juneau/httppart/HttpPartSchema.html" title="class in org.apache.juneau.httppart"><code>HttpPartSchema</code></a> objects to describe their structure.
<p>
<a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.html" title="class in org.apache.juneau.oapi"><code>OpenApiSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
<li>Typically the <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#content-java.lang.Object-org.apache.juneau.httppart.HttpPartSchema-"><code>RestRequest.content(Object, HttpPartSchema)</code></a> method will be used to specify the body of the request with the
schema describing it's structure.
</ul>
<p>
<a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
<li>Typically the <a href="../../../../../org/apache/juneau/rest/client/ResponseContent.html#schema-org.apache.juneau.httppart.HttpPartSchema-"><code>ResponseContent.schema(HttpPartSchema)</code></a> method will be used to specify the structure of the response body.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/openapi"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/openapi"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(OpenApiSerializer.<jk>class</jk>).parser(OpenApiParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses OpenAPI marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().openApi().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#openApi--">openApi</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="paramFormat-org.apache.juneau.uon.ParamFormat-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paramFormat</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1451">paramFormat</a>(<a href="../../../../../org/apache/juneau/uon/ParamFormat.html" title="enum in org.apache.juneau.uon">ParamFormat</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#paramFormat-org.apache.juneau.uon.ParamFormat-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>UonSerializer</l> configuration property:&emsp;</i> Parameter format.
<p>
Specifies the format of parameters when using the <a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingSerializer</code></a> to serialize Form Posts.
<p>
Specifies the format to use for GET parameter keys and values.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with URL-Encoded serializer that serializes values in plain-text format.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.urlEnc()
.paramFormat(<jsf>PLAINTEXT</jsf>)
.build();
<jc>// An arbitrary data structure.</jc>
AMap <jv>map</jv> = AMap.<jsm>of</jsm>(
<js>"foo"</js>, <js>"bar"</js>,
<js>"baz"</js>, <jk>new</jk> String[]{<js>"qux"</js>, <js>"true"</js>, <js>"123"</js>}
);
<jc>// Request body will be serialized as: foo=bar,baz=qux,true,123</jc>
<jv>client</jv>
.post(<js>"/uri"</js>, <jv>map</jv>)
.run();
</p>
<ul class='values javatree'>
<li class='jf'><a href="../../../../../org/apache/juneau/uon/ParamFormat.html#UON"><code>ParamFormat.UON</code></a> (default) - Use UON notation for parameters.
<li class='jf'><a href="../../../../../org/apache/juneau/uon/ParamFormat.html#PLAINTEXT"><code>ParamFormat.PLAINTEXT</code></a> - Use plain text for parameters.
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/uon/UonSerializer.Builder.html#paramFormat-org.apache.juneau.uon.ParamFormat-"><code>UonSerializer.Builder.paramFormat(ParamFormat)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#paramFormat-org.apache.juneau.uon.ParamFormat-">paramFormat</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="paramFormatPlain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paramFormatPlain</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1457">paramFormatPlain</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#paramFormatPlain--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>UonSerializer</l> configuration property:&emsp;</i> Parameter format.
<p>
Specifies the format of parameters when using the <a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingSerializer</code></a> to serialize Form Posts.
<p>
Specifies plaintext as the format to use for GET parameter keys and values.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with URL-Encoded serializer that serializes values in plain-text format.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.urlEnc()
.build();
<jc>// An arbitrary data structure.</jc>
AMap <jv>map</jv> = AMap.<jsm>of</jsm>(
<js>"foo"</js>, <js>"bar"</js>,
<js>"baz"</js>, <jk>new</jk> String[]{<js>"qux"</js>, <js>"true"</js>, <js>"123"</js>}
);
<jc>// Request body will be serialized as: foo=bar,baz=qux,true,123</jc>
<jv>client</jv>
.post(<js>"/uri"</js>, <jv>map</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/uon/UonSerializer.Builder.html#paramFormatPlain--"><code>UonSerializer.Builder.paramFormatPlain()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#paramFormatPlain--">paramFormatPlain</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="parser-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parser</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1463">parser</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parser-java.lang.Class-">RestClient.Builder</a></code></span></div>
<div class="block">Parser.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> with the HTTP client.
<p>
The parser is used to parse the HTTP response body into a POJO.
<ul class='notes'>
<li class='note'>When using this method that takes in a class, the parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses JSON transport for response bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.parser(JsonParser.<jk>class</jk>)
.strict() <jc>// Enable strict mode on JsonParser.</jc>
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parser-java.lang.Class-">parser</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/json/JsonParser.html#DEFAULT"><code>JsonParser.DEFAULT</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="parser-org.apache.juneau.parser.Parser-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parser</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1469">parser</a>(<a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parser-org.apache.juneau.parser.Parser-">RestClient.Builder</a></code></span></div>
<div class="block">Parser.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> with the HTTP client.
<p>
The parser is used to parse the HTTP response body into a POJO.
<ul class='notes'>
<li class='note'>When using this method that takes in a pre-instantiated parser, the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined
on this builder class have no effect.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses a predefined JSON parser for response bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.parser(JsonParser.<jsf>DEFAULT_STRICT</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parser-org.apache.juneau.parser.Parser-">parser</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/json/JsonParser.html#DEFAULT"><code>JsonParser.DEFAULT</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="parsers-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parsers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1476">parsers</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>&gt;...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parsers-java.lang.Class...-">RestClient.Builder</a></code></span></div>
<div class="block">Parsers.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parsers</code></a> with the HTTP client.
<p>
The parsers are used to parse the HTTP response body into a POJO.
<p>
The parser that best matches the <c>Accept</c> header will be used to parse the response body.
<br>If no <c>Accept</c> header is specified, the first parser in the list will be used.
<ul class='notes'>
<li class='note'>When using this method that takes in classes, the parsers can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses JSON and XML transport for response bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.parser(JsonParser.<jk>class</jk>, XmlParser.<jk>class</jk>)
.strict() <jc>// Enable strict mode on parsers.</jc>
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parsers-java.lang.Class...-">parsers</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/json/JsonParser.html#DEFAULT"><code>JsonParser.DEFAULT</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="parsers-org.apache.juneau.parser.Parser...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parsers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1482">parsers</a>(<a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser">Parser</a>...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parsers-org.apache.juneau.parser.Parser...-">RestClient.Builder</a></code></span></div>
<div class="block">Parsers.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parsers</code></a> with the HTTP client.
<p>
The parsers are used to parse the HTTP response body into a POJO.
<p>
The parser that best matches the <c>Accept</c> header will be used to parse the response body.
<br>If no <c>Accept</c> header is specified, the first parser in the list will be used.
<ul class='notes'>
<li class='note'>When using this method that takes in pre-instantiated parsers, the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined
on this builder class have no effect.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses JSON and XML transport for response bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.parser(JsonParser.<jsf>DEFAULT_STRICT</jsf>, XmlParser.<jsf>DEFAULT</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#parsers-org.apache.juneau.parser.Parser...-">parsers</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/json/JsonParser.html#DEFAULT"><code>JsonParser.DEFAULT</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="partParser-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partParser</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1488">partParser</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/httppart/HttpPartParser.html" title="interface in org.apache.juneau.httppart">HttpPartParser</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partParser-java.lang.Class-">RestClient.Builder</a></code></span></div>
<div class="block">Part parser.
<p>
The parser to use for parsing POJOs from form data, query parameters, headers, and path variables.
<p>
The default part parser is <a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a> which allows for schema-driven marshalling.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses UON format by default for incoming HTTP parts.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.partParser(UonParser.<jk>class</jk>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partParser-java.lang.Class-">partParser</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="partParser-org.apache.juneau.httppart.HttpPartParser-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partParser</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1494">partParser</a>(<a href="../../../../../org/apache/juneau/httppart/HttpPartParser.html" title="interface in org.apache.juneau.httppart">HttpPartParser</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partParser-org.apache.juneau.httppart.HttpPartParser-">RestClient.Builder</a></code></span></div>
<div class="block">Part parser.
<p>
The parser to use for parsing POJOs from form data, query parameters, headers, and path variables.
<p>
The default part parser is <a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a> which allows for schema-driven marshalling.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses UON format by default for incoming HTTP parts.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.partParser(UonParser.<jsf>DEFAULT</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partParser-org.apache.juneau.httppart.HttpPartParser-">partParser</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/oapi/OpenApiParser.html" title="class in org.apache.juneau.oapi"><code>OpenApiParser</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="partSerializer-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partSerializer</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1500">partSerializer</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/httppart/HttpPartSerializer.html" title="interface in org.apache.juneau.httppart">HttpPartSerializer</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer-java.lang.Class-">RestClient.Builder</a></code></span></div>
<div class="block">Part serializer.
<p>
The serializer to use for serializing POJOs in form data, query parameters, headers, and path variables.
<p>
The default part serializer is <a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.html" title="class in org.apache.juneau.oapi"><code>OpenApiSerializer</code></a> which allows for schema-driven marshalling.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses UON format by default for outgoing HTTP parts.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.partSerializer(UonSerializer.<jk>class</jk>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer-java.lang.Class-">partSerializer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.html" title="class in org.apache.juneau.oapi"><code>OpenApiSerializer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="partSerializer-org.apache.juneau.httppart.HttpPartSerializer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partSerializer</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1506">partSerializer</a>(<a href="../../../../../org/apache/juneau/httppart/HttpPartSerializer.html" title="interface in org.apache.juneau.httppart">HttpPartSerializer</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer-org.apache.juneau.httppart.HttpPartSerializer-">RestClient.Builder</a></code></span></div>
<div class="block">Part serializer.
<p>
The serializer to use for serializing POJOs in form data, query parameters, headers, and path variables.
<p>
The default part serializer is <a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.html" title="class in org.apache.juneau.oapi"><code>OpenApiSerializer</code></a> which allows for schema-driven marshalling.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses UON format by default for outgoing HTTP parts.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.partSerializer(UonSerializer.<jsf>DEFAULT</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer-org.apache.juneau.httppart.HttpPartSerializer-">partSerializer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../../../org/apache/juneau/oapi/OpenApiSerializer.html" title="class in org.apache.juneau.oapi"><code>OpenApiSerializer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="pathData-org.apache.http.NameValuePair...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1512">pathData</a>(org.apache.http.NameValuePair...&nbsp;parts)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-org.apache.http.NameValuePair...-">RestClient.Builder</a></code></span></div>
<div class="block">Sets multiple path parameters on all requests.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jk>import static</jk> org.apache.juneau.http.HttpParts.*;
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.pathData(
<jsm>stringPart</jsm>(<js>"foo"</js>, <js>"bar"</js>),
<jsm>booleanPart</jsm>(<js>"baz"</js>, <jk>true</jk>)
)
.build();
</p>
<p>
This is a shortcut for calling <c>pathData().append(<jv>parts</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-org.apache.http.NameValuePair...-">pathData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parts</code> - The path parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData--"><code>RestClient.Builder.pathData()</code></a></dd>
</dl>
</li>
</ul>
<a name="pathData-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1518">pathData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-java.lang.String-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a path parameter to all request bodies.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.pathData(<js>"foo"</js>, <js>"bar"</js>)
.build();
</p>
<p>
This is a shortcut for calling <c>pathData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-java.lang.String-java.lang.String-">pathData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The parameter name.</dd>
<dd><code>value</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData--"><code>RestClient.Builder.pathData()</code></a></dd>
</dl>
</li>
</ul>
<a name="pathData-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pathData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1524">pathData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-java.lang.String-java.util.function.Supplier-">RestClient.Builder</a></code></span></div>
<div class="block">Sets a path parameter with a dynamic value to all request bodies.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.pathData(<js>"foo"</js>, ()-&gt;<js>"bar"</js>)
.build();
</p>
<p>
This is a shortcut for calling <c>pathData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData-java.lang.String-java.util.function.Supplier-">pathData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The parameter name.</dd>
<dd><code>value</code> - The parameter value supplier.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pathData--"><code>RestClient.Builder.pathData()</code></a></dd>
</dl>
</li>
</ul>
<a name="plainText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plainText</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1530">plainText</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#plainText--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying Plain Text as the marshalling transmission media type.
<p>
Plain text marshalling typically only works on simple POJOs that can be converted to and from strings using
swaps, swap methods, etc...
<p>
<a href="../../../../../org/apache/juneau/plaintext/PlainTextSerializer.html" title="class in org.apache.juneau.plaintext"><code>PlainTextSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/plaintext/PlainTextParser.html" title="class in org.apache.juneau.plaintext"><code>PlainTextParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/plain"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/plain"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(PlainTextSerializer.<jk>class</jk>).parser(PlainTextParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses Plain Text marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().plainText().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#plainText--">plainText</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="pooled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pooled</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1536">pooled</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pooled--">RestClient.Builder</a></code></span></div>
<div class="block">When called, the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#createConnectionManager--"><code>RestClient.Builder.createConnectionManager()</code></a> method will return a <code>PoolingHttpClientConnectionManager</code>
instead of a <code>BasicHttpClientConnectionManager</code>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses pooled connections.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.pooled()
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#pooled--">pooled</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="proxy-org.apache.http.HttpHost-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>proxy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1542">proxy</a>(org.apache.http.HttpHost&nbsp;proxy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#proxy-org.apache.http.HttpHost-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns default proxy value.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#routePlanner-org.apache.http.conn.routing.HttpRoutePlanner-"><code>RestClient.Builder.routePlanner(HttpRoutePlanner)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#proxy-org.apache.http.HttpHost-">proxy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setProxy(HttpHost)</code></dd>
</dl>
</li>
</ul>
<a name="proxyAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>proxyAuthenticationStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1548">proxyAuthenticationStrategy</a>(org.apache.http.client.AuthenticationStrategy&nbsp;proxyAuthStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#proxyAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>AuthenticationStrategy</code> instance for proxy authentication.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#proxyAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">proxyAuthenticationStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxyAuthStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setProxyAuthenticationStrategy(AuthenticationStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="publicSuffixMatcher-org.apache.http.conn.util.PublicSuffixMatcher-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>publicSuffixMatcher</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1554">publicSuffixMatcher</a>(org.apache.http.conn.util.PublicSuffixMatcher&nbsp;publicSuffixMatcher)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#publicSuffixMatcher-org.apache.http.conn.util.PublicSuffixMatcher-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns file containing public suffix matcher.
<ul class='notes'>
<li class='note'>Instances of this class can be created with <code>PublicSuffixMatcherLoader</code>.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#publicSuffixMatcher-org.apache.http.conn.util.PublicSuffixMatcher-">publicSuffixMatcher</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>publicSuffixMatcher</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setPublicSuffixMatcher(PublicSuffixMatcher)</code></dd>
</dl>
</li>
</ul>
<a name="queryData-org.apache.http.NameValuePair...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1560">queryData</a>(org.apache.http.NameValuePair...&nbsp;parts)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-org.apache.http.NameValuePair...-">RestClient.Builder</a></code></span></div>
<div class="block">Appends multiple query parameters to the URI of all requests.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jk>import static</jk> org.apache.juneau.http.HttpParts.*;
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.queryData(
<jsm>stringPart</jsm>(<js>"foo"</js>, <js>"bar"</js>),
<jsm>booleanPart</jsm>(<js>"baz"</js>, <jk>true</jk>)
)
.build();
</p>
<p>
This is a shortcut for calling <c>queryData().append(<jv>parts</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-org.apache.http.NameValuePair...-">queryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parts</code> - The query parameters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData--"><code>RestClient.Builder.queryData()</code></a></dd>
</dl>
</li>
</ul>
<a name="queryData-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1566">queryData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-java.lang.String-java.lang.String-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a query parameter to the URI.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.queryData(<js>"foo"</js>, <js>"bar"</js>)
.build();
</p>
<p>
This is a shortcut for calling <c>queryData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-java.lang.String-java.lang.String-">queryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The parameter name.</dd>
<dd><code>value</code> - The parameter value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData--"><code>RestClient.Builder.queryData()</code></a></dd>
</dl>
</li>
</ul>
<a name="queryData-java.lang.String-java.util.function.Supplier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queryData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1572">queryData</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-java.lang.String-java.util.function.Supplier-">RestClient.Builder</a></code></span></div>
<div class="block">Appends a query parameter with a dynamic value to the URI.
<h5 class='section'>Example:</h5>
<p class='bjava'>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.queryData(<js>"foo"</js>, ()-&gt;<js>"bar"</js>)
.build();
</p>
<p>
This is a shortcut for calling <c>queryData().append(<jv>name</jv>,<jv>value</jv>)</c>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData-java.lang.String-java.util.function.Supplier-">queryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - The parameter name.</dd>
<dd><code>value</code> - The parameter value supplier.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#queryData--"><code>RestClient.Builder.queryData()</code></a></dd>
</dl>
</li>
</ul>
<a name="quoteChar-char-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>quoteChar</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1578">quoteChar</a>(char&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#quoteChar-char-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Quote character.
<p>
Specifies the character to use for quoting attributes and values.
<ul class='notes'>
<li class='note'>This setting does not apply to the RDF serializers.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that uses single quotes.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.quoteChar(<js>'\''</js>)
.build();
<jc>// A bean with a single property</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Request body will contain: {'foo':'bar'}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/WriterSerializer.Builder.html#quoteChar-char-"><code>WriterSerializer.Builder.quoteChar(char)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#quoteChar-char-">quoteChar</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <js>'"'</js>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="redirectStrategy-org.apache.http.client.RedirectStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>redirectStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1584">redirectStrategy</a>(org.apache.http.client.RedirectStrategy&nbsp;redirectStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#redirectStrategy-org.apache.http.client.RedirectStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>RedirectStrategy</code> instance.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableRedirectHandling--"><code>RestClient.Builder.disableRedirectHandling()</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#redirectStrategy-org.apache.http.client.RedirectStrategy-">redirectStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>redirectStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setRedirectStrategy(RedirectStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="requestExecutor-org.apache.http.protocol.HttpRequestExecutor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestExecutor</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1590">requestExecutor</a>(org.apache.http.protocol.HttpRequestExecutor&nbsp;requestExec)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#requestExecutor-org.apache.http.protocol.HttpRequestExecutor-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>HttpRequestExecutor</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#requestExecutor-org.apache.http.protocol.HttpRequestExecutor-">requestExecutor</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestExec</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setRequestExecutor(HttpRequestExecutor)</code></dd>
</dl>
</li>
</ul>
<a name="retryHandler-org.apache.http.client.HttpRequestRetryHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>retryHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1596">retryHandler</a>(org.apache.http.client.HttpRequestRetryHandler&nbsp;retryHandler)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#retryHandler-org.apache.http.client.HttpRequestRetryHandler-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>HttpRequestRetryHandler</code> instance.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableAutomaticRetries--"><code>RestClient.Builder.disableAutomaticRetries()</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#retryHandler-org.apache.http.client.HttpRequestRetryHandler-">retryHandler</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>retryHandler</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setRetryHandler(HttpRequestRetryHandler)</code></dd>
</dl>
</li>
</ul>
<a name="rootUri-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rootUri</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1602">rootUri</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#rootUri-java.lang.Object-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>RestClient</l> configuration property:&emsp;</i> Root URI.
<p>
When set, relative URI strings passed in through the various rest call methods (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#get-java.lang.Object-"><code>RestClient.get(Object)</code></a>
will be prefixed with the specified root.
<br>This root URI is ignored on those methods if you pass in a <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>, or an absolute URI string.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses UON format by default for HTTP parts.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.rootUri(<js>"http://localhost:10000/foo"</js>)
.build();
Bar <jv>bar</jv> = <jv>client</jv>
.get(<js>"/bar"</js>) <jc>// Relative to http://localhost:10000/foo</jc>
.run()
.getContent().as(Bar.<jk>class</jk>);
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#rootUri-java.lang.Object-">rootUri</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The root URI to prefix to relative URI strings.
<br>Trailing slashes are trimmed.
<br>Usually a <c>String</c> but you can also pass in <c>URI</c> and <c>URL</c> objects as well.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="routePlanner-org.apache.http.conn.routing.HttpRoutePlanner-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>routePlanner</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1608">routePlanner</a>(org.apache.http.conn.routing.HttpRoutePlanner&nbsp;routePlanner)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#routePlanner-org.apache.http.conn.routing.HttpRoutePlanner-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>HttpRoutePlanner</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#routePlanner-org.apache.http.conn.routing.HttpRoutePlanner-">routePlanner</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>routePlanner</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setRoutePlanner(HttpRoutePlanner)</code></dd>
</dl>
</li>
</ul>
<a name="schemePortResolver-org.apache.http.conn.SchemePortResolver-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schemePortResolver</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1614">schemePortResolver</a>(org.apache.http.conn.SchemePortResolver&nbsp;schemePortResolver)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#schemePortResolver-org.apache.http.conn.SchemePortResolver-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>SchemePortResolver</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#schemePortResolver-org.apache.http.conn.SchemePortResolver-">schemePortResolver</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemePortResolver</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setSchemePortResolver(SchemePortResolver)</code></dd>
</dl>
</li>
</ul>
<a name="serializer-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializer</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1620">serializer</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>&gt;&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializer-java.lang.Class-">RestClient.Builder</a></code></span></div>
<div class="block">Serializer.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> with the HTTP client.
<p>
The serializer is used to serialize POJOs into the HTTP request body.
<ul class='notes'>
<li class='note'>When using this method that takes in a class, the serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses JSON transport for request bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.serializer(JsonSerializer.<jk>class</jk>)
.sortCollections() <jc>// Sort any collections being serialized.</jc>
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializer-java.lang.Class-">serializer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="serializer-org.apache.juneau.serializer.Serializer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializer</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1626">serializer</a>(<a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializer-org.apache.juneau.serializer.Serializer-">RestClient.Builder</a></code></span></div>
<div class="block">Serializer.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> with the HTTP client.
<p>
The serializer is used to serialize POJOs into the HTTP request body.
<ul class='notes'>
<li class='note'>When using this method that takes in a pre-instantiated serializer, the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined
on this builder class have no effect.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses a predefined JSON serializer request bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.serializer(JsonSerializer.<jsf>DEFAULT_READABLE</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializer-org.apache.juneau.serializer.Serializer-">serializer</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="serializers-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1633">serializers</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>&gt;...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializers-java.lang.Class...-">RestClient.Builder</a></code></span></div>
<div class="block">Serializers.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializers</code></a> with the HTTP client.
<p>
The serializer is used to serialize POJOs into the HTTP request body.
<p>
The serializer that best matches the <c>Content-Type</c> header will be used to serialize the request body.
<br>If no <c>Content-Type</c> header is specified, the first serializer in the list will be used.
<ul class='notes'>
<li class='note'>When using this method that takes in classes, the serializers can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses JSON and XML transport for request bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.serializers(JsonSerializer.<jk>class</jk>, XmlSerializer.<jk>class</jk>)
.sortCollections() <jc>// Sort any collections being serialized.</jc>
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializers-java.lang.Class...-">serializers</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="serializers-org.apache.juneau.serializer.Serializer...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serializers</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1639">serializers</a>(<a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a>...&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializers-org.apache.juneau.serializer.Serializer...-">RestClient.Builder</a></code></span></div>
<div class="block">Serializers.
<p>
Associates the specified <a href="../../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializers</code></a> with the HTTP client.
<p>
The serializer is used to serialize POJOs into the HTTP request body.
<p>
The serializer that best matches the <c>Content-Type</c> header will be used to serialize the request body.
<br>If no <c>Content-Type</c> header is specified, the first serializer in the list will be used.
<ul class='notes'>
<li class='note'>When using this method that takes in a pre-instantiated serializers, the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined
on this builder class have no effect.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a client that uses predefined JSON and XML serializers for request bodies.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.serializers(JsonSerializer.<jsf>DEFAULT_READABLE</jsf>, XmlSerializer.<jsf>DEFAULT_READABLE</jsf>)
.build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serializers-org.apache.juneau.serializer.Serializer...-">serializers</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="serviceUnavailableRetryStrategy-org.apache.http.client.ServiceUnavailableRetryStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serviceUnavailableRetryStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1645">serviceUnavailableRetryStrategy</a>(org.apache.http.client.ServiceUnavailableRetryStrategy&nbsp;serviceUnavailStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serviceUnavailableRetryStrategy-org.apache.http.client.ServiceUnavailableRetryStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>ServiceUnavailableRetryStrategy</code> instance.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#serviceUnavailableRetryStrategy-org.apache.http.client.ServiceUnavailableRetryStrategy-">serviceUnavailableRetryStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>serviceUnavailStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setServiceUnavailableRetryStrategy(ServiceUnavailableRetryStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="simpleJson--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>simpleJson</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1651">simpleJson</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#simpleJson--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying Simplified JSON as the marshalling transmission media type.
<p>
Simplified JSON is typically useful for automated tests because you can do simple string comparison of results
without having to escape lots of quotes.
<p>
<a href="../../../../../org/apache/juneau/json/SimpleJsonSerializer.html" title="class in org.apache.juneau.json"><code>SimpleJsonSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"application/json"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"application/json+simple"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#xml--"><code>RestClient.Builder.xml()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(SimpleJsonSerializer.<jk>class</jk>).parser(JsonParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses Simplified JSON marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().simpleJson().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#simpleJson--">simpleJson</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="skipEmptyFormData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipEmptyFormData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1657">skipEmptyFormData</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyFormData--">RestClient.Builder</a></code></span></div>
<div class="block">Skip empty form data.
<p>
When enabled, form data consisting of empty strings will be skipped on requests.
Note that <jk>null</jk> values are already skipped.
<p>
The <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#skipIfEmpty--"><code>Schema.skipIfEmpty()</code></a> annotation overrides this setting.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyFormData--">skipEmptyFormData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="skipEmptyFormData-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipEmptyFormData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1663">skipEmptyFormData</a>(boolean&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyFormData-boolean-">RestClient.Builder</a></code></span></div>
<div class="block">Skip empty form data.
<p>
When enabled, form data consisting of empty strings will be skipped on requests.
Note that <jk>null</jk> values are already skipped.
<p>
The <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#skipIfEmpty--"><code>Schema.skipIfEmpty()</code></a> annotation overrides this setting.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyFormData-boolean-">skipEmptyFormData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <jk>false</jk>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="skipEmptyHeaderData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipEmptyHeaderData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1669">skipEmptyHeaderData</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyHeaderData--">RestClient.Builder</a></code></span></div>
<div class="block">Skip empty header data.
<p>
When enabled, headers consisting of empty strings will be skipped on requests.
Note that <jk>null</jk> values are already skipped.
<p>
The <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#skipIfEmpty--"><code>Schema.skipIfEmpty()</code></a> annotation overrides this setting.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyHeaderData--">skipEmptyHeaderData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="skipEmptyHeaderData-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipEmptyHeaderData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1675">skipEmptyHeaderData</a>(boolean&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyHeaderData-boolean-">RestClient.Builder</a></code></span></div>
<div class="block">Skip empty header data.
<p>
When enabled, headers consisting of empty strings will be skipped on requests.
Note that <jk>null</jk> values are already skipped.
<p>
The <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#skipIfEmpty--"><code>Schema.skipIfEmpty()</code></a> annotation overrides this setting.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyHeaderData-boolean-">skipEmptyHeaderData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <jk>false</jk>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="skipEmptyQueryData--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipEmptyQueryData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1681">skipEmptyQueryData</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyQueryData--">RestClient.Builder</a></code></span></div>
<div class="block">Skip empty query data.
<p>
When enabled, query parameters consisting of empty strings will be skipped on requests.
Note that <jk>null</jk> values are already skipped.
<p>
The <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#skipIfEmpty--"><code>Schema.skipIfEmpty()</code></a> annotation overrides this setting.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyQueryData--">skipEmptyQueryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="skipEmptyQueryData-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skipEmptyQueryData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1687">skipEmptyQueryData</a>(boolean&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyQueryData-boolean-">RestClient.Builder</a></code></span></div>
<div class="block">Skip empty query data.
<p>
When enabled, query parameters consisting of empty strings will be skipped on requests.
Note that <jk>null</jk> values are already skipped.
<p>
The <a href="../../../../../org/apache/juneau/http/annotation/Schema.html#skipIfEmpty--"><code>Schema.skipIfEmpty()</code></a> annotation overrides this setting.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#skipEmptyQueryData-boolean-">skipEmptyQueryData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <jk>false</jk>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sortCollections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortCollections</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1693">sortCollections</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Sort arrays and collections alphabetically.
<p>
When enabled, copies and sorts the contents of arrays and collections before serializing them.
<p>
Note that this introduces a performance penalty since it requires copying the existing collection.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that sorts arrays and collections before serialization.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.sortCollections()
.build();
<jc>// An unsorted array</jc>
String[] <jv>array</jv> = {<js>"foo"</js>,<js>"bar"</js>,<js>"baz"</js>}
<jc>// Request body will contain: ["bar","baz","foo"]</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>array</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#sortCollections--"><code>Serializer.Builder.sortCollections()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--">sortCollections</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sortMaps--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortMaps</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1699">sortMaps</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortMaps--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Sort maps alphabetically.
<p>
When enabled, copies and sorts the contents of maps by their keys before serializing them.
<p>
Note that this introduces a performance penalty.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that sorts maps before serialization.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.sortMaps()
.build();
<jc>// An unsorted map.</jc>
AMap <jv>map</jv> = AMap.<jsm>of</jsm>(<js>"foo"</js>,1,<js>"bar"</js>,2,<js>"baz"</js>,3);
<jc>// Request body will contain: {"bar":2,"baz":3,"foo":1}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>map</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#sortMaps--"><code>Serializer.Builder.sortMaps()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortMaps--">sortMaps</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sq--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sq</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1705">sq</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sq--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Quote character.
<p>
Specifies to use single quotes for quoting attributes and values.
<ul class='notes'>
<li class='note'>This setting does not apply to the RDF serializers.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that uses single quotes.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.sq()
.build();
<jc>// A bean with a single property</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Request body will contain: {'foo':'bar'}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/WriterSerializer.Builder.html#quoteChar-char-"><code>WriterSerializer.Builder.quoteChar(char)</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sq--">sq</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sslContext-javax.net.ssl.SSLContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslContext</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1711">sslContext</a>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl">SSLContext</a>&nbsp;sslContext)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslContext-javax.net.ssl.SSLContext-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl"><code>SSLContext</code></a> instance.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a>
and the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslSocketFactory-org.apache.http.conn.socket.LayeredConnectionSocketFactory-"><code>RestClient.Builder.sslSocketFactory(LayeredConnectionSocketFactory)</code></a> methods.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslContext-javax.net.ssl.SSLContext-">sslContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setSSLContext(SSLContext)</code></dd>
</dl>
</li>
</ul>
<a name="sslHostnameVerifier-javax.net.ssl.HostnameVerifier-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslHostnameVerifier</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1717">sslHostnameVerifier</a>(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/HostnameVerifier.html?is-external=true" title="class or interface in javax.net.ssl">HostnameVerifier</a>&nbsp;hostnameVerifier)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslHostnameVerifier-javax.net.ssl.HostnameVerifier-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/HostnameVerifier.html?is-external=true" title="class or interface in javax.net.ssl"><code>HostnameVerifier</code></a> instance.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a>
and the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslSocketFactory-org.apache.http.conn.socket.LayeredConnectionSocketFactory-"><code>RestClient.Builder.sslSocketFactory(LayeredConnectionSocketFactory)</code></a> methods.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslHostnameVerifier-javax.net.ssl.HostnameVerifier-">sslHostnameVerifier</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hostnameVerifier</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setSSLHostnameVerifier(HostnameVerifier)</code></dd>
</dl>
</li>
</ul>
<a name="sslSocketFactory-org.apache.http.conn.socket.LayeredConnectionSocketFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslSocketFactory</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1723">sslSocketFactory</a>(org.apache.http.conn.socket.LayeredConnectionSocketFactory&nbsp;sslSocketFactory)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslSocketFactory-org.apache.http.conn.socket.LayeredConnectionSocketFactory-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>LayeredConnectionSocketFactory</code> instance.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>RestClient.Builder.connectionManager(HttpClientConnectionManager)</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sslSocketFactory-org.apache.http.conn.socket.LayeredConnectionSocketFactory-">sslSocketFactory</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslSocketFactory</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setSSLSocketFactory(LayeredConnectionSocketFactory)</code></dd>
</dl>
</li>
</ul>
<a name="strict--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>strict</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1729">strict</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Parser</l> configuration property:&emsp;</i> Strict mode.
<p>
When enabled, strict mode for the parser is enabled.
<p>
Strict mode can mean different things for different parsers.
<table class='styled'>
<tr><th>Parser class</th><th>Strict behavior</th></tr>
<tr>
<td>All reader-based parsers</td>
<td>
When enabled, throws <a href="../../../../../org/apache/juneau/parser/ParseException.html" title="class in org.apache.juneau.parser"><code>ParseExceptions</code></a> on malformed charset input.
Otherwise, malformed input is ignored.
</td>
</tr>
<tr>
<td><a href="../../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a></td>
<td>
When enabled, throws exceptions on the following invalid JSON syntax:
<ul>
<li>Unquoted attributes.
<li>Missing attribute values.
<li>Concatenated strings.
<li>Javascript comments.
<li>Numbers and booleans when Strings are expected.
<li>Numbers valid in Java but not JSON (e.g. octal notation, etc...)
</ul>
</td>
</tr>
</table>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON parser using strict mode.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.strict()
.build();
<jc>// Try to parse some bad JSON.</jc>
<jk>try</jk> {
<jv>client</jv>
.get(<js>"/pathToBadJson"</js>)
.run()
.getContent().as(Object.<jk>class</jk>); <jc>// Try to parse it.</jc>
} <jk>catch</jk> (RestCallException <jv>e</jv>) {
<jc>// Handle exception.</jc>
}
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/parser/Parser.Builder.html#strict--"><code>Parser.Builder.strict()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--">strict</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="targetAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetAuthenticationStrategy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1735">targetAuthenticationStrategy</a>(org.apache.http.client.AuthenticationStrategy&nbsp;targetAuthStrategy)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#targetAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>AuthenticationStrategy</code> instance for target host authentication.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#targetAuthenticationStrategy-org.apache.http.client.AuthenticationStrategy-">targetAuthenticationStrategy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetAuthStrategy</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setTargetAuthenticationStrategy(AuthenticationStrategy)</code></dd>
</dl>
</li>
</ul>
<a name="trimEmptyCollections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimEmptyCollections</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1741">trimEmptyCollections</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimEmptyCollections--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Trim empty lists and arrays.
<p>
When enabled, empty lists and arrays will not be serialized.
<p>
Note that enabling this setting has the following effects on parsing:
<ul class='spaced-list'>
<li>
Map entries with empty list values will be lost.
<li>
Bean properties with empty list values will not be set.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a serializer that skips empty arrays and collections.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.trimEmptyCollections()
.build();
<jc>// A bean with a field with an empty array.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String[] <jf>foo</jf> = {};
}
<jc>// Request body will contain: {}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#trimEmptyCollections--"><code>Serializer.Builder.trimEmptyCollections()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimEmptyCollections--">trimEmptyCollections</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="trimEmptyMaps--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimEmptyMaps</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1747">trimEmptyMaps</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimEmptyMaps--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Trim empty maps.
<p>
When enabled, empty map values will not be serialized to the output.
<p>
Note that enabling this setting has the following effects on parsing:
<ul class='spaced-list'>
<li>
Bean properties with empty map values will not be set.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that skips empty maps.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.trimEmptyMaps()
.build();
<jc>// A bean with a field with an empty map.</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> AMap <jf>foo</jf> = AMap.<jsm>of</jsm>();
}
<jc>// Request body will contain: {}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#trimEmptyMaps--"><code>Serializer.Builder.trimEmptyMaps()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimEmptyMaps--">trimEmptyMaps</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="trimStringsOnRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimStringsOnRead</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1753">trimStringsOnRead</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimStringsOnRead--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Parser</l> configuration property:&emsp;</i> Trim parsed strings.
<p>
When enabled, string values will be trimmed of whitespace using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#trim--" title="class or interface in java.lang"><code>String.trim()</code></a> before being added to
the POJO.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON parser with trim-strings enabled.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.trimStringsOnRead()
.build();
<jc>// Try to parse JSON containing {" foo ":" bar "}.</jc>
Map&lt;String,String&gt; <jv>map</jv> = <jv>client</jv>
.get(<js>"/pathToJson"</js>)
.run()
.getContent().as(HashMap.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);
<jc>// Make sure strings are trimmed.</jc>
<jsm>assertEquals</jsm>(<js>"bar"</js>, <jv>map</jv>.get(<js>"foo"</js>));
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/parser/Parser.Builder.html#trimStrings--"><code>Parser.Builder.trimStrings()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimStringsOnRead--">trimStringsOnRead</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="trimStringsOnWrite--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trimStringsOnWrite</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1759">trimStringsOnWrite</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimStringsOnWrite--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> Trim strings.
<p>
When enabled, string values will be trimmed of whitespace using <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true#trim--" title="class or interface in java.lang"><code>String.trim()</code></a> before being serialized.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer that trims strings before serialization.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.trimStrings()
.build();
<jc>// A map with space-padded keys/values</jc>
AMap <jv>map</jv> = AMap.<jsm>of</jsm>(<js>" foo "</js>, <js>" bar "</js>);
<jc>// Request body will contain: {"foo":"bar"}</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>map</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#trimStrings--"><code>Serializer.Builder.trimStrings()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#trimStringsOnWrite--">trimStringsOnWrite</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="uon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uon</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1765">uon</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uon--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying UON as the marshalling transmission media type.
<p>
UON is Url-Encoding Object notation that is equivalent to JSON but suitable for transmission as URL-encoded
query and form post values.
<p>
<a href="../../../../../org/apache/juneau/uon/UonSerializer.html" title="class in org.apache.juneau.uon"><code>UonSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/uon/UonParser.html" title="class in org.apache.juneau.uon"><code>UonParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/uon"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/uon"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(UonSerializer.<jk>class</jk>).parser(UonParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses UON marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().uon().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uon--">uon</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="uriContext-org.apache.juneau.UriContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uriContext</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1771">uriContext</a>(<a href="../../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriContext-org.apache.juneau.UriContext-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> URI context bean.
<p>
Bean used for resolution of URIs to absolute or root-relative form.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Our URI contextual information.</jc>
String <jv>authority</jv> = <js>"http://localhost:10000"</js>;
String <jv>contextRoot</jv> = <js>"/myContext"</js>;
String <jv>servletPath</jv> = <js>"/myServlet"</js>;
String <jv>pathInfo</jv> = <js>"/foo"</js>;
<jc>// Create a UriContext object.</jc>
UriContext <jv>uriContext</jv> = <jk>new</jk> UriContext(<jv>authority</jv>, <jv>contextRoot</jv>, <jv>servletPath</jv>, <jv>pathInfo</jv>);
<jc>// Create a REST client with JSON serializer and associate our context.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.uriContext(<jv>uriContext</jv>)
.uriRelativity(<jsf>RESOURCE</jsf>) <jc>// Assume relative paths are relative to servlet.</jc>
.uriResolution(<jsf>ABSOLUTE</jsf>) <jc>// Serialize URIs as absolute paths.</jc>
.build();
<jc>// A relative URI</jc>
URI <jv>uri</jv> = <jk>new</jk> URI(<js>"bar"</js>);
<jc>// Request body will contain: "http://localhost:10000/myContext/myServlet/foo/bar"</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jv>uri</jv>)
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#uriContext-org.apache.juneau.UriContext-"><code>Serializer.Builder.uriContext(UriContext)</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.MarshallingUris'>Overview &gt; juneau-marshall &gt; URIs</a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriContext-org.apache.juneau.UriContext-">uriContext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="uriRelativity-org.apache.juneau.UriRelativity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uriRelativity</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1777">uriRelativity</a>(<a href="../../../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriRelativity-org.apache.juneau.UriRelativity-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> URI relativity.
<p>
Defines what relative URIs are relative to when serializing any of the following:
<ul>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>
<li>Properties and classes annotated with <a href="../../../../../org/apache/juneau/annotation/Uri.html" title="annotation in org.apache.juneau.annotation"><code>@Uri</code></a>
</ul>
<p>
See <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriContext-org.apache.juneau.UriContext-"><code>RestClient.Builder.uriContext(UriContext)</code></a> for examples.
<ul class='values javatree'>
<li class='jf'><a href="../../../../../org/apache/juneau/UriRelativity.html#RESOURCE"><code>UriRelativity.RESOURCE</code></a>
- Relative URIs should be considered relative to the servlet URI.
<li class='jf'><a href="../../../../../org/apache/juneau/UriRelativity.html#PATH_INFO"><code>UriRelativity.PATH_INFO</code></a>
- Relative URIs should be considered relative to the request URI.
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#uriRelativity-org.apache.juneau.UriRelativity-"><code>Serializer.Builder.uriRelativity(UriRelativity)</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.MarshallingUris'>Overview &gt; juneau-marshall &gt; URIs</a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriRelativity-org.apache.juneau.UriRelativity-">uriRelativity</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <a href="../../../../../org/apache/juneau/UriRelativity.html#RESOURCE"><code>UriRelativity.RESOURCE</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="uriResolution-org.apache.juneau.UriResolution-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uriResolution</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1783">uriResolution</a>(<a href="../../../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a>&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriResolution-org.apache.juneau.UriResolution-">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>Serializer</l> configuration property:&emsp;</i> URI resolution.
<p>
Defines the resolution level for URIs when serializing any of the following:
<ul>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a>
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a>
<li>Properties and classes annotated with <a href="../../../../../org/apache/juneau/annotation/Uri.html" title="annotation in org.apache.juneau.annotation"><code>@Uri</code></a>
</ul>
<p>
See <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriContext-org.apache.juneau.UriContext-"><code>RestClient.Builder.uriContext(UriContext)</code></a> for examples.
<ul class='values'>
<li class='jf'><a href="../../../../../org/apache/juneau/UriResolution.html#ABSOLUTE"><code>UriResolution.ABSOLUTE</code></a>
- Resolve to an absolute URI (e.g. <js>"http://host:port/context-root/servlet-path/path-info"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/UriResolution.html#ROOT_RELATIVE"><code>UriResolution.ROOT_RELATIVE</code></a>
- Resolve to a root-relative URI (e.g. <js>"/context-root/servlet-path/path-info"</js>).
<li class='jf'><a href="../../../../../org/apache/juneau/UriResolution.html#NONE"><code>UriResolution.NONE</code></a>
- Don't do any URI resolution.
</ul>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/Serializer.Builder.html#uriResolution-org.apache.juneau.UriResolution-"><code>Serializer.Builder.uriResolution(UriResolution)</code></a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-marshall.jm.MarshallingUris'>Overview &gt; juneau-marshall &gt; URIs</a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#uriResolution-org.apache.juneau.UriResolution-">uriResolution</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <a href="../../../../../org/apache/juneau/UriResolution.html#NONE"><code>UriResolution.NONE</code></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="urlEnc--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>urlEnc</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1789">urlEnc</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#urlEnc--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying URL-Encoding as the marshalling transmission media type.
<p>
<a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingSerializer.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
<li>This serializer is NOT used when using the <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#formData-java.lang.String-java.lang.Object-"><code>RestRequest.formData(String, Object)</code></a> (and related) methods for constructing
the request body. Instead, the part serializer specified via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#partSerializer-java.lang.Class-"><code>RestClient.Builder.partSerializer(Class)</code></a> is used.
</ul>
<p>
<a href="../../../../../org/apache/juneau/urlencoding/UrlEncodingParser.html" title="class in org.apache.juneau.urlencoding"><code>UrlEncodingParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"application/x-www-form-urlencoded"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"application/x-www-form-urlencoded"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(UrlEncodingSerializer.<jk>class</jk>).parser(UrlEncodingParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses URL-Encoded marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().urlEnc().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#urlEnc--">urlEnc</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="useSystemProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useSystemProperties</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1795">useSystemProperties</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#useSystemProperties--">RestClient.Builder</a></code></span></div>
<div class="block">Use system properties when creating and configuring default implementations.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#useSystemProperties--">useSystemProperties</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.useSystemProperties()</code></dd>
</dl>
</li>
</ul>
<a name="useWhitespace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useWhitespace</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1801">useWhitespace</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#useWhitespace--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Use whitespace.
<p>
When enabled, whitespace is added to the output to improve readability.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer with whitespace enabled.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.useWhitespace()
.build();
<jc>// A bean with a single property</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Request body will contain: {\n\t"foo": "bar"\n\}\n</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/WriterSerializer.Builder.html#useWhitespace--"><code>WriterSerializer.Builder.useWhitespace()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#useWhitespace--">useWhitespace</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="userTokenHandler-org.apache.http.client.UserTokenHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>userTokenHandler</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1807">userTokenHandler</a>(org.apache.http.client.UserTokenHandler&nbsp;userTokenHandler)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#userTokenHandler-org.apache.http.client.UserTokenHandler-">RestClient.Builder</a></code></span></div>
<div class="block">Assigns <code>UserTokenHandler</code> instance.
<ul class='notes'>
<li class='note'>This value can be overridden by the <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#disableConnectionState--"><code>RestClient.Builder.disableConnectionState()</code></a> method.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#userTokenHandler-org.apache.http.client.UserTokenHandler-">userTokenHandler</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userTokenHandler</code> - New property value.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpClientBuilder.setUserTokenHandler(UserTokenHandler)</code></dd>
</dl>
</li>
</ul>
<a name="ws--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ws</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1813">ws</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ws--">RestClient.Builder</a></code></span></div>
<div class="block"><i><l>WriterSerializer</l> configuration property:&emsp;</i> Use whitespace.
<p>
When enabled, whitespace is added to the output to improve readability.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Create a REST client with JSON serializer with whitespace enabled.</jc>
RestClient <jv>client</jv> = RestClient
.<jsm>create</jsm>()
.json()
.ws()
.build();
<jc>// A bean with a single property</jc>
<jk>public class</jk> MyBean {
<jk>public</jk> String <jf>foo</jf> = <js>"bar"</js>;
}
<jc>// Request body will contain: {\n\t"foo": "bar"\n\}\n</jc>
<jv>client</jv>
.post(<js>"http://localhost:10000/foo"</js>, <jk>new</jk> MyBean())
.run();
</p>
<ul class='seealso'>
<li class='jm'><a href="../../../../../org/apache/juneau/serializer/WriterSerializer.Builder.html#useWhitespace--"><code>WriterSerializer.Builder.useWhitespace()</code></a>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#ws--">ws</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="xml--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>xml</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.Builder.html" title="class in org.apache.juneau.rest.mock">MockRestClient.Builder</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/rest/mock/MockRestClient.Builder.html#line.1819">xml</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#xml--">RestClient.Builder</a></code></span></div>
<div class="block">Convenience method for specifying XML as the marshalling transmission media type.
<p>
<a href="../../../../../org/apache/juneau/xml/XmlSerializer.html" title="class in org.apache.juneau.xml"><code>XmlSerializer</code></a> will be used to serialize POJOs to request bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#serializer-org.apache.juneau.serializer.Serializer-"><code>RestRequest.serializer(Serializer)</code></a>.
<ul>
<li>The serializer can be configured using any of the serializer property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#sortCollections--"><code>RestClient.Builder.sortCollections()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<a href="../../../../../org/apache/juneau/xml/XmlParser.html" title="class in org.apache.juneau.xml"><code>XmlParser</code></a> will be used to parse POJOs from response bodies unless overridden per request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#parser-org.apache.juneau.parser.Parser-"><code>RestRequest.parser(Parser)</code></a>.
<ul>
<li>The parser can be configured using any of the parser property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#strict--"><code>RestClient.Builder.strict()</code></a>) or
bean context property setters (e.g. <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#swaps-java.lang.Class...-"><code>RestClient.Builder.swaps(Class...)</code></a>) defined on this builder class.
</ul>
<p>
<c>Accept</c> request header will be set to <js>"text/xml"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
<c>Content-Type</c> request header will be set to <js>"text/xml"</js> unless overridden
via <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#headers--"><code>RestClient.Builder.headers()</code></a>, or per-request via <a href="../../../../../org/apache/juneau/rest/client/RestRequest.html#header-org.apache.http.Header-"><code>RestRequest.header(Header)</code></a>.
<p>
Can be combined with other marshaller setters such as <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#json--"><code>RestClient.Builder.json()</code></a> to provide support for multiple languages.
<ul>
<li>When multiple languages are supported, the <c>Accept</c> and <c>Content-Type</c> headers control which marshallers are used, or uses the
last-enabled language if the headers are not set.
</ul>
<p>
Identical to calling <c>serializer(XmlSerializer.<jk>class</jk>).parser(XmlParser.<jk>class</jk>)</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Construct a client that uses XML marshalling.</jc>
RestClient <jv>client</jv> = RestClient.<jsm>create</jsm>().xml().build();
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#xml--">xml</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html" title="class in org.apache.juneau.rest.client">RestClient.Builder</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This 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><a href="../../../../../org/apache/juneau/rest/mock/MockRestClient.html" title="class in org.apache.juneau.rest.mock"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/rest/mock/MockRestRequest.html" title="class in org.apache.juneau.rest.mock"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/rest/mock/MockRestClient.Builder.html" target="_top">Frames</a></li>
<li><a href="MockRestClient.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>