• Home
  • History
  • Annotate
  • 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_55) on Thu Jan 01 15:31:15 PST 2015 -->
6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7<title>JsonCreator (Jackson-annotations 2.5.0 API)</title>
8<meta name="date" content="2015-01-01">
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="JsonCreator (Jackson-annotations 2.5.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/JsonCreator.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/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum 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/JsonCreator.html" target="_top">Frames</a></li>
44<li><a href="JsonCreator.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 JsonCreator" class="title">Annotation Type JsonCreator</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>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCTOR" title="class or interface in java.lang.annotation">CONSTRUCTOR</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">JsonCreator</span></pre>
90<div class="block">Marker annotation that can be used to define constructors and factory
91 methods as one to use for instantiating new instances of the associated
92 class.
93<p>
94 NOTE: when annotating creator methods (constructors, factory methods),
95 method must either be:
96<ul>
97 <li>Single-argument constructor/factory method without <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a>
98    annotation for the argument: if so, this is so-called "delegate creator",
99    in which case Jackson first binds JSON into type of the argument, and
100    then calls creator
101   </li>
102 <li>Constructor/factory method where <b>every argument</b> is annotated with
103   either <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> or <a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation"><code>JacksonInject</code></a>, to indicate name
104   of property to bind to
105  </li>
106 </ul>
107 Also note that all <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotations MUST use actual name
108 (NOT empty String for "default"): this because Java bytecode does not
109 retain names of method or constructor arguments.
110<br />
111 NOTE: as of JDK 8, some of above changes, with introduction of names for
112 constructor and method parameters.</div>
113</li>
114</ul>
115</div>
116<div class="summary">
117<ul class="blockList">
118<li class="blockList">
119<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
120<ul class="blockList">
121<li class="blockList"><a name="annotation_type_optional_element_summary">
122<!--   -->
123</a>
124<h3>Optional Element Summary</h3>
125<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
126<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
127<tr>
128<th class="colFirst" scope="col">Modifier and Type</th>
129<th class="colLast" scope="col">Optional Element and Description</th>
130</tr>
131<tr class="altColor">
132<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></code></td>
133<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html#mode()">mode</a></strong></code>
134<div class="block">Property that is used to indicate how argument(s) is/are bound for creator,
135 in cases there may be multiple alternatives.</div>
136</td>
137</tr>
138</table>
139</li>
140</ul>
141</li>
142</ul>
143</div>
144<div class="details">
145<ul class="blockList">
146<li class="blockList">
147<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
148<ul class="blockList">
149<li class="blockList"><a name="annotation_type_element_detail">
150<!--   -->
151</a>
152<h3>Element Detail</h3>
153<a name="mode()">
154<!--   -->
155</a>
156<ul class="blockListLast">
157<li class="blockList">
158<h4>mode</h4>
159<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a>&nbsp;mode</pre>
160<div class="block">Property that is used to indicate how argument(s) is/are bound for creator,
161 in cases there may be multiple alternatives. Currently the one case is that
162 of a single-argument creator method, for which both so-called "delegating" and
163 "property-based" bindings are possible: since
164 delegating mode can not be used for multi-argument creators, the only choice
165 there is "property-based" mode.
166 Check <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation"><code>JsonCreator.Mode</code></a> for more complete explanation of possible choices.
167<p>
168 Default value of <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html#DEFAULT"><code>JsonCreator.Mode.DEFAULT</code></a> means that caller is to use standard
169 heuristics for choosing mode to use.</div>
170<dl><dt><span class="strong">Since:</span></dt>
171  <dd>2.5</dd></dl>
172<dl>
173<dt>Default:</dt>
174<dd>com.fasterxml.jackson.annotation.JsonCreator.Mode.DEFAULT</dd>
175</dl>
176</li>
177</ul>
178</li>
179</ul>
180</li>
181</ul>
182</div>
183</div>
184<!-- ========= END OF CLASS DATA ========= -->
185<!-- ======= START OF BOTTOM NAVBAR ====== -->
186<div class="bottomNav"><a name="navbar_bottom">
187<!--   -->
188</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
189<!--   -->
190</a>
191<ul class="navList" title="Navigation">
192<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
193<li class="navBarCell1Rev">Class</li>
194<li><a href="class-use/JsonCreator.html">Use</a></li>
195<li><a href="package-tree.html">Tree</a></li>
196<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
197<li><a href="../../../../index-all.html">Index</a></li>
198<li><a href="../../../../help-doc.html">Help</a></li>
199</ul>
200</div>
201<div class="subNav">
202<ul class="navList">
203<li><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
204<li><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
205</ul>
206<ul class="navList">
207<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonCreator.html" target="_top">Frames</a></li>
208<li><a href="JsonCreator.html" target="_top">No Frames</a></li>
209</ul>
210<ul class="navList" id="allclasses_navbar_bottom">
211<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
212</ul>
213<div>
214<script type="text/javascript"><!--
215  allClassesLink = document.getElementById("allclasses_navbar_bottom");
216  if(window==top) {
217    allClassesLink.style.display = "block";
218  }
219  else {
220    allClassesLink.style.display = "none";
221  }
222  //-->
223</script>
224</div>
225<div>
226<ul class="subNavList">
227<li>Summary:&nbsp;</li>
228<li>Required&nbsp;|&nbsp;</li>
229<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
230</ul>
231<ul class="subNavList">
232<li>Detail:&nbsp;</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 &#169; 2014-2015 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p>
241</body>
242</html>
243