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 Sat Jan 09 21:46:11 PST 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonProperty (Jackson-annotations 2.7.0 API)</title> 8<meta name="date" content="2016-01-09"> 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 (Jackson-annotations 2.7.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.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/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum 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.html" target="_top">Frames</a></li> 44<li><a href="JsonProperty.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: </li> 64<li>Required | </li> 65<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 66</ul> 67<ul class="subNavList"> 68<li>Detail: </li> 69<li><a href="#annotation_type_element_detail">Element</a></li> 70</ul> 71</div> 72<a name="skip-navbar_top"> 73<!-- --> 74</a></div> 75<!-- ========= END OF TOP NAVBAR ========= --> 76<!-- ======== START OF CLASS DATA ======== --> 77<div class="header"> 78<div class="subTitle">com.fasterxml.jackson.annotation</div> 79<h2 title="Annotation Type JsonProperty" class="title">Annotation Type JsonProperty</h2> 80</div> 81<div class="contentContainer"> 82<div class="description"> 83<ul class="blockList"> 84<li class="blockList"> 85<hr> 86<br> 87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>}) 88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) 89public @interface <span class="strong">JsonProperty</span></pre> 90<div class="block">Marker annotation that can be used to define a non-static 91 method as a "setter" or "getter" for a logical property 92 (depending on its signature), 93 or non-static object field to be used (serialized, deserialized) as 94 a logical property. 95<p> 96 Default value ("") indicates that the field name is used 97 as the property name without any modifications, but it 98 can be specified to non-empty value to specify different 99 name. Property name refers to name used externally, as 100 the field name in JSON objects.</div> 101</li> 102</ul> 103</div> 104<div class="summary"> 105<ul class="blockList"> 106<li class="blockList"> 107<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 108<ul class="blockList"> 109<li class="blockList"><a name="annotation_type_optional_element_summary"> 110<!-- --> 111</a> 112<h3>Optional Element Summary</h3> 113<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 114<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 115<tr> 116<th class="colFirst" scope="col">Modifier and Type</th> 117<th class="colLast" scope="col">Optional Element and Description</th> 118</tr> 119<tr class="altColor"> 120<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></code></td> 121<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access()">access</a></strong></code> 122<div class="block">Optional property that may be used to change the way visibility of 123 accessors (getter, field-as-getter) and mutators (contructor parameter, 124 setter, field-as-setter) is determined, either so that otherwise 125 non-visible accessors (like private getters) may be used; or that 126 otherwise visible accessors are ignored.</div> 127</td> 128</tr> 129<tr class="rowColor"> 130<td class="colFirst"><code><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></code></td> 131<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#defaultValue()">defaultValue</a></strong></code> 132<div class="block">Property that may be used to <b>document</b> expected default value 133 for the property: most often used as source information for generating 134 schemas (like JSON Schema or protobuf/thrift schema), or documentation.</div> 135</td> 136</tr> 137<tr class="altColor"> 138<td class="colFirst"><code>int</code></td> 139<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#index()">index</a></strong></code> 140<div class="block">Property that indicates numerical index of this property (relative 141 to other properties specified for the Object).</div> 142</td> 143</tr> 144<tr class="rowColor"> 145<td class="colFirst"><code>boolean</code></td> 146<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#required()">required</a></strong></code> 147<div class="block">Property that indicates whether a value (which may be explicit 148 null) is expected for property during deserialization or not.</div> 149</td> 150</tr> 151<tr class="altColor"> 152<td class="colFirst"><code><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></code></td> 153<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#value()">value</a></strong></code> 154<div class="block">Defines name of the logical property, i.e.</div> 155</td> 156</tr> 157</table> 158</li> 159</ul> 160</li> 161</ul> 162</div> 163<div class="details"> 164<ul class="blockList"> 165<li class="blockList"> 166<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 167<ul class="blockList"> 168<li class="blockList"><a name="annotation_type_element_detail"> 169<!-- --> 170</a> 171<h3>Element Detail</h3> 172<a name="value()"> 173<!-- --> 174</a> 175<ul class="blockList"> 176<li class="blockList"> 177<h4>value</h4> 178<pre>public abstract <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> value</pre> 179<div class="block">Defines name of the logical property, i.e. JSON object field 180 name to use for the property. If value is empty String (which is the 181 default), will try to use name of the field that is annotated. 182 Note that there is 183 <b>no default name available for constructor arguments</b>, 184 meaning that 185 <b>Empty String is not a valid value for constructor arguments</b>.</div> 186<dl> 187<dt>Default:</dt> 188<dd>""</dd> 189</dl> 190</li> 191</ul> 192<a name="required()"> 193<!-- --> 194</a> 195<ul class="blockList"> 196<li class="blockList"> 197<h4>required</h4> 198<pre>public abstract boolean required</pre> 199<div class="block">Property that indicates whether a value (which may be explicit 200 null) is expected for property during deserialization or not. 201 If expected, <code>BeanDeserialized</code> should indicate 202 this as a validity problem (usually by throwing an exception, 203 but this may be sent via problem handlers that can try to 204 rectify the problem, for example, by supplying a default 205 value). 206<p> 207 Note that as of 2.6, this property is only used for Creator 208 Properties, to ensure existence of property value in JSON: 209 for other properties (ones injected using a setter or mutable 210 field), no validation is performed. Support for those cases 211 may be added in future. 212 State of this property is exposed via introspection, and its 213 value is typically used by Schema generators, such as one for 214 JSON Schema.</div> 215<dl><dt><span class="strong">Since:</span></dt> 216 <dd>2.0</dd></dl> 217<dl> 218<dt>Default:</dt> 219<dd>false</dd> 220</dl> 221</li> 222</ul> 223<a name="index()"> 224<!-- --> 225</a> 226<ul class="blockList"> 227<li class="blockList"> 228<h4>index</h4> 229<pre>public abstract int index</pre> 230<div class="block">Property that indicates numerical index of this property (relative 231 to other properties specified for the Object). This index 232 is typically used by binary formats, but may also be useful 233 for schema languages and other tools.</div> 234<dl><dt><span class="strong">Since:</span></dt> 235 <dd>2.4</dd></dl> 236<dl> 237<dt>Default:</dt> 238<dd>-1</dd> 239</dl> 240</li> 241</ul> 242<a name="defaultValue()"> 243<!-- --> 244</a> 245<ul class="blockList"> 246<li class="blockList"> 247<h4>defaultValue</h4> 248<pre>public abstract <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> defaultValue</pre> 249<div class="block">Property that may be used to <b>document</b> expected default value 250 for the property: most often used as source information for generating 251 schemas (like JSON Schema or protobuf/thrift schema), or documentation. 252 It may also be used by Jackson extension modules; core jackson databind 253 does not have any automated handling beyond simply exposing this 254 value through bean property introspection. 255<p> 256 It is possible that in future this annotation could be used for value 257 defaulting, and especially for default values of Creator properties, 258 since they support <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#required()"><code>required()</code></a> in 2.6 and above.</div> 259<dl><dt><span class="strong">Since:</span></dt> 260 <dd>2.5</dd></dl> 261<dl> 262<dt>Default:</dt> 263<dd>""</dd> 264</dl> 265</li> 266</ul> 267<a name="access()"> 268<!-- --> 269</a> 270<ul class="blockListLast"> 271<li class="blockList"> 272<h4>access</h4> 273<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a> access</pre> 274<div class="block">Optional property that may be used to change the way visibility of 275 accessors (getter, field-as-getter) and mutators (contructor parameter, 276 setter, field-as-setter) is determined, either so that otherwise 277 non-visible accessors (like private getters) may be used; or that 278 otherwise visible accessors are ignored. 279<p> 280 Default value os <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html#AUTO"><code>JsonProperty.Access.AUTO</code></a> which means that access is determined 281 solely based on visibility and other annotations.</div> 282<dl><dt><span class="strong">Since:</span></dt> 283 <dd>2.6</dd></dl> 284<dl> 285<dt>Default:</dt> 286<dd>com.fasterxml.jackson.annotation.JsonProperty.Access.AUTO</dd> 287</dl> 288</li> 289</ul> 290</li> 291</ul> 292</li> 293</ul> 294</div> 295</div> 296<!-- ========= END OF CLASS DATA ========= --> 297<!-- ======= START OF BOTTOM NAVBAR ====== --> 298<div class="bottomNav"><a name="navbar_bottom"> 299<!-- --> 300</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 301<!-- --> 302</a> 303<ul class="navList" title="Navigation"> 304<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 305<li class="navBarCell1Rev">Class</li> 306<li><a href="class-use/JsonProperty.html">Use</a></li> 307<li><a href="package-tree.html">Tree</a></li> 308<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 309<li><a href="../../../../index-all.html">Index</a></li> 310<li><a href="../../../../help-doc.html">Help</a></li> 311</ul> 312</div> 313<div class="subNav"> 314<ul class="navList"> 315<li><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 316<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 317</ul> 318<ul class="navList"> 319<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonProperty.html" target="_top">Frames</a></li> 320<li><a href="JsonProperty.html" target="_top">No Frames</a></li> 321</ul> 322<ul class="navList" id="allclasses_navbar_bottom"> 323<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 324</ul> 325<div> 326<script type="text/javascript"><!-- 327 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 328 if(window==top) { 329 allClassesLink.style.display = "block"; 330 } 331 else { 332 allClassesLink.style.display = "none"; 333 } 334 //--> 335</script> 336</div> 337<div> 338<ul class="subNavList"> 339<li>Summary: </li> 340<li>Required | </li> 341<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 342</ul> 343<ul class="subNavList"> 344<li>Detail: </li> 345<li><a href="#annotation_type_element_detail">Element</a></li> 346</ul> 347</div> 348<a name="skip-navbar_bottom"> 349<!-- --> 350</a></div> 351<!-- ======== END OF BOTTOM NAVBAR ======= --> 352<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 353</body> 354</html> 355