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 Sat Apr 25 16:37:31 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonProperty.Access (Jackson-annotations 2.11.0 API)</title> 8<meta name="date" content="2020-04-25"> 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="JsonProperty.Access (Jackson-annotations 2.11.0 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="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 42<li class="navBarCell1Rev">Class</li> 43<li><a href="class-use/JsonProperty.Access.html">Use</a></li> 44<li><a href="package-tree.html">Tree</a></li> 45<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 46<li><a href="../../../../index-all.html">Index</a></li> 47<li><a href="../../../../help-doc.html">Help</a></li> 48</ul> 49</div> 50<div class="subNav"> 51<ul class="navList"> 52<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 53<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 54</ul> 55<ul class="navList"> 56<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonProperty.Access.html" target="_top">Frames</a></li> 57<li><a href="JsonProperty.Access.html" target="_top">No Frames</a></li> 58</ul> 59<ul class="navList" id="allclasses_navbar_top"> 60<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 61</ul> 62<div> 63<script type="text/javascript"><!-- 64 allClassesLink = document.getElementById("allclasses_navbar_top"); 65 if(window==top) { 66 allClassesLink.style.display = "block"; 67 } 68 else { 69 allClassesLink.style.display = "none"; 70 } 71 //--> 72</script> 73</div> 74<div> 75<ul class="subNavList"> 76<li>Summary: </li> 77<li>Nested | </li> 78<li><a href="#enum.constant.summary">Enum Constants</a> | </li> 79<li>Field | </li> 80<li><a href="#method.summary">Method</a></li> 81</ul> 82<ul class="subNavList"> 83<li>Detail: </li> 84<li><a href="#enum.constant.detail">Enum Constants</a> | </li> 85<li>Field | </li> 86<li><a href="#method.detail">Method</a></li> 87</ul> 88</div> 89<a name="skip.navbar.top"> 90<!-- --> 91</a></div> 92<!-- ========= END OF TOP NAVBAR ========= --> 93<!-- ======== START OF CLASS DATA ======== --> 94<div class="header"> 95<div class="subTitle">com.fasterxml.jackson.annotation</div> 96<h2 title="Enum JsonProperty.Access" class="title">Enum JsonProperty.Access</h2> 97</div> 98<div class="contentContainer"> 99<ul class="inheritance"> 100<li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 101<li> 102<ul class="inheritance"> 103<li><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a>></li> 104<li> 105<ul class="inheritance"> 106<li>com.fasterxml.jackson.annotation.JsonProperty.Access</li> 107</ul> 108</li> 109</ul> 110</li> 111</ul> 112<div class="description"> 113<ul class="blockList"> 114<li class="blockList"> 115<dl> 116<dt>All Implemented Interfaces:</dt> 117<dd><a href="https://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a>></dd> 118</dl> 119<dl> 120<dt>Enclosing class:</dt> 121<dd><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></dd> 122</dl> 123<hr> 124<br> 125<pre>public static enum <span class="typeNameLabel">JsonProperty.Access</span> 126extends <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a>></pre> 127<div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access--"><code>JsonProperty.access()</code></a> property, specifying how property 128 may be accessed during serialization ("read") and deserialization ("write") 129 (note that the direction of read and write is from perspective of the property, 130 not from external data format: this may be confusing in some contexts). 131<p> 132 Note that while this annotation modifies access to annotated property, 133 its effects may be further overridden by <a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIgnore</code></a> property: 134 if both annotations are present on an accessors, <a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIgnore</code></a> 135 has precedence over this property. 136 This annotation property is, however, preferred over use of "split" 137 <a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIgnore</code></a>/<code>JsonProperty</code> combination.</div> 138<dl> 139<dt><span class="simpleTagLabel">Since:</span></dt> 140<dd>2.6</dd> 141</dl> 142</li> 143</ul> 144</div> 145<div class="summary"> 146<ul class="blockList"> 147<li class="blockList"> 148<!-- =========== ENUM CONSTANT SUMMARY =========== --> 149<ul class="blockList"> 150<li class="blockList"><a name="enum.constant.summary"> 151<!-- --> 152</a> 153<h3>Enum Constant Summary</h3> 154<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 155<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 156<tr> 157<th class="colOne" scope="col">Enum Constant and Description</th> 158</tr> 159<tr class="altColor"> 160<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#AUTO">AUTO</a></span></code> 161<div class="block">Access setting which means that visibility rules are to be used 162 to automatically determine read- and/or write-access of this property.</div> 163</td> 164</tr> 165<tr class="rowColor"> 166<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#READ_ONLY">READ_ONLY</a></span></code> 167<div class="block">Access setting that means that the property may only be read for serialization 168 (value accessed via "getter" Method, or read from Field) 169 but not written (set) during deserialization.</div> 170</td> 171</tr> 172<tr class="altColor"> 173<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#READ_WRITE">READ_WRITE</a></span></code> 174<div class="block">Access setting that means that the property will be accessed for both 175 serialization (writing out values as external representation) 176 and deserialization (reading values from external representation), 177 regardless of visibility rules.</div> 178</td> 179</tr> 180<tr class="rowColor"> 181<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#WRITE_ONLY">WRITE_ONLY</a></span></code> 182<div class="block">Access setting that means that the property may only be written (set) 183 as part of deserialization (using "setter" method, or assigning to Field, 184 or passed as Creator argument) 185 but will not be read (get) for serialization, that is, the value of the property 186 is not included in serialization.</div> 187</td> 188</tr> 189</table> 190</li> 191</ul> 192<!-- ========== METHOD SUMMARY =========== --> 193<ul class="blockList"> 194<li class="blockList"><a name="method.summary"> 195<!-- --> 196</a> 197<h3>Method Summary</h3> 198<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 199<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> 200<tr> 201<th class="colFirst" scope="col">Modifier and Type</th> 202<th class="colLast" scope="col">Method and Description</th> 203</tr> 204<tr id="i0" class="altColor"> 205<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></code></td> 206<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> 207<div class="block">Returns the enum constant of this type with the specified name.</div> 208</td> 209</tr> 210<tr id="i1" class="rowColor"> 211<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a>[]</code></td> 212<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#values--">values</a></span>()</code> 213<div class="block">Returns an array containing the constants of this enum type, in 214the order they are declared.</div> 215</td> 216</tr> 217</table> 218<ul class="blockList"> 219<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> 220<!-- --> 221</a> 222<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> 223<code><a href="https://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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> 224</ul> 225<ul class="blockList"> 226<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 227<!-- --> 228</a> 229<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 230<code><a href="https://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> 231</ul> 232</li> 233</ul> 234</li> 235</ul> 236</div> 237<div class="details"> 238<ul class="blockList"> 239<li class="blockList"> 240<!-- ============ ENUM CONSTANT DETAIL =========== --> 241<ul class="blockList"> 242<li class="blockList"><a name="enum.constant.detail"> 243<!-- --> 244</a> 245<h3>Enum Constant Detail</h3> 246<a name="AUTO"> 247<!-- --> 248</a> 249<ul class="blockList"> 250<li class="blockList"> 251<h4>AUTO</h4> 252<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a> AUTO</pre> 253<div class="block">Access setting which means that visibility rules are to be used 254 to automatically determine read- and/or write-access of this property.</div> 255</li> 256</ul> 257<a name="READ_ONLY"> 258<!-- --> 259</a> 260<ul class="blockList"> 261<li class="blockList"> 262<h4>READ_ONLY</h4> 263<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a> READ_ONLY</pre> 264<div class="block">Access setting that means that the property may only be read for serialization 265 (value accessed via "getter" Method, or read from Field) 266 but not written (set) during deserialization. 267 Put another way, this would reflect "read-only POJO", in which value contained 268 may be read but not written/set.</div> 269</li> 270</ul> 271<a name="WRITE_ONLY"> 272<!-- --> 273</a> 274<ul class="blockList"> 275<li class="blockList"> 276<h4>WRITE_ONLY</h4> 277<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a> WRITE_ONLY</pre> 278<div class="block">Access setting that means that the property may only be written (set) 279 as part of deserialization (using "setter" method, or assigning to Field, 280 or passed as Creator argument) 281 but will not be read (get) for serialization, that is, the value of the property 282 is not included in serialization.</div> 283</li> 284</ul> 285<a name="READ_WRITE"> 286<!-- --> 287</a> 288<ul class="blockListLast"> 289<li class="blockList"> 290<h4>READ_WRITE</h4> 291<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a> READ_WRITE</pre> 292<div class="block">Access setting that means that the property will be accessed for both 293 serialization (writing out values as external representation) 294 and deserialization (reading values from external representation), 295 regardless of visibility rules.</div> 296</li> 297</ul> 298</li> 299</ul> 300<!-- ============ METHOD DETAIL ========== --> 301<ul class="blockList"> 302<li class="blockList"><a name="method.detail"> 303<!-- --> 304</a> 305<h3>Method Detail</h3> 306<a name="values--"> 307<!-- --> 308</a> 309<ul class="blockList"> 310<li class="blockList"> 311<h4>values</h4> 312<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a>[] values()</pre> 313<div class="block">Returns an array containing the constants of this enum type, in 314the order they are declared. This method may be used to iterate 315over the constants as follows: 316<pre> 317for (JsonProperty.Access c : JsonProperty.Access.values()) 318 System.out.println(c); 319</pre></div> 320<dl> 321<dt><span class="returnLabel">Returns:</span></dt> 322<dd>an array containing the constants of this enum type, in the order they are declared</dd> 323</dl> 324</li> 325</ul> 326<a name="valueOf-java.lang.String-"> 327<!-- --> 328</a> 329<ul class="blockListLast"> 330<li class="blockList"> 331<h4>valueOf</h4> 332<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a> valueOf(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> 333<div class="block">Returns the enum constant of this type with the specified name. 334The string must match <i>exactly</i> an identifier used to declare an 335enum constant in this type. (Extraneous whitespace characters are 336not permitted.)</div> 337<dl> 338<dt><span class="paramLabel">Parameters:</span></dt> 339<dd><code>name</code> - the name of the enum constant to be returned.</dd> 340<dt><span class="returnLabel">Returns:</span></dt> 341<dd>the enum constant with the specified name</dd> 342<dt><span class="throwsLabel">Throws:</span></dt> 343<dd><code><a href="https://docs.oracle.com/javase/6/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> 344<dd><code><a href="https://docs.oracle.com/javase/6/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> 345</dl> 346</li> 347</ul> 348</li> 349</ul> 350</li> 351</ul> 352</div> 353</div> 354<!-- ========= END OF CLASS DATA ========= --> 355<!-- ======= START OF BOTTOM NAVBAR ====== --> 356<div class="bottomNav"><a name="navbar.bottom"> 357<!-- --> 358</a> 359<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 360<a name="navbar.bottom.firstrow"> 361<!-- --> 362</a> 363<ul class="navList" title="Navigation"> 364<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 365<li class="navBarCell1Rev">Class</li> 366<li><a href="class-use/JsonProperty.Access.html">Use</a></li> 367<li><a href="package-tree.html">Tree</a></li> 368<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 369<li><a href="../../../../index-all.html">Index</a></li> 370<li><a href="../../../../help-doc.html">Help</a></li> 371</ul> 372</div> 373<div class="subNav"> 374<ul class="navList"> 375<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 376<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 377</ul> 378<ul class="navList"> 379<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonProperty.Access.html" target="_top">Frames</a></li> 380<li><a href="JsonProperty.Access.html" target="_top">No Frames</a></li> 381</ul> 382<ul class="navList" id="allclasses_navbar_bottom"> 383<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 384</ul> 385<div> 386<script type="text/javascript"><!-- 387 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 388 if(window==top) { 389 allClassesLink.style.display = "block"; 390 } 391 else { 392 allClassesLink.style.display = "none"; 393 } 394 //--> 395</script> 396</div> 397<div> 398<ul class="subNavList"> 399<li>Summary: </li> 400<li>Nested | </li> 401<li><a href="#enum.constant.summary">Enum Constants</a> | </li> 402<li>Field | </li> 403<li><a href="#method.summary">Method</a></li> 404</ul> 405<ul class="subNavList"> 406<li>Detail: </li> 407<li><a href="#enum.constant.detail">Enum Constants</a> | </li> 408<li>Field | </li> 409<li><a href="#method.detail">Method</a></li> 410</ul> 411</div> 412<a name="skip.navbar.bottom"> 413<!-- --> 414</a></div> 415<!-- ======== END OF BOTTOM NAVBAR ======= --> 416<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 417</body> 418</html> 419