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_29) on Mon Mar 26 18:49:10 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonIgnoreProperties (Jackson-annotations 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 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="JsonIgnoreProperties (Jackson-annotations 2.0.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/JsonIgnoreProperties.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><EM> 52</EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JsonIgnoreProperties.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.fasterxml.jackson.annotation</FONT> 92<BR> 93Annotation Type JsonIgnoreProperties</H2> 94<HR> 95<DL> 96<DT><PRE><FONT SIZE="-1"><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#TYPE" title="class or interface in java.lang.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#CONSTRUCTOR" title="class or interface in java.lang.annotation">CONSTRUCTOR</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>}) 97<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>) 98</FONT>public @interface <B>JsonIgnoreProperties</B></DL> 99</PRE> 100 101<P> 102Annotation that can be used to either suppress serialization of 103 properties (during serialization), or ignore processing of 104 JSON properties read (during deserialization). 105<p> 106 Example: 107<pre> 108 // to prevent specified fields from being serialized or deserialized 109 // (i.e. not include in JSON output; or being set even if they were included) 110 @JsonIgnoreProperties({ "internalId", "secretKey" }) 111 // To ignore any unknown properties in JSON input without exception: 112 @JsonIgnoreProperties(ignoreUnknown=true) 113</pre> 114<p> 115 Starting with 2.0, this annotation can be applied both to classes and 116 to properties. If used for both, actual set will be union of all 117 ignorals: that is, you can only add properties to ignore, not remove 118 or override. So you can not remove properties to ignore using 119 per-property annotation. 120<P> 121 122<P> 123<HR> 124 125<P> 126<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 127 128<A NAME="annotation_type_optional_element_summary"><!-- --></A> 129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 131<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 132<B>Optional Element Summary</B></FONT></TH> 133</TR> 134<TR BGCOLOR="white" CLASS="TableRowColor"> 135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 136<CODE> boolean</CODE></FONT></TD> 137<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html#ignoreUnknown()">ignoreUnknown</A></B></CODE> 138 139<BR> 140 Property that defines whether it is ok to just ignore any 141 unrecognized properties during deserialization.</TD> 142</TR> 143<TR BGCOLOR="white" CLASS="TableRowColor"> 144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 145<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD> 146<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html#value()">value</A></B></CODE> 147 148<BR> 149 Names of properties to ignore.</TD> 150</TR> 151</TABLE> 152 153<P> 154<A NAME="value()"><!-- --></A><H3> 155value</H3> 156<PRE> 157public abstract <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>value</B></PRE> 158<DL> 159<DD>Names of properties to ignore. 160<P> 161<DD><DL> 162</DL> 163</DD> 164<DD><DL> 165</DL> 166<DL> 167<DT><B>Default:</B><DD>{}</DD> 168</DL> 169</DL> 170<HR> 171 172<A NAME="ignoreUnknown()"><!-- --></A><H3> 173ignoreUnknown</H3> 174<PRE> 175public abstract boolean <B>ignoreUnknown</B></PRE> 176<DL> 177<DD>Property that defines whether it is ok to just ignore any 178 unrecognized properties during deserialization. 179 If true, all properties that are unrecognized -- that is, 180 there are no setters or creators that accept them -- are 181 ignored without warnings (although handlers for unknown 182 properties, if any, will still be called) without 183 exception. 184<p> 185 Does not have any effect on serialization. 186<P> 187<DD><DL> 188</DL> 189</DD> 190<DD><DL> 191</DL> 192<DL> 193<DT><B>Default:</B><DD>false</DD> 194</DL> 195</DL> 196<!-- ========= END OF CLASS DATA ========= --> 197<HR> 198 199 200<!-- ======= START OF BOTTOM NAVBAR ====== --> 201<A NAME="navbar_bottom"><!-- --></A> 202<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 203<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 204<TR> 205<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 206<A NAME="navbar_bottom_firstrow"><!-- --></A> 207<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 208 <TR ALIGN="center" VALIGN="top"> 209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 210 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 211 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonIgnoreProperties.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 212 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 213 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 214 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 215 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 216 </TR> 217</TABLE> 218</TD> 219<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 220</EM> 221</TD> 222</TR> 223 224<TR> 225<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 226 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 227 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 228<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 229 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" target="_top"><B>FRAMES</B></A> 230 <A HREF="JsonIgnoreProperties.html" target="_top"><B>NO FRAMES</B></A> 231 <SCRIPT type="text/javascript"> 232 <!-- 233 if(window==top) { 234 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 235 } 236 //--> 237</SCRIPT> 238<NOSCRIPT> 239 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 240</NOSCRIPT> 241 242 243</FONT></TD> 244</TR> 245<TR> 246<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 247 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 248<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 249DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 250</TR> 251</TABLE> 252<A NAME="skip-navbar_bottom"></A> 253<!-- ======== END OF BOTTOM NAVBAR ======= --> 254 255<HR> 256Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 257</BODY> 258</HTML> 259