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>JsonGetter (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="JsonGetter (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/JsonGetter.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/JsonCreator.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../org/codehaus/jackson/annotate/JsonIgnore.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/JsonGetter.html" target="_top">Frames</a></li> 44<li><a href="JsonGetter.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 JsonGetter" class="title">Annotation Type JsonGetter</h2> 80</div> 81<div class="contentContainer"> 82<div class="description"> 83<ul class="blockList"> 84<li class="blockList"> 85<hr> 86<div class="block"><strong>Deprecated.</strong> 87<div class="block"><i>Use <a href="../../../../org/codehaus/jackson/annotate/JsonProperty.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonProperty</code></a> instead (deprecated since version 1.5)</i></div> 88</div> 89<br> 90<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#METHOD" title="class or interface in java.lang.annotation">METHOD</a>) 91<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>) 92<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 93public @interface <span class="strong">JsonGetter</span></pre> 94<div class="block">Marker annotation that can be used to define a non-static, 95 no-argument value-returning (non-void) method to be used as a "getter" 96 for a logical property, 97 as an alternative to recommended 98 <a href="../../../../org/codehaus/jackson/annotate/JsonProperty.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonProperty</code></a> annotation (which was introduced in version 1.1). 99<p> 100 Getter means that when serializing Object instance of class that has 101 this method (possibly inherited from a super class), a call is made 102 through the method, and return value will be serialized as value of 103 the property.</div> 104</li> 105</ul> 106</div> 107<div class="summary"> 108<ul class="blockList"> 109<li class="blockList"> 110<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 111<ul class="blockList"> 112<li class="blockList"><a name="annotation_type_optional_element_summary"> 113<!-- --> 114</a> 115<h3>Optional Element Summary</h3> 116<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 117<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 118<tr> 119<th class="colFirst" scope="col">Modifier and Type</th> 120<th class="colLast" scope="col">Optional Element and Description</th> 121</tr> 122<tr class="altColor"> 123<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> 124<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/annotate/JsonGetter.html#value()">value</a></strong></code> 125<div class="block"><strong>Deprecated.</strong> </div> 126<div class="block">Defines name of the logical property this 127 method is used to access ("get"); empty String means that 128 name should be derived from the underlying method (using 129 standard Bean name detection rules)</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="blockListLast"> 151<li class="blockList"> 152<h4>value</h4> 153<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> 154<div class="block"><span class="strong">Deprecated.</span> </div> 155<div class="block">Defines name of the logical property this 156 method is used to access ("get"); empty String means that 157 name should be derived from the underlying method (using 158 standard Bean name detection rules)</div> 159<dl> 160<dt>Default:</dt> 161<dd>""</dd> 162</dl> 163</li> 164</ul> 165</li> 166</ul> 167</li> 168</ul> 169</div> 170</div> 171<!-- ========= END OF CLASS DATA ========= --> 172<!-- ======= START OF BOTTOM NAVBAR ====== --> 173<div class="bottomNav"><a name="navbar_bottom"> 174<!-- --> 175</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 176<!-- --> 177</a> 178<ul class="navList" title="Navigation"> 179<li><a href="../../../../overview-summary.html">Overview</a></li> 180<li><a href="package-summary.html">Package</a></li> 181<li class="navBarCell1Rev">Class</li> 182<li><a href="class-use/JsonGetter.html">Use</a></li> 183<li><a href="package-tree.html">Tree</a></li> 184<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 185<li><a href="../../../../index-all.html">Index</a></li> 186<li><a href="../../../../help-doc.html">Help</a></li> 187</ul> 188</div> 189<div class="subNav"> 190<ul class="navList"> 191<li><a href="../../../../org/codehaus/jackson/annotate/JsonCreator.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Prev Class</span></a></li> 192<li><a href="../../../../org/codehaus/jackson/annotate/JsonIgnore.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Next Class</span></a></li> 193</ul> 194<ul class="navList"> 195<li><a href="../../../../index.html?org/codehaus/jackson/annotate/JsonGetter.html" target="_top">Frames</a></li> 196<li><a href="JsonGetter.html" target="_top">No Frames</a></li> 197</ul> 198<ul class="navList" id="allclasses_navbar_bottom"> 199<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 200</ul> 201<div> 202<script type="text/javascript"><!-- 203 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 204 if(window==top) { 205 allClassesLink.style.display = "block"; 206 } 207 else { 208 allClassesLink.style.display = "none"; 209 } 210 //--> 211</script> 212</div> 213<div> 214<ul class="subNavList"> 215<li>Summary: </li> 216<li>Required | </li> 217<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 218</ul> 219<ul class="subNavList"> 220<li>Detail: </li> 221<li><a href="#annotation_type_element_detail">Element</a></li> 222</ul> 223</div> 224<a name="skip-navbar_bottom"> 225<!-- --> 226</a></div> 227<!-- ======== END OF BOTTOM NAVBAR ======= --> 228</body> 229</html> 230