• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_79) on Tue Jan 23 20:10:06 PST 2018 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>JsonAnySetter (Jackson-annotations 2.9.0 API)</title>
8<meta name="date" content="2018-01-23">
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="JsonAnySetter (Jackson-annotations 2.9.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/JsonAnySetter.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/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.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/JsonAnySetter.html" target="_top">Frames</a></li>
44<li><a href="JsonAnySetter.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 JsonAnySetter" class="title">Annotation Type JsonAnySetter</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://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#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</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>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>})
88<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>)
89public @interface <span class="strong">JsonAnySetter</span></pre>
90<div class="block">Marker annotation that can be used to define a logical "any setter" mutator --
91 either using non-static
92 two-argument method (first argument name of property, second value
93 to set) or a field (of type <a href="http://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> or POJO) -
94 to be used as a "fallback" handler
95 for all otherwise unrecognized properties found from JSON content.
96 It is similar to <a href="http://docs.oracle.com/javase/6/docs/api/javax/xml/bind/annotation/XmlAnyElement.html?is-external=true" title="class or interface in javax.xml.bind.annotation"><code>XmlAnyElement</code></a>
97 in behavior; and can only be used to denote a single property
98 per type.
99<p>
100 If used, all otherwise unmapped key-value pairs from JSON Object values
101 are added using mutator.
102<p>
103 NOTE: ability to annotated fields was added in version 2.8; earlier only
104 methods could be annotated.</div>
105</li>
106</ul>
107</div>
108<div class="summary">
109<ul class="blockList">
110<li class="blockList">
111<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
112<ul class="blockList">
113<li class="blockList"><a name="annotation_type_optional_element_summary">
114<!--   -->
115</a>
116<h3>Optional Element Summary</h3>
117<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
118<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
119<tr>
120<th class="colFirst" scope="col">Modifier and Type</th>
121<th class="colLast" scope="col">Optional Element and Description</th>
122</tr>
123<tr class="altColor">
124<td class="colFirst"><code>boolean</code></td>
125<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html#enabled()">enabled</a></strong></code>
126<div class="block">Optional argument that defines whether this annotation is active
127 or not.</div>
128</td>
129</tr>
130</table>
131</li>
132</ul>
133</li>
134</ul>
135</div>
136<div class="details">
137<ul class="blockList">
138<li class="blockList">
139<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
140<ul class="blockList">
141<li class="blockList"><a name="annotation_type_element_detail">
142<!--   -->
143</a>
144<h3>Element Detail</h3>
145<a name="enabled()">
146<!--   -->
147</a>
148<ul class="blockListLast">
149<li class="blockList">
150<h4>enabled</h4>
151<pre>public abstract&nbsp;boolean&nbsp;enabled</pre>
152<div class="block">Optional argument that defines whether this annotation is active
153 or not. The only use for value 'false' if for overriding purposes.
154 Overriding may be necessary when used
155 with "mix-in annotations" (aka "annotation overrides").
156 For most cases, however, default value of "true" is just fine
157 and should be omitted.</div>
158<dl><dt><span class="strong">Since:</span></dt>
159  <dd>2.9</dd></dl>
160<dl>
161<dt>Default:</dt>
162<dd>true</dd>
163</dl>
164</li>
165</ul>
166</li>
167</ul>
168</li>
169</ul>
170</div>
171</div>
172<!-- ========= END OF CLASS DATA ========= -->
173<!-- ======= START OF BOTTOM NAVBAR ====== -->
174<div class="bottomNav"><a name="navbar_bottom">
175<!--   -->
176</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
177<!--   -->
178</a>
179<ul class="navList" title="Navigation">
180<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
181<li class="navBarCell1Rev">Class</li>
182<li><a href="class-use/JsonAnySetter.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="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
192<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
193</ul>
194<ul class="navList">
195<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAnySetter.html" target="_top">Frames</a></li>
196<li><a href="JsonAnySetter.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:&nbsp;</li>
216<li>Required&nbsp;|&nbsp;</li>
217<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
218</ul>
219<ul class="subNavList">
220<li>Detail:&nbsp;</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<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
229</body>
230</html>
231