• 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 Thu Jul 07 10:49:27 PDT 2016 -->
6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <title>JsonProperty.Access (Jackson-annotations 2.8.0 API)</title>
8 <meta name="date" content="2016-07-07">
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.8.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>
113 extends <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.</div>
123 <dl><dt><span class="strong">Since:</span></dt>
124   <dd>2.6</dd></dl>
125 </li>
126 </ul>
127 </div>
128 <div class="summary">
129 <ul class="blockList">
130 <li class="blockList">
131 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
132 <ul class="blockList">
133 <li class="blockList"><a name="enum_constant_summary">
134 <!--   -->
135 </a>
136 <h3>Enum Constant Summary</h3>
137 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
138 <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
139 <tr>
140 <th class="colOne" scope="col">Enum Constant and Description</th>
141 </tr>
142 <tr class="altColor">
143 <td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#AUTO">AUTO</a></strong></code>
144 <div class="block">Access setting which means that visibility rules are to be used
145  to automatically determine read- and/or write-access of this property.</div>
146 </td>
147 </tr>
148 <tr class="rowColor">
149 <td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#READ_ONLY">READ_ONLY</a></strong></code>
150 <div class="block">Access setting that means that the property may only be read for serialization,
151  but not written (set) during deserialization.</div>
152 </td>
153 </tr>
154 <tr class="altColor">
155 <td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#READ_WRITE">READ_WRITE</a></strong></code>
156 <div class="block">Access setting that means that the property will be accessed for both
157  serialization (writing out values as external representation)
158  and deserialization (reading values from external representation),
159  regardless of visibility rules.</div>
160 </td>
161 </tr>
162 <tr class="rowColor">
163 <td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#WRITE_ONLY">WRITE_ONLY</a></strong></code>
164 <div class="block">Access setting that means that the property may only be written (set)
165  for deserialization,
166  but will not be read (get) on serialization, that is, the value of the property
167  is not included in serialization.</div>
168 </td>
169 </tr>
170 </table>
171 </li>
172 </ul>
173 <!-- ========== METHOD SUMMARY =========== -->
174 <ul class="blockList">
175 <li class="blockList"><a name="method_summary">
176 <!--   -->
177 </a>
178 <h3>Method Summary</h3>
179 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
180 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
181 <tr>
182 <th class="colFirst" scope="col">Modifier and Type</th>
183 <th class="colLast" scope="col">Method and Description</th>
184 </tr>
185 <tr class="altColor">
186 <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>
187 <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>
188 <div class="block">Returns the enum constant of this type with the specified name.</div>
189 </td>
190 </tr>
191 <tr class="rowColor">
192 <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>
193 <td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#values()">values</a></strong>()</code>
194 <div class="block">Returns an array containing the constants of this enum type, in
195 the order they are declared.</div>
196 </td>
197 </tr>
198 </table>
199 <ul class="blockList">
200 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
201 <!--   -->
202 </a>
203 <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>
204 <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>
205 </ul>
206 <ul class="blockList">
207 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
208 <!--   -->
209 </a>
210 <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>
211 <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>
212 </ul>
213 </li>
214 </ul>
215 </li>
216 </ul>
217 </div>
218 <div class="details">
219 <ul class="blockList">
220 <li class="blockList">
221 <!-- ============ ENUM CONSTANT DETAIL =========== -->
222 <ul class="blockList">
223 <li class="blockList"><a name="enum_constant_detail">
224 <!--   -->
225 </a>
226 <h3>Enum Constant Detail</h3>
227 <a name="AUTO">
228 <!--   -->
229 </a>
230 <ul class="blockList">
231 <li class="blockList">
232 <h4>AUTO</h4>
233 <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>
234 <div class="block">Access setting which means that visibility rules are to be used
235  to automatically determine read- and/or write-access of this property.</div>
236 </li>
237 </ul>
238 <a name="READ_ONLY">
239 <!--   -->
240 </a>
241 <ul class="blockList">
242 <li class="blockList">
243 <h4>READ_ONLY</h4>
244 <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>
245 <div class="block">Access setting that means that the property may only be read for serialization,
246  but not written (set) during deserialization.</div>
247 </li>
248 </ul>
249 <a name="WRITE_ONLY">
250 <!--   -->
251 </a>
252 <ul class="blockList">
253 <li class="blockList">
254 <h4>WRITE_ONLY</h4>
255 <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>
256 <div class="block">Access setting that means that the property may only be written (set)
257  for deserialization,
258  but will not be read (get) on serialization, that is, the value of the property
259  is not included in serialization.</div>
260 </li>
261 </ul>
262 <a name="READ_WRITE">
263 <!--   -->
264 </a>
265 <ul class="blockListLast">
266 <li class="blockList">
267 <h4>READ_WRITE</h4>
268 <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>
269 <div class="block">Access setting that means that the property will be accessed for both
270  serialization (writing out values as external representation)
271  and deserialization (reading values from external representation),
272  regardless of visibility rules.</div>
273 </li>
274 </ul>
275 </li>
276 </ul>
277 <!-- ============ METHOD DETAIL ========== -->
278 <ul class="blockList">
279 <li class="blockList"><a name="method_detail">
280 <!--   -->
281 </a>
282 <h3>Method Detail</h3>
283 <a name="values()">
284 <!--   -->
285 </a>
286 <ul class="blockList">
287 <li class="blockList">
288 <h4>values</h4>
289 <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>
290 <div class="block">Returns an array containing the constants of this enum type, in
291 the order they are declared.  This method may be used to iterate
292 over the constants as follows:
293 <pre>
294 for (JsonProperty.Access c : JsonProperty.Access.values())
295 &nbsp;   System.out.println(c);
296 </pre></div>
297 <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>
298 </li>
299 </ul>
300 <a name="valueOf(java.lang.String)">
301 <!--   -->
302 </a>
303 <ul class="blockListLast">
304 <li class="blockList">
305 <h4>valueOf</h4>
306 <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>
307 <div class="block">Returns the enum constant of this type with the specified name.
308 The string must match <i>exactly</i> an identifier used to declare an
309 enum constant in this type.  (Extraneous whitespace characters are
310 not permitted.)</div>
311 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
312 <dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
313 <dt><span class="strong">Throws:</span></dt>
314 <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>
315 <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>
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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
329 <!--   -->
330 </a>
331 <ul class="navList" title="Navigation">
332 <li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
333 <li class="navBarCell1Rev">Class</li>
334 <li><a href="class-use/JsonProperty.Access.html">Use</a></li>
335 <li><a href="package-tree.html">Tree</a></li>
336 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
337 <li><a href="../../../../index-all.html">Index</a></li>
338 <li><a href="../../../../help-doc.html">Help</a></li>
339 </ul>
340 </div>
341 <div class="subNav">
342 <ul class="navList">
343 <li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
344 <li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
345 </ul>
346 <ul class="navList">
347 <li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonProperty.Access.html" target="_top">Frames</a></li>
348 <li><a href="JsonProperty.Access.html" target="_top">No Frames</a></li>
349 </ul>
350 <ul class="navList" id="allclasses_navbar_bottom">
351 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
352 </ul>
353 <div>
354 <script type="text/javascript"><!--
355   allClassesLink = document.getElementById("allclasses_navbar_bottom");
356   if(window==top) {
357     allClassesLink.style.display = "block";
358   }
359   else {
360     allClassesLink.style.display = "none";
361   }
362   //-->
363 </script>
364 </div>
365 <div>
366 <ul class="subNavList">
367 <li>Summary:&nbsp;</li>
368 <li>Nested&nbsp;|&nbsp;</li>
369 <li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
370 <li>Field&nbsp;|&nbsp;</li>
371 <li><a href="#method_summary">Method</a></li>
372 </ul>
373 <ul class="subNavList">
374 <li>Detail:&nbsp;</li>
375 <li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
376 <li>Field&nbsp;|&nbsp;</li>
377 <li><a href="#method_detail">Method</a></li>
378 </ul>
379 </div>
380 <a name="skip-navbar_bottom">
381 <!--   -->
382 </a></div>
383 <!-- ======== END OF BOTTOM NAVBAR ======= -->
384 <p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
385 </body>
386 </html>
387