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_10-ea) on Sun Jul 14 20:03:21 PDT 2013 --> 6<title>JsonProperty (Jackson JSON Processor)</title> 7<meta name="date" content="2013-07-14"> 8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 9</head> 10<body> 11<script type="text/javascript"><!-- 12 if (location.href.indexOf('is-external=true') == -1) { 13 parent.document.title="JsonProperty (Jackson JSON Processor)"; 14 } 15//--> 16</script> 17<noscript> 18<div>JavaScript is disabled on your browser.</div> 19</noscript> 20<!-- ========= START OF TOP NAVBAR ======= --> 21<div class="topNav"><a name="navbar_top"> 22<!-- --> 23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 24<!-- --> 25</a> 26<ul class="navList" title="Navigation"> 27<li><a href="../../../../overview-summary.html">Overview</a></li> 28<li><a href="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="../../../../org/codehaus/jackson/annotate/JsonMethod.html" title="enum in org.codehaus.jackson.annotate"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../org/codehaus/jackson/annotate/JsonPropertyOrder.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?org/codehaus/jackson/annotate/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">org.codehaus.jackson.annotate</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#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. 101<p> 102 NOTE: since version 1.1, annotation has also been applicable 103 to fields (not with 1.0). 104<p> 105 NOTE: since version 1.2, annotation has also been applicable 106 to (constructor) parameters</div> 107</li> 108</ul> 109</div> 110<div class="summary"> 111<ul class="blockList"> 112<li class="blockList"> 113<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 114<ul class="blockList"> 115<li class="blockList"><a name="annotation_type_optional_element_summary"> 116<!-- --> 117</a> 118<h3>Optional Element Summary</h3> 119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 120<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 121<tr> 122<th class="colFirst" scope="col">Modifier and Type</th> 123<th class="colLast" scope="col">Optional Element and Description</th> 124</tr> 125<tr class="altColor"> 126<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> 127<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/annotate/JsonProperty.html#value()">value</a></strong></code> 128<div class="block">Defines name of the logical property, i.e.</div> 129</td> 130</tr> 131</table> 132</li> 133</ul> 134</li> 135</ul> 136</div> 137<div class="details"> 138<ul class="blockList"> 139<li class="blockList"> 140<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 141<ul class="blockList"> 142<li class="blockList"><a name="annotation_type_element_detail"> 143<!-- --> 144</a> 145<h3>Element Detail</h3> 146<a name="value()"> 147<!-- --> 148</a> 149<ul class="blockListLast"> 150<li class="blockList"> 151<h4>value</h4> 152<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> 153<div class="block">Defines name of the logical property, i.e. Json object field 154 name to use for the property: if empty String (which is the 155 default), will use name of the field that is annotated.</div> 156<dl> 157<dt>Default:</dt> 158<dd>""</dd> 159</dl> 160</li> 161</ul> 162</li> 163</ul> 164</li> 165</ul> 166</div> 167</div> 168<!-- ========= END OF CLASS DATA ========= --> 169<!-- ======= START OF BOTTOM NAVBAR ====== --> 170<div class="bottomNav"><a name="navbar_bottom"> 171<!-- --> 172</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 173<!-- --> 174</a> 175<ul class="navList" title="Navigation"> 176<li><a href="../../../../overview-summary.html">Overview</a></li> 177<li><a href="package-summary.html">Package</a></li> 178<li class="navBarCell1Rev">Class</li> 179<li><a href="class-use/JsonProperty.html">Use</a></li> 180<li><a href="package-tree.html">Tree</a></li> 181<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 182<li><a href="../../../../index-all.html">Index</a></li> 183<li><a href="../../../../help-doc.html">Help</a></li> 184</ul> 185</div> 186<div class="subNav"> 187<ul class="navList"> 188<li><a href="../../../../org/codehaus/jackson/annotate/JsonMethod.html" title="enum in org.codehaus.jackson.annotate"><span class="strong">Prev Class</span></a></li> 189<li><a href="../../../../org/codehaus/jackson/annotate/JsonPropertyOrder.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Next Class</span></a></li> 190</ul> 191<ul class="navList"> 192<li><a href="../../../../index.html?org/codehaus/jackson/annotate/JsonProperty.html" target="_top">Frames</a></li> 193<li><a href="JsonProperty.html" target="_top">No Frames</a></li> 194</ul> 195<ul class="navList" id="allclasses_navbar_bottom"> 196<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 197</ul> 198<div> 199<script type="text/javascript"><!-- 200 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 201 if(window==top) { 202 allClassesLink.style.display = "block"; 203 } 204 else { 205 allClassesLink.style.display = "none"; 206 } 207 //--> 208</script> 209</div> 210<div> 211<ul class="subNavList"> 212<li>Summary: </li> 213<li>Required | </li> 214<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 215</ul> 216<ul class="subNavList"> 217<li>Detail: </li> 218<li><a href="#annotation_type_element_detail">Element</a></li> 219</ul> 220</div> 221<a name="skip-navbar_bottom"> 222<!-- --> 223</a></div> 224<!-- ======== END OF BOTTOM NAVBAR ======= --> 225</body> 226</html> 227