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> 8JacksonInject (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="JacksonInject (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/JacksonInject.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/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.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/JacksonInject.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JacksonInject.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 JacksonInject</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>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</A>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</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>JacksonInject</B></DL> 108</PRE> 109 110<P> 111Jackson-specific annotation used for indicating that value of 112 annotated property will be "injected", i.e. set based on value 113 configured by <code>ObjectMapper</code> (usually on per-call basis). 114 Usually property is not deserialized from JSON, although it possible 115 to have injected value as default and still allow optional override 116 from JSON. 117<P> 118 119<P> 120<HR> 121 122<P> 123<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 124 125<A NAME="annotation_type_optional_element_summary"><!-- --></A> 126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 128<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 129<B>Optional Element Summary</B></FONT></TH> 130</TR> 131<TR BGCOLOR="white" CLASS="TableRowColor"> 132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 133<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> 134<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JacksonInject.html#value()">value</A></B></CODE> 135 136<BR> 137 Logical id of the value to inject; if not specified (or specified 138 as empty String), will use id based on declared type of property.</TD> 139</TR> 140</TABLE> 141 142<P> 143<A NAME="value()"><!-- --></A><H3> 144value</H3> 145<PRE> 146public 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> 147<DL> 148<DD>Logical id of the value to inject; if not specified (or specified 149 as empty String), will use id based on declared type of property. 150<P> 151<DD><DL> 152</DL> 153</DD> 154<DD><DL> 155</DL> 156<DL> 157<DT><B>Default:</B><DD>""</DD> 158</DL> 159</DL> 160<!-- ========= END OF CLASS DATA ========= --> 161<HR> 162 163 164<!-- ======= START OF BOTTOM NAVBAR ====== --> 165<A NAME="navbar_bottom"><!-- --></A> 166<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 167<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 168<TR><td rowspan='3'><script type="text/javascript"><!-- 169google_ad_client = "pub-1467773697956887"; 170/* Jackson-ad-small */ 171google_ad_slot = "6699487946"; 172google_ad_width = 234; 173google_ad_height = 60; 174//--> 175</script> 176<script type="text/javascript" 177src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 178</script> 179<!-- GA --> 180<script type="text/javascript"> 181var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 182document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 183</script> 184<script type="text/javascript"> 185try { 186var pageTracker = _gat._getTracker("UA-140287-6"); 187pageTracker._trackPageview(); 188} catch(err) {} 189</script> 190</td> 191<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 192<A NAME="navbar_bottom_firstrow"><!-- --></A> 193<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 194 <TR ALIGN="center" VALIGN="top"> 195 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 196 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 197 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JacksonInject.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 198 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 199 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 200 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 201 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 202 </TR> 203</TABLE> 204</TD> 205<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 206</EM> 207</TD> 208</TR> 209 210<TR> 211<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 212 <A HREF="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 213 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 214<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 215 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JacksonInject.html" target="_top"><B>FRAMES</B></A> 216 <A HREF="JacksonInject.html" target="_top"><B>NO FRAMES</B></A> 217 <SCRIPT type="text/javascript"> 218 <!-- 219 if(window==top) { 220 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 221 } 222 //--> 223</SCRIPT> 224<NOSCRIPT> 225 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 226</NOSCRIPT> 227 228 229</FONT></TD> 230</TR> 231<TR> 232<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 233 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 234<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 235DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 236</TR> 237</TABLE> 238<A NAME="skip-navbar_bottom"></A> 239<!-- ======== END OF BOTTOM NAVBAR ======= --> 240 241<HR> 242Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 243</BODY> 244</HTML> 245