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_25) on Wed Nov 13 20:23:19 PST 2013 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>JsonProperty (Jackson-annotations 2.3.0 API)</title> 8<meta name="date" content="2013-11-13"> 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.3.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/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.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://download.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://download.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://download.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://download.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://download.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://download.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://download.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://download.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://download.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>boolean</code></td> 121<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#required()">required</a></strong></code> 122<div class="block">Property that indicates whether a value (which may be explicit 123 null) is expected for property during deserialization or not.</div> 124</td> 125</tr> 126<tr class="rowColor"> 127<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 128<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#value()">value</a></strong></code> 129<div class="block">Defines name of the logical property, i.e.</div> 130</td> 131</tr> 132</table> 133</li> 134</ul> 135</li> 136</ul> 137</div> 138<div class="details"> 139<ul class="blockList"> 140<li class="blockList"> 141<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 142<ul class="blockList"> 143<li class="blockList"><a name="annotation_type_element_detail"> 144<!-- --> 145</a> 146<h3>Element Detail</h3> 147<a name="value()"> 148<!-- --> 149</a> 150<ul class="blockList"> 151<li class="blockList"> 152<h4>value</h4> 153<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value</pre> 154<div class="block">Defines name of the logical property, i.e. JSON object field 155 name to use for the property. If value is empty String (which is the 156 default), will try to use name of the field that is annotated. 157 Note that there is 158 <b>no default name available for constructor arguments</b>, 159 meaning that 160 <b>Empty String is not a valid value for constructor arguments</b>.</div> 161<dl> 162<dt>Default:</dt> 163<dd>""</dd> 164</dl> 165</li> 166</ul> 167<a name="required()"> 168<!-- --> 169</a> 170<ul class="blockListLast"> 171<li class="blockList"> 172<h4>required</h4> 173<pre>public abstract boolean required</pre> 174<div class="block">Property that indicates whether a value (which may be explicit 175 null) is expected for property during deserialization or not. 176 If expected, <code>BeanDeserialized</code> should indicate 177 this as a validity problem (usually by throwing an exception, 178 but this may be sent via problem handlers that can try to 179 rectify the problem, for example, by supplying a default 180 value). 181<p> 182 Note that as of 2.0, this property is NOT used by 183 <code>BeanDeserializer</code>: support is expected to be 184 added for a later minor version.</div> 185<dl><dt><span class="strong">Since:</span></dt> 186 <dd>2.0</dd></dl> 187<dl> 188<dt>Default:</dt> 189<dd>false</dd> 190</dl> 191</li> 192</ul> 193</li> 194</ul> 195</li> 196</ul> 197</div> 198</div> 199<!-- ========= END OF CLASS DATA ========= --> 200<!-- ======= START OF BOTTOM NAVBAR ====== --> 201<div class="bottomNav"><a name="navbar_bottom"> 202<!-- --> 203</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 204<!-- --> 205</a> 206<ul class="navList" title="Navigation"> 207<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 208<li class="navBarCell1Rev">Class</li> 209<li><a href="class-use/JsonProperty.html">Use</a></li> 210<li><a href="package-tree.html">Tree</a></li> 211<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 212<li><a href="../../../../index-all.html">Index</a></li> 213<li><a href="../../../../help-doc.html">Help</a></li> 214</ul> 215</div> 216<div class="subNav"> 217<ul class="navList"> 218<li><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 219<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 220</ul> 221<ul class="navList"> 222<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonProperty.html" target="_top">Frames</a></li> 223<li><a href="JsonProperty.html" target="_top">No Frames</a></li> 224</ul> 225<ul class="navList" id="allclasses_navbar_bottom"> 226<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 227</ul> 228<div> 229<script type="text/javascript"><!-- 230 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 231 if(window==top) { 232 allClassesLink.style.display = "block"; 233 } 234 else { 235 allClassesLink.style.display = "none"; 236 } 237 //--> 238</script> 239</div> 240<div> 241<ul class="subNavList"> 242<li>Summary: </li> 243<li>Required | </li> 244<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 245</ul> 246<ul class="subNavList"> 247<li>Detail: </li> 248<li><a href="#annotation_type_element_detail">Element</a></li> 249</ul> 250</div> 251<a name="skip-navbar_bottom"> 252<!-- --> 253</a></div> 254<!-- ======== END OF BOTTOM NAVBAR ======= --> 255<p class="legalCopy"><small>Copyright © 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 256</body> 257</html> 258