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 (1.8.0_162) on Sat Apr 25 16:37:31 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonGetter (Jackson-annotations 2.11.0 API)</title> 8<meta name="date" content="2020-04-25"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10<script type="text/javascript" src="../../../../script.js"></script> 11</head> 12<body> 13<script type="text/javascript"><!-- 14 try { 15 if (location.href.indexOf('is-external=true') == -1) { 16 parent.document.title="JsonGetter (Jackson-annotations 2.11.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22</script> 23<noscript> 24<div>JavaScript is disabled on your browser.</div> 25</noscript> 26<!-- ========= START OF TOP NAVBAR ======= --> 27<div class="topNav"><a name="navbar.top"> 28<!-- --> 29</a> 30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 31<a name="navbar.top.firstrow"> 32<!-- --> 33</a> 34<ul class="navList" title="Navigation"> 35<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 36<li class="navBarCell1Rev">Class</li> 37<li><a href="class-use/JsonGetter.html">Use</a></li> 38<li><a href="package-tree.html">Tree</a></li> 39<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 40<li><a href="../../../../index-all.html">Index</a></li> 41<li><a href="../../../../help-doc.html">Help</a></li> 42</ul> 43</div> 44<div class="subNav"> 45<ul class="navList"> 46<li><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 48</ul> 49<ul class="navList"> 50<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonGetter.html" target="_top">Frames</a></li> 51<li><a href="JsonGetter.html" target="_top">No Frames</a></li> 52</ul> 53<ul class="navList" id="allclasses_navbar_top"> 54<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 55</ul> 56<div> 57<script type="text/javascript"><!-- 58 allClassesLink = document.getElementById("allclasses_navbar_top"); 59 if(window==top) { 60 allClassesLink.style.display = "block"; 61 } 62 else { 63 allClassesLink.style.display = "none"; 64 } 65 //--> 66</script> 67</div> 68<div> 69<ul class="subNavList"> 70<li>Summary: </li> 71<li>Field | </li> 72<li>Required | </li> 73<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 74</ul> 75<ul class="subNavList"> 76<li>Detail: </li> 77<li>Field | </li> 78<li><a href="#annotation.type.element.detail">Element</a></li> 79</ul> 80</div> 81<a name="skip.navbar.top"> 82<!-- --> 83</a></div> 84<!-- ========= END OF TOP NAVBAR ========= --> 85<!-- ======== START OF CLASS DATA ======== --> 86<div class="header"> 87<div class="subTitle">com.fasterxml.jackson.annotation</div> 88<h2 title="Annotation Type JsonGetter" class="title">Annotation Type JsonGetter</h2> 89</div> 90<div class="contentContainer"> 91<div class="description"> 92<ul class="blockList"> 93<li class="blockList"> 94<hr> 95<br> 96<pre><a href="https://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="https://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="https://docs.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="https://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>}) 97 <a href="https://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="https://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="https://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>) 98public @interface <span class="memberNameLabel">JsonGetter</span></pre> 99<div class="block">Marker annotation that can be used to define a non-static, 100 no-argument value-returning (non-void) method to be used as a "getter" 101 for a logical property. 102 It can be used as an alternative to more general 103 <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 104 general case). 105<p> 106 Getter means that when serializing Object instance of class that has 107 this method (possibly inherited from a super class), a call is made 108 through the method, and return value will be serialized as value of 109 the property.</div> 110</li> 111</ul> 112</div> 113<div class="summary"> 114<ul class="blockList"> 115<li class="blockList"> 116<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 117<ul class="blockList"> 118<li class="blockList"><a name="annotation.type.optional.element.summary"> 119<!-- --> 120</a> 121<h3>Optional Element Summary</h3> 122<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 123<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 124<tr> 125<th class="colFirst" scope="col">Modifier and Type</th> 126<th class="colLast" scope="col">Optional Element and Description</th> 127</tr> 128<tr class="altColor"> 129<td class="colFirst"><code><a href="https://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> 130<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html#value--">value</a></span></code> 131<div class="block">Defines name of the logical property this 132 method is used to access ("get"); empty String means that 133 name should be derived from the underlying method (using 134 standard Bean name detection rules)</div> 135</td> 136</tr> 137</table> 138</li> 139</ul> 140</li> 141</ul> 142</div> 143<div class="details"> 144<ul class="blockList"> 145<li class="blockList"> 146<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 147<ul class="blockList"> 148<li class="blockList"><a name="annotation.type.element.detail"> 149<!-- --> 150</a> 151<h3>Element Detail</h3> 152<a name="value--"> 153<!-- --> 154</a> 155<ul class="blockListLast"> 156<li class="blockList"> 157<h4>value</h4> 158<pre>public abstract <a href="https://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> 159<div class="block">Defines name of the logical property this 160 method is used to access ("get"); empty String means that 161 name should be derived from the underlying method (using 162 standard Bean name detection rules)</div> 163<dl> 164<dt><span class="returnLabel">Returns:</span></dt> 165<dd>Name of the logical property (or "" to use 'default', 166 if available)</dd> 167</dl> 168<dl> 169<dt>Default:</dt> 170<dd>""</dd> 171</dl> 172</li> 173</ul> 174</li> 175</ul> 176</li> 177</ul> 178</div> 179</div> 180<!-- ========= END OF CLASS DATA ========= --> 181<!-- ======= START OF BOTTOM NAVBAR ====== --> 182<div class="bottomNav"><a name="navbar.bottom"> 183<!-- --> 184</a> 185<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 186<a name="navbar.bottom.firstrow"> 187<!-- --> 188</a> 189<ul class="navList" title="Navigation"> 190<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 191<li class="navBarCell1Rev">Class</li> 192<li><a href="class-use/JsonGetter.html">Use</a></li> 193<li><a href="package-tree.html">Tree</a></li> 194<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 195<li><a href="../../../../index-all.html">Index</a></li> 196<li><a href="../../../../help-doc.html">Help</a></li> 197</ul> 198</div> 199<div class="subNav"> 200<ul class="navList"> 201<li><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 202<li><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 203</ul> 204<ul class="navList"> 205<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonGetter.html" target="_top">Frames</a></li> 206<li><a href="JsonGetter.html" target="_top">No Frames</a></li> 207</ul> 208<ul class="navList" id="allclasses_navbar_bottom"> 209<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 210</ul> 211<div> 212<script type="text/javascript"><!-- 213 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 214 if(window==top) { 215 allClassesLink.style.display = "block"; 216 } 217 else { 218 allClassesLink.style.display = "none"; 219 } 220 //--> 221</script> 222</div> 223<div> 224<ul class="subNavList"> 225<li>Summary: </li> 226<li>Field | </li> 227<li>Required | </li> 228<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 229</ul> 230<ul class="subNavList"> 231<li>Detail: </li> 232<li>Field | </li> 233<li><a href="#annotation.type.element.detail">Element</a></li> 234</ul> 235</div> 236<a name="skip.navbar.bottom"> 237<!-- --> 238</a></div> 239<!-- ======== END OF BOTTOM NAVBAR ======= --> 240<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 241</body> 242</html> 243