1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Fri Oct 05 20:53:29 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonGetter (Jackson-annotations 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-05"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="JsonGetter (Jackson-annotations 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonGetter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><script type="text/javascript"><!-- 52google_ad_client = "pub-1467773697956887"; 53/* Jackson-ad-small */ 54google_ad_slot = "6699487946"; 55google_ad_width = 234; 56google_ad_height = 60; 57//--> 58</script> 59<script type="text/javascript" 60src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 61</script> 62</TD> 63</TR> 64 65<TR> 66<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 67 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 69<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonGetter.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonGetter.html" target="_top"><B>NO FRAMES</B></A> 72 <SCRIPT type="text/javascript"> 73 <!-- 74 if(window==top) { 75 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 76 } 77 //--> 78</SCRIPT> 79<NOSCRIPT> 80 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 81</NOSCRIPT> 82 83 84</FONT></TD> 85</TR> 86<TR> 87<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 88 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 90DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 91</TR> 92</TABLE> 93<A NAME="skip-navbar_top"></A> 94<!-- ========= END OF TOP NAVBAR ========= --> 95 96<HR> 97<!-- ======== START OF CLASS DATA ======== --> 98<H2> 99<FONT SIZE="-1"> 100com.fasterxml.jackson.annotation</FONT> 101<BR> 102Annotation Type JsonGetter</H2> 103<HR> 104<DL> 105<DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</A>}) 106<A HREF="http://download.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) 107</FONT>public @interface <B>JsonGetter</B></DL> 108</PRE> 109 110<P> 111Marker annotation that can be used to define a non-static, 112 no-argument value-returning (non-void) method to be used as a "getter" 113 for a logical property. 114 It can be used as an alternative to more general 115 <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 116 general case). 117<p> 118 Getter means that when serializing Object instance of class that has 119 this method (possibly inherited from a super class), a call is made 120 through the method, and return value will be serialized as value of 121 the property. 122<P> 123 124<P> 125<HR> 126 127<P> 128<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 129 130<A NAME="annotation_type_optional_element_summary"><!-- --></A> 131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 133<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 134<B>Optional Element Summary</B></FONT></TH> 135</TR> 136<TR BGCOLOR="white" CLASS="TableRowColor"> 137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 138<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 139<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonGetter.html#value()">value</A></B></CODE> 140 141<BR> 142 Defines name of the logical property this 143 method is used to access ("get"); empty String means that 144 name should be derived from the underlying method (using 145 standard Bean name detection rules)</TD> 146</TR> 147</TABLE> 148 149<P> 150<A NAME="value()"><!-- --></A><H3> 151value</H3> 152<PRE> 153public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>value</B></PRE> 154<DL> 155<DD>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) 159<P> 160<DD><DL> 161</DL> 162</DD> 163<DD><DL> 164</DL> 165<DL> 166<DT><B>Default:</B><DD>""</DD> 167</DL> 168</DL> 169<!-- ========= END OF CLASS DATA ========= --> 170<HR> 171 172 173<!-- ======= START OF BOTTOM NAVBAR ====== --> 174<A NAME="navbar_bottom"><!-- --></A> 175<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 176<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 177<TR><td rowspan='3'><script type="text/javascript"><!-- 178google_ad_client = "pub-1467773697956887"; 179/* Jackson-ad-small */ 180google_ad_slot = "6699487946"; 181google_ad_width = 234; 182google_ad_height = 60; 183//--> 184</script> 185<script type="text/javascript" 186src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 187</script> 188<!-- GA --> 189<script type="text/javascript"> 190var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 191document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 192</script> 193<script type="text/javascript"> 194try { 195var pageTracker = _gat._getTracker("UA-140287-6"); 196pageTracker._trackPageview(); 197} catch(err) {} 198</script> 199</td> 200<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 201<A NAME="navbar_bottom_firstrow"><!-- --></A> 202<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 203 <TR ALIGN="center" VALIGN="top"> 204 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 205 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonGetter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 207 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 210 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 211 </TR> 212</TABLE> 213</TD> 214<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 215</EM> 216</TD> 217</TR> 218 219<TR> 220<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 221 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 222 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 223<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 224 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonGetter.html" target="_top"><B>FRAMES</B></A> 225 <A HREF="JsonGetter.html" target="_top"><B>NO FRAMES</B></A> 226 <SCRIPT type="text/javascript"> 227 <!-- 228 if(window==top) { 229 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 230 } 231 //--> 232</SCRIPT> 233<NOSCRIPT> 234 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 235</NOSCRIPT> 236 237 238</FONT></TD> 239</TR> 240<TR> 241<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 242 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 243<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 244DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 245</TR> 246</TABLE> 247<A NAME="skip-navbar_bottom"></A> 248<!-- ======== END OF BOTTOM NAVBAR ======= --> 249 250<HR> 251Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 252</BODY> 253</HTML> 254