• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_162) on Tue Mar 24 11:44:39 PDT 2020 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>ContextAttributes (jackson-databind 2.11.0.rc1 API)</title>
8<meta name="date" content="2020-03-24">
9<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
10<script type="text/javascript" src="../../../../../script.js"></script>
11</head>
12<body>
13<script type="text/javascript"><!--
14    try {
15        if (location.href.indexOf('is-external=true') == -1) {
16            parent.document.title="ContextAttributes (jackson-databind 2.11.0.rc1 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22var methods = {"i0":6,"i1":9,"i2":6,"i3":6,"i4":6,"i5":6};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
24var altColor = "altColor";
25var rowColor = "rowColor";
26var tableTab = "tableTab";
27var activeTableTab = "activeTableTab";
28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
33<div class="topNav"><a name="navbar.top">
34<!--   -->
35</a>
36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37<a name="navbar.top.firstrow">
38<!--   -->
39</a>
40<ul class="navList" title="Navigation">
41<li><a href="../../../../../overview-summary.html">Overview</a></li>
42<li><a href="package-summary.html">Package</a></li>
43<li class="navBarCell1Rev">Class</li>
44<li><a href="class-use/ContextAttributes.html">Use</a></li>
45<li><a href="package-tree.html">Tree</a></li>
46<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
47<li><a href="../../../../../index-all.html">Index</a></li>
48<li><a href="../../../../../help-doc.html">Help</a></li>
49</ul>
50</div>
51<div class="subNav">
52<ul class="navList">
53<li><a href="../../../../../com/fasterxml/jackson/databind/cfg/ConfigOverrides.html" title="class in com.fasterxml.jackson.databind.cfg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.Impl.html" title="class in com.fasterxml.jackson.databind.cfg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/cfg/ContextAttributes.html" target="_top">Frames</a></li>
58<li><a href="ContextAttributes.html" target="_top">No&nbsp;Frames</a></li>
59</ul>
60<ul class="navList" id="allclasses_navbar_top">
61<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
62</ul>
63<div>
64<script type="text/javascript"><!--
65  allClassesLink = document.getElementById("allclasses_navbar_top");
66  if(window==top) {
67    allClassesLink.style.display = "block";
68  }
69  else {
70    allClassesLink.style.display = "none";
71  }
72  //-->
73</script>
74</div>
75<div>
76<ul class="subNavList">
77<li>Summary:&nbsp;</li>
78<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
79<li>Field&nbsp;|&nbsp;</li>
80<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li>Field&nbsp;|&nbsp;</li>
86<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
88</ul>
89</div>
90<a name="skip.navbar.top">
91<!--   -->
92</a></div>
93<!-- ========= END OF TOP NAVBAR ========= -->
94<!-- ======== START OF CLASS DATA ======== -->
95<div class="header">
96<div class="subTitle">com.fasterxml.jackson.databind.cfg</div>
97<h2 title="Class ContextAttributes" class="title">Class ContextAttributes</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
101<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>
102<li>
103<ul class="inheritance">
104<li>com.fasterxml.jackson.databind.cfg.ContextAttributes</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<dl>
112<dt>Direct Known Subclasses:</dt>
113<dd><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.Impl.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes.Impl</a></dd>
114</dl>
115<hr>
116<br>
117<pre>public abstract class <span class="typeNameLabel">ContextAttributes</span>
118extends <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></pre>
119<div class="block">Helper class used for storing and accessing per-call attributes.
120 Storage is two-layered: at higher precedence, we have actual per-call
121 attributes; and at lower precedence, default attributes that may be
122 defined for Object readers and writers.
123<p>
124 Note that the way mutability is implemented differs between kinds
125 of attributes, to account for thread-safety: per-call attributes
126 are handled assuming that instances are never shared, whereas
127 changes to per-reader/per-writer attributes are made assuming
128 sharing, by creating new copies instead of modifying state.
129 This allows sharing of default values without per-call copying, but
130 requires two-level lookup on access.</div>
131<dl>
132<dt><span class="simpleTagLabel">Since:</span></dt>
133<dd>2.3</dd>
134</dl>
135</li>
136</ul>
137</div>
138<div class="summary">
139<ul class="blockList">
140<li class="blockList">
141<!-- ======== NESTED CLASS SUMMARY ======== -->
142<ul class="blockList">
143<li class="blockList"><a name="nested.class.summary">
144<!--   -->
145</a>
146<h3>Nested Class Summary</h3>
147<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
148<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
149<tr>
150<th class="colFirst" scope="col">Modifier and Type</th>
151<th class="colLast" scope="col">Class and Description</th>
152</tr>
153<tr class="altColor">
154<td class="colFirst"><code>static class&nbsp;</code></td>
155<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.Impl.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes.Impl</a></span></code>&nbsp;</td>
156</tr>
157</table>
158</li>
159</ul>
160<!-- ======== CONSTRUCTOR SUMMARY ======== -->
161<ul class="blockList">
162<li class="blockList"><a name="constructor.summary">
163<!--   -->
164</a>
165<h3>Constructor Summary</h3>
166<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
167<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
168<tr>
169<th class="colOne" scope="col">Constructor and Description</th>
170</tr>
171<tr class="altColor">
172<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#ContextAttributes--">ContextAttributes</a></span>()</code>&nbsp;</td>
173</tr>
174</table>
175</li>
176</ul>
177<!-- ========== METHOD SUMMARY =========== -->
178<ul class="blockList">
179<li class="blockList"><a name="method.summary">
180<!--   -->
181</a>
182<h3>Method Summary</h3>
183<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
184<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
185<tr>
186<th class="colFirst" scope="col">Modifier and Type</th>
187<th class="colLast" scope="col">Method and Description</th>
188</tr>
189<tr id="i0" class="altColor">
190<td class="colFirst"><code>abstract <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></code></td>
191<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#getAttribute-java.lang.Object-">getAttribute</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;key)</code>
192<div class="block">Accessor for value of specified attribute</div>
193</td>
194</tr>
195<tr id="i1" class="rowColor">
196<td class="colFirst"><code>static <a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a></code></td>
197<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#getEmpty--">getEmpty</a></span>()</code>&nbsp;</td>
198</tr>
199<tr id="i2" class="altColor">
200<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a></code></td>
201<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#withoutSharedAttribute-java.lang.Object-">withoutSharedAttribute</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;key)</code>&nbsp;</td>
202</tr>
203<tr id="i3" class="rowColor">
204<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a></code></td>
205<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#withPerCallAttribute-java.lang.Object-java.lang.Object-">withPerCallAttribute</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;key,
206                    <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>
207<div class="block">Mutator used during call (via context) to set value of "non-shared"
208 part of attribute set.</div>
209</td>
210</tr>
211<tr id="i4" class="altColor">
212<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a></code></td>
213<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#withSharedAttribute-java.lang.Object-java.lang.Object-">withSharedAttribute</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;key,
214                   <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>&nbsp;</td>
215</tr>
216<tr id="i5" class="rowColor">
217<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a></code></td>
218<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html#withSharedAttributes-java.util.Map-">withSharedAttributes</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;?,?&gt;&nbsp;attributes)</code>&nbsp;</td>
219</tr>
220</table>
221<ul class="blockList">
222<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
223<!--   -->
224</a>
225<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>
226<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>
227</ul>
228</li>
229</ul>
230</li>
231</ul>
232</div>
233<div class="details">
234<ul class="blockList">
235<li class="blockList">
236<!-- ========= CONSTRUCTOR DETAIL ======== -->
237<ul class="blockList">
238<li class="blockList"><a name="constructor.detail">
239<!--   -->
240</a>
241<h3>Constructor Detail</h3>
242<a name="ContextAttributes--">
243<!--   -->
244</a>
245<ul class="blockListLast">
246<li class="blockList">
247<h4>ContextAttributes</h4>
248<pre>public&nbsp;ContextAttributes()</pre>
249</li>
250</ul>
251</li>
252</ul>
253<!-- ============ METHOD DETAIL ========== -->
254<ul class="blockList">
255<li class="blockList"><a name="method.detail">
256<!--   -->
257</a>
258<h3>Method Detail</h3>
259<a name="getEmpty--">
260<!--   -->
261</a>
262<ul class="blockList">
263<li class="blockList">
264<h4>getEmpty</h4>
265<pre>public static&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a>&nbsp;getEmpty()</pre>
266</li>
267</ul>
268<a name="withSharedAttribute-java.lang.Object-java.lang.Object-">
269<!--   -->
270</a>
271<ul class="blockList">
272<li class="blockList">
273<h4>withSharedAttribute</h4>
274<pre>public abstract&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a>&nbsp;withSharedAttribute(<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;key,
275                                                      <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>
276</li>
277</ul>
278<a name="withSharedAttributes-java.util.Map-">
279<!--   -->
280</a>
281<ul class="blockList">
282<li class="blockList">
283<h4>withSharedAttributes</h4>
284<pre>public abstract&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a>&nbsp;withSharedAttributes(<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;?,?&gt;&nbsp;attributes)</pre>
285</li>
286</ul>
287<a name="withoutSharedAttribute-java.lang.Object-">
288<!--   -->
289</a>
290<ul class="blockList">
291<li class="blockList">
292<h4>withoutSharedAttribute</h4>
293<pre>public abstract&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a>&nbsp;withoutSharedAttribute(<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;key)</pre>
294</li>
295</ul>
296<a name="getAttribute-java.lang.Object-">
297<!--   -->
298</a>
299<ul class="blockList">
300<li class="blockList">
301<h4>getAttribute</h4>
302<pre>public abstract&nbsp;<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;getAttribute(<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;key)</pre>
303<div class="block">Accessor for value of specified attribute</div>
304</li>
305</ul>
306<a name="withPerCallAttribute-java.lang.Object-java.lang.Object-">
307<!--   -->
308</a>
309<ul class="blockListLast">
310<li class="blockList">
311<h4>withPerCallAttribute</h4>
312<pre>public abstract&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.html" title="class in com.fasterxml.jackson.databind.cfg">ContextAttributes</a>&nbsp;withPerCallAttribute(<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;key,
313                                                       <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>
314<div class="block">Mutator used during call (via context) to set value of "non-shared"
315 part of attribute set.</div>
316</li>
317</ul>
318</li>
319</ul>
320</li>
321</ul>
322</div>
323</div>
324<!-- ========= END OF CLASS DATA ========= -->
325<!-- ======= START OF BOTTOM NAVBAR ====== -->
326<div class="bottomNav"><a name="navbar.bottom">
327<!--   -->
328</a>
329<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
330<a name="navbar.bottom.firstrow">
331<!--   -->
332</a>
333<ul class="navList" title="Navigation">
334<li><a href="../../../../../overview-summary.html">Overview</a></li>
335<li><a href="package-summary.html">Package</a></li>
336<li class="navBarCell1Rev">Class</li>
337<li><a href="class-use/ContextAttributes.html">Use</a></li>
338<li><a href="package-tree.html">Tree</a></li>
339<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
340<li><a href="../../../../../index-all.html">Index</a></li>
341<li><a href="../../../../../help-doc.html">Help</a></li>
342</ul>
343</div>
344<div class="subNav">
345<ul class="navList">
346<li><a href="../../../../../com/fasterxml/jackson/databind/cfg/ConfigOverrides.html" title="class in com.fasterxml.jackson.databind.cfg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
347<li><a href="../../../../../com/fasterxml/jackson/databind/cfg/ContextAttributes.Impl.html" title="class in com.fasterxml.jackson.databind.cfg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
348</ul>
349<ul class="navList">
350<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/cfg/ContextAttributes.html" target="_top">Frames</a></li>
351<li><a href="ContextAttributes.html" target="_top">No&nbsp;Frames</a></li>
352</ul>
353<ul class="navList" id="allclasses_navbar_bottom">
354<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
355</ul>
356<div>
357<script type="text/javascript"><!--
358  allClassesLink = document.getElementById("allclasses_navbar_bottom");
359  if(window==top) {
360    allClassesLink.style.display = "block";
361  }
362  else {
363    allClassesLink.style.display = "none";
364  }
365  //-->
366</script>
367</div>
368<div>
369<ul class="subNavList">
370<li>Summary:&nbsp;</li>
371<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
372<li>Field&nbsp;|&nbsp;</li>
373<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
374<li><a href="#method.summary">Method</a></li>
375</ul>
376<ul class="subNavList">
377<li>Detail:&nbsp;</li>
378<li>Field&nbsp;|&nbsp;</li>
379<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
380<li><a href="#method.detail">Method</a></li>
381</ul>
382</div>
383<a name="skip.navbar.bottom">
384<!--   -->
385</a></div>
386<!-- ======== END OF BOTTOM NAVBAR ======= -->
387<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
388</body>
389</html>
390