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