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 Mon Apr 22 19:34:31 PDT 2013 -->
6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7<title>JsonGetter (Jackson-annotations 2.2.0 API)</title>
8<meta name="date" content="2013-04-22">
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="JsonGetter (Jackson-annotations 2.2.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/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="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.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/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:&nbsp;</li>
64<li>Required&nbsp;|&nbsp;</li>
65<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
66</ul>
67<ul class="subNavList">
68<li>Detail:&nbsp;</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 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<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#METHOD" title="class or interface in java.lang.annotation">METHOD</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">JsonGetter</span></pre>
90<div class="block">Marker annotation that can be used to define a non-static,
91 no-argument value-returning (non-void) method to be used as a "getter"
92 for a logical property.
93 It can be used as an alternative to more general
94 <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation (which is the recommended choice in
95 general case).
96<p>
97 Getter means that when serializing Object instance of class that has
98 this method (possibly inherited from a super class), a call is made
99 through the method, and return value will be serialized as value of
100 the property.</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">&nbsp;</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="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>
121<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html#value()">value</a></strong></code>
122<div class="block">Defines name of the logical property this
123 method is used to access ("get"); empty String means that
124 name should be derived from the underlying method (using
125 standard Bean name detection rules)</div>
126</td>
127</tr>
128</table>
129</li>
130</ul>
131</li>
132</ul>
133</div>
134<div class="details">
135<ul class="blockList">
136<li class="blockList">
137<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
138<ul class="blockList">
139<li class="blockList"><a name="annotation_type_element_detail">
140<!--   -->
141</a>
142<h3>Element Detail</h3>
143<a name="value()">
144<!--   -->
145</a>
146<ul class="blockListLast">
147<li class="blockList">
148<h4>value</h4>
149<pre>public abstract&nbsp;<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>&nbsp;value</pre>
150<div class="block">Defines name of the logical property this
151 method is used to access ("get"); empty String means that
152 name should be derived from the underlying method (using
153 standard Bean name detection rules)</div>
154<dl>
155<dt>Default:</dt>
156<dd>""</dd>
157</dl>
158</li>
159</ul>
160</li>
161</ul>
162</li>
163</ul>
164</div>
165</div>
166<!-- ========= END OF CLASS DATA ========= -->
167<!-- ======= START OF BOTTOM NAVBAR ====== -->
168<div class="bottomNav"><a name="navbar_bottom">
169<!--   -->
170</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
171<!--   -->
172</a>
173<ul class="navList" title="Navigation">
174<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
175<li class="navBarCell1Rev">Class</li>
176<li><a href="class-use/JsonGetter.html">Use</a></li>
177<li><a href="package-tree.html">Tree</a></li>
178<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
179<li><a href="../../../../index-all.html">Index</a></li>
180<li><a href="../../../../help-doc.html">Help</a></li>
181</ul>
182</div>
183<div class="subNav">
184<ul class="navList">
185<li><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
186<li><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
187</ul>
188<ul class="navList">
189<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonGetter.html" target="_top">Frames</a></li>
190<li><a href="JsonGetter.html" target="_top">No Frames</a></li>
191</ul>
192<ul class="navList" id="allclasses_navbar_bottom">
193<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
194</ul>
195<div>
196<script type="text/javascript"><!--
197  allClassesLink = document.getElementById("allclasses_navbar_bottom");
198  if(window==top) {
199    allClassesLink.style.display = "block";
200  }
201  else {
202    allClassesLink.style.display = "none";
203  }
204  //-->
205</script>
206</div>
207<div>
208<ul class="subNavList">
209<li>Summary:&nbsp;</li>
210<li>Required&nbsp;|&nbsp;</li>
211<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
212</ul>
213<ul class="subNavList">
214<li>Detail:&nbsp;</li>
215<li><a href="#annotation_type_element_detail">Element</a></li>
216</ul>
217</div>
218<a name="skip-navbar_bottom">
219<!--   -->
220</a></div>
221<!-- ======== END OF BOTTOM NAVBAR ======= -->
222<p class="legalCopy"><small>Copyright &#169; 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p>
223</body>
224</html>
225