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:30 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonAnyGetter (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="JsonAnyGetter (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/JsonAnyGetter.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/JsonAlias.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.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/JsonAnyGetter.html" target="_top">Frames</a></li> 51<li><a href="JsonAnyGetter.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 JsonAnyGetter" class="title">Annotation Type JsonAnyGetter</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">JsonAnyGetter</span></pre> 99<div class="block">Marker annotation that can be used to define a non-static, 100 no-argument method to be an "any getter"; accessor for getting 101 a set of key/value pairs, to be serialized as part of containing POJO 102 (similar to unwrapping) along with regular property values it has. 103 This typically serves as a counterpart 104 to "any setter" mutators (see <a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonAnySetter</code></a>). 105 Note that the return type of annotated methods <b>must</b> be 106 <a href="https://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>). 107<p> 108 As with <a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonAnySetter</code></a>, only one property should be annotated 109 with this annotation; if multiple methods are annotated, an exception 110 may be thrown.</div> 111</li> 112</ul> 113</div> 114<div class="summary"> 115<ul class="blockList"> 116<li class="blockList"> 117<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 118<ul class="blockList"> 119<li class="blockList"><a name="annotation.type.optional.element.summary"> 120<!-- --> 121</a> 122<h3>Optional Element Summary</h3> 123<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 124<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 125<tr> 126<th class="colFirst" scope="col">Modifier and Type</th> 127<th class="colLast" scope="col">Optional Element and Description</th> 128</tr> 129<tr class="altColor"> 130<td class="colFirst"><code>boolean</code></td> 131<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html#enabled--">enabled</a></span></code> 132<div class="block">Optional argument that defines whether this annotation is active 133 or not.</div> 134</td> 135</tr> 136</table> 137</li> 138</ul> 139</li> 140</ul> 141</div> 142<div class="details"> 143<ul class="blockList"> 144<li class="blockList"> 145<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 146<ul class="blockList"> 147<li class="blockList"><a name="annotation.type.element.detail"> 148<!-- --> 149</a> 150<h3>Element Detail</h3> 151<a name="enabled--"> 152<!-- --> 153</a> 154<ul class="blockListLast"> 155<li class="blockList"> 156<h4>enabled</h4> 157<pre>public abstract boolean enabled</pre> 158<div class="block">Optional argument that defines whether this annotation is active 159 or not. The only use for value 'false' if for overriding purposes. 160 Overriding may be necessary when used 161 with "mix-in annotations" (aka "annotation overrides"). 162 For most cases, however, default value of "true" is just fine 163 and should be omitted.</div> 164<dl> 165<dt><span class="returnLabel">Returns:</span></dt> 166<dd>True if annotation is enabled (normal case); false if it is to 167 be ignored (only useful for mix-in annotations to "mask" annotation</dd> 168<dt><span class="simpleTagLabel">Since:</span></dt> 169<dd>2.9</dd> 170</dl> 171<dl> 172<dt>Default:</dt> 173<dd>true</dd> 174</dl> 175</li> 176</ul> 177</li> 178</ul> 179</li> 180</ul> 181</div> 182</div> 183<!-- ========= END OF CLASS DATA ========= --> 184<!-- ======= START OF BOTTOM NAVBAR ====== --> 185<div class="bottomNav"><a name="navbar.bottom"> 186<!-- --> 187</a> 188<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 189<a name="navbar.bottom.firstrow"> 190<!-- --> 191</a> 192<ul class="navList" title="Navigation"> 193<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 194<li class="navBarCell1Rev">Class</li> 195<li><a href="class-use/JsonAnyGetter.html">Use</a></li> 196<li><a href="package-tree.html">Tree</a></li> 197<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 198<li><a href="../../../../index-all.html">Index</a></li> 199<li><a href="../../../../help-doc.html">Help</a></li> 200</ul> 201</div> 202<div class="subNav"> 203<ul class="navList"> 204<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAlias.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 205<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 206</ul> 207<ul class="navList"> 208<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAnyGetter.html" target="_top">Frames</a></li> 209<li><a href="JsonAnyGetter.html" target="_top">No Frames</a></li> 210</ul> 211<ul class="navList" id="allclasses_navbar_bottom"> 212<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 213</ul> 214<div> 215<script type="text/javascript"><!-- 216 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 217 if(window==top) { 218 allClassesLink.style.display = "block"; 219 } 220 else { 221 allClassesLink.style.display = "none"; 222 } 223 //--> 224</script> 225</div> 226<div> 227<ul class="subNavList"> 228<li>Summary: </li> 229<li>Field | </li> 230<li>Required | </li> 231<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 232</ul> 233<ul class="subNavList"> 234<li>Detail: </li> 235<li>Field | </li> 236<li><a href="#annotation.type.element.detail">Element</a></li> 237</ul> 238</div> 239<a name="skip.navbar.bottom"> 240<!-- --> 241</a></div> 242<!-- ======== END OF BOTTOM NAVBAR ======= --> 243<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 244</body> 245</html> 246