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> 8JsonInclude (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="JsonInclude (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/JsonInclude.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/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum 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/JsonInclude.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonInclude.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 JsonInclude</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#TYPE" title="class or interface in java.lang.annotation">TYPE</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>JsonInclude</B></DL> 108</PRE> 109 110<P> 111Annotation used to indicate when value of the annotated property (when 112 used for a field, method or constructor parameter), or all 113 properties of the annotated class, is to be serialized. 114 Without annotation property values are always included, but by using 115 this annotation one can specify simple exclusion rules to reduce 116 amount of properties to write out. 117<P> 118 119<P> 120<DL> 121<DT><B>Since:</B></DT> 122 <DD>2.0</DD> 123</DL> 124<HR> 125 126<P> 127<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 128 129<A NAME="annotation_type_optional_element_summary"><!-- --></A> 130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 133<B>Optional Element Summary</B></FONT></TH> 134</TR> 135<TR BGCOLOR="white" CLASS="TableRowColor"> 136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 137<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A></CODE></FONT></TD> 138<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#value()">value</A></B></CODE> 139 140<BR> 141 Inclusion rule to use.</TD> 142</TR> 143</TABLE> 144 145<P> 146<A NAME="value()"><!-- --></A><H3> 147value</H3> 148<PRE> 149public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A> <B>value</B></PRE> 150<DL> 151<DD>Inclusion rule to use. 152<P> 153<DD><DL> 154</DL> 155</DD> 156<DD><DL> 157</DL> 158<DL> 159<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonInclude.Include.ALWAYS</DD> 160</DL> 161</DL> 162<!-- ========= END OF CLASS DATA ========= --> 163<HR> 164 165 166<!-- ======= START OF BOTTOM NAVBAR ====== --> 167<A NAME="navbar_bottom"><!-- --></A> 168<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 169<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 170<TR><td rowspan='3'><script type="text/javascript"><!-- 171google_ad_client = "pub-1467773697956887"; 172/* Jackson-ad-small */ 173google_ad_slot = "6699487946"; 174google_ad_width = 234; 175google_ad_height = 60; 176//--> 177</script> 178<script type="text/javascript" 179src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 180</script> 181<!-- GA --> 182<script type="text/javascript"> 183var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 184document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 185</script> 186<script type="text/javascript"> 187try { 188var pageTracker = _gat._getTracker("UA-140287-6"); 189pageTracker._trackPageview(); 190} catch(err) {} 191</script> 192</td> 193<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 194<A NAME="navbar_bottom_firstrow"><!-- --></A> 195<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 196 <TR ALIGN="center" VALIGN="top"> 197 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 198 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 199 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonInclude.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 200 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 201 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 202 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 203 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 204 </TR> 205</TABLE> 206</TD> 207<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 208</EM> 209</TD> 210</TR> 211 212<TR> 213<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 214 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 215 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 216<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 217 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonInclude.html" target="_top"><B>FRAMES</B></A> 218 <A HREF="JsonInclude.html" target="_top"><B>NO FRAMES</B></A> 219 <SCRIPT type="text/javascript"> 220 <!-- 221 if(window==top) { 222 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 223 } 224 //--> 225</SCRIPT> 226<NOSCRIPT> 227 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 228</NOSCRIPT> 229 230 231</FONT></TD> 232</TR> 233<TR> 234<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 235 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 236<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 237DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 238</TR> 239</TABLE> 240<A NAME="skip-navbar_bottom"></A> 241<!-- ======== END OF BOTTOM NAVBAR ======= --> 242 243<HR> 244Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 245</BODY> 246</HTML> 247