• 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:36 PDT 2020 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>AccessPattern (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="AccessPattern (jackson-databind 2.11.0.rc1 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22var methods = {"i0":9,"i1":9};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/AccessPattern.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>Prev&nbsp;Class</li>
54<li><a href="../../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util"><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/util/AccessPattern.html" target="_top">Frames</a></li>
58<li><a href="AccessPattern.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>Nested&nbsp;|&nbsp;</li>
79<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
80<li>Field&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><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
86<li>Field&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.util</div>
97<h2 title="Enum AccessPattern" class="title">Enum AccessPattern</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a>&gt;</li>
105<li>
106<ul class="inheritance">
107<li>com.fasterxml.jackson.databind.util.AccessPattern</li>
108</ul>
109</li>
110</ul>
111</li>
112</ul>
113<div class="description">
114<ul class="blockList">
115<li class="blockList">
116<dl>
117<dt>All Implemented Interfaces:</dt>
118<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a>&gt;</dd>
119</dl>
120<hr>
121<br>
122<pre>public enum <span class="typeNameLabel">AccessPattern</span>
123extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a>&gt;</pre>
124<div class="block">Enumeration used to indicate required access pattern for providers:
125 this can sometimes be used to optimize out dynamic calls.
126 The main difference is between constant values (which can be resolved once)
127 and dynamic ones (which must be resolved anew every time).</div>
128</li>
129</ul>
130</div>
131<div class="summary">
132<ul class="blockList">
133<li class="blockList">
134<!-- =========== ENUM CONSTANT SUMMARY =========== -->
135<ul class="blockList">
136<li class="blockList"><a name="enum.constant.summary">
137<!--   -->
138</a>
139<h3>Enum Constant Summary</h3>
140<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
141<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
142<tr>
143<th class="colOne" scope="col">Enum Constant and Description</th>
144</tr>
145<tr class="altColor">
146<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html#ALWAYS_NULL">ALWAYS_NULL</a></span></code>
147<div class="block">Value that indicates that provider never returns anything other than
148 Java `null`.</div>
149</td>
150</tr>
151<tr class="rowColor">
152<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html#CONSTANT">CONSTANT</a></span></code>
153<div class="block">Value that indicates that provider will always return a constant
154 value, regardless of when it is called; and also that it never
155 uses `context` argument (which may then be passed as `null`)</div>
156</td>
157</tr>
158<tr class="altColor">
159<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html#DYNAMIC">DYNAMIC</a></span></code>
160<div class="block">Value that indicates that provider may return different values
161 at different times (often a freshly constructed empty container),
162 and thus must be called every time "null replacement" value is
163 needed.</div>
164</td>
165</tr>
166</table>
167</li>
168</ul>
169<!-- ========== METHOD SUMMARY =========== -->
170<ul class="blockList">
171<li class="blockList"><a name="method.summary">
172<!--   -->
173</a>
174<h3>Method Summary</h3>
175<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
176<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
177<tr>
178<th class="colFirst" scope="col">Modifier and Type</th>
179<th class="colLast" scope="col">Method and Description</th>
180</tr>
181<tr id="i0" class="altColor">
182<td class="colFirst"><code>static <a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a></code></td>
183<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html#valueOf-java.lang.String-">valueOf</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)</code>
184<div class="block">Returns the enum constant of this type with the specified name.</div>
185</td>
186</tr>
187<tr id="i1" class="rowColor">
188<td class="colFirst"><code>static <a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a>[]</code></td>
189<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html#values--">values</a></span>()</code>
190<div class="block">Returns an array containing the constants of this enum type, in
191the order they are declared.</div>
192</td>
193</tr>
194</table>
195<ul class="blockList">
196<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
197<!--   -->
198</a>
199<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
200<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
201</ul>
202<ul class="blockList">
203<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
204<!--   -->
205</a>
206<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>
207<code><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#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#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>
208</ul>
209</li>
210</ul>
211</li>
212</ul>
213</div>
214<div class="details">
215<ul class="blockList">
216<li class="blockList">
217<!-- ============ ENUM CONSTANT DETAIL =========== -->
218<ul class="blockList">
219<li class="blockList"><a name="enum.constant.detail">
220<!--   -->
221</a>
222<h3>Enum Constant Detail</h3>
223<a name="ALWAYS_NULL">
224<!--   -->
225</a>
226<ul class="blockList">
227<li class="blockList">
228<h4>ALWAYS_NULL</h4>
229<pre>public static final&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a> ALWAYS_NULL</pre>
230<div class="block">Value that indicates that provider never returns anything other than
231 Java `null`.</div>
232</li>
233</ul>
234<a name="CONSTANT">
235<!--   -->
236</a>
237<ul class="blockList">
238<li class="blockList">
239<h4>CONSTANT</h4>
240<pre>public static final&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a> CONSTANT</pre>
241<div class="block">Value that indicates that provider will always return a constant
242 value, regardless of when it is called; and also that it never
243 uses `context` argument (which may then be passed as `null`)</div>
244</li>
245</ul>
246<a name="DYNAMIC">
247<!--   -->
248</a>
249<ul class="blockListLast">
250<li class="blockList">
251<h4>DYNAMIC</h4>
252<pre>public static final&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a> DYNAMIC</pre>
253<div class="block">Value that indicates that provider may return different values
254 at different times (often a freshly constructed empty container),
255 and thus must be called every time "null replacement" value is
256 needed.</div>
257</li>
258</ul>
259</li>
260</ul>
261<!-- ============ METHOD DETAIL ========== -->
262<ul class="blockList">
263<li class="blockList"><a name="method.detail">
264<!--   -->
265</a>
266<h3>Method Detail</h3>
267<a name="values--">
268<!--   -->
269</a>
270<ul class="blockList">
271<li class="blockList">
272<h4>values</h4>
273<pre>public static&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a>[]&nbsp;values()</pre>
274<div class="block">Returns an array containing the constants of this enum type, in
275the order they are declared.  This method may be used to iterate
276over the constants as follows:
277<pre>
278for (AccessPattern c : AccessPattern.values())
279&nbsp;   System.out.println(c);
280</pre></div>
281<dl>
282<dt><span class="returnLabel">Returns:</span></dt>
283<dd>an array containing the constants of this enum type, in the order they are declared</dd>
284</dl>
285</li>
286</ul>
287<a name="valueOf-java.lang.String-">
288<!--   -->
289</a>
290<ul class="blockListLast">
291<li class="blockList">
292<h4>valueOf</h4>
293<pre>public static&nbsp;<a href="../../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a>&nbsp;valueOf(<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)</pre>
294<div class="block">Returns the enum constant of this type with the specified name.
295The string must match <i>exactly</i> an identifier used to declare an
296enum constant in this type.  (Extraneous whitespace characters are
297not permitted.)</div>
298<dl>
299<dt><span class="paramLabel">Parameters:</span></dt>
300<dd><code>name</code> - the name of the enum constant to be returned.</dd>
301<dt><span class="returnLabel">Returns:</span></dt>
302<dd>the enum constant with the specified name</dd>
303<dt><span class="throwsLabel">Throws:</span></dt>
304<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
305<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
306</dl>
307</li>
308</ul>
309</li>
310</ul>
311</li>
312</ul>
313</div>
314</div>
315<!-- ========= END OF CLASS DATA ========= -->
316<!-- ======= START OF BOTTOM NAVBAR ====== -->
317<div class="bottomNav"><a name="navbar.bottom">
318<!--   -->
319</a>
320<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
321<a name="navbar.bottom.firstrow">
322<!--   -->
323</a>
324<ul class="navList" title="Navigation">
325<li><a href="../../../../../overview-summary.html">Overview</a></li>
326<li><a href="package-summary.html">Package</a></li>
327<li class="navBarCell1Rev">Class</li>
328<li><a href="class-use/AccessPattern.html">Use</a></li>
329<li><a href="package-tree.html">Tree</a></li>
330<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
331<li><a href="../../../../../index-all.html">Index</a></li>
332<li><a href="../../../../../help-doc.html">Help</a></li>
333</ul>
334</div>
335<div class="subNav">
336<ul class="navList">
337<li>Prev&nbsp;Class</li>
338<li><a href="../../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
339</ul>
340<ul class="navList">
341<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/util/AccessPattern.html" target="_top">Frames</a></li>
342<li><a href="AccessPattern.html" target="_top">No&nbsp;Frames</a></li>
343</ul>
344<ul class="navList" id="allclasses_navbar_bottom">
345<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
346</ul>
347<div>
348<script type="text/javascript"><!--
349  allClassesLink = document.getElementById("allclasses_navbar_bottom");
350  if(window==top) {
351    allClassesLink.style.display = "block";
352  }
353  else {
354    allClassesLink.style.display = "none";
355  }
356  //-->
357</script>
358</div>
359<div>
360<ul class="subNavList">
361<li>Summary:&nbsp;</li>
362<li>Nested&nbsp;|&nbsp;</li>
363<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
364<li>Field&nbsp;|&nbsp;</li>
365<li><a href="#method.summary">Method</a></li>
366</ul>
367<ul class="subNavList">
368<li>Detail:&nbsp;</li>
369<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
370<li>Field&nbsp;|&nbsp;</li>
371<li><a href="#method.detail">Method</a></li>
372</ul>
373</div>
374<a name="skip.navbar.bottom">
375<!--   -->
376</a></div>
377<!-- ======== END OF BOTTOM NAVBAR ======= -->
378<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
379</body>
380</html>
381