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> 8JsonIgnore (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="JsonIgnore (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/JsonIgnore.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/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.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/JsonIgnore.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JsonIgnore.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 JsonIgnore</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#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>JsonIgnore</B></DL> 99</PRE> 100 101<P> 102Marker annotation that indicates that the annotated method or field is to be 103 ignored by introspection-based 104 serialization and deserialization functionality. That is, it should 105 not be consider a "getter", "setter" or "creator". 106<p> 107 In addition, starting with Jackson 1.9, if this is the only annotation 108 associated with a property, it will also cause cause the whole 109 property to be ignored: that is, if setter has this annotation and 110 getter has no annotations, getter is also effectively ignored. 111 It is still possible for different accessors to use different 112 annotations; so if only "getter" is to be ignored, other accessors 113 (setter or field) would need explicit annotation to prevent 114 ignoral (usually <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonProperty</CODE></A>). 115 <p> 116 For example, a "getter" method that would otherwise denote 117 a property (like, say, "getValue" to suggest property "value") 118 to serialize, would be ignored and no such property would 119 be output unless another annotation defines alternative method to use. 120<p> 121 Before version 1.9, this annotation worked purely on method-by-method (or field-by-field) 122 basis; annotation on one method or field did not imply ignoring other methods 123 or fields. However, with version 1.9 and above, annotations associated 124 with various accessors (getter, setter, field, constructor parameter) of 125 a logical property are combined; meaning that annotations in one (say, setter) 126 can have effects on all of them (if getter or field has nothing indicating 127 otherwise). 128<p> 129 Annotation is usually used just a like a marker annotation, that 130 is, without explicitly defining 'value' argument (which defaults 131 to <code>true</code>): but argument can be explicitly defined. 132 This can be done to override an existing JsonIgnore by explictly 133 defining one with 'false' argument. 134<p> 135 Annotation is similar to <A HREF="http://docs.oracle.com/javase/6/docs/api/javax/xml/bind/annotation/XmlTransient.html?is-external=true" title="class or interface in javax.xml.bind.annotation"><CODE>XmlTransient</CODE></A> 136<P> 137 138<P> 139<HR> 140 141<P> 142<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 143 144<A NAME="annotation_type_optional_element_summary"><!-- --></A> 145<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 146<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 147<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 148<B>Optional Element Summary</B></FONT></TH> 149</TR> 150<TR BGCOLOR="white" CLASS="TableRowColor"> 151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 152<CODE> boolean</CODE></FONT></TD> 153<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html#value()">value</A></B></CODE> 154 155<BR> 156 Optional argument that defines whether this annotation is active 157 or not.</TD> 158</TR> 159</TABLE> 160 161<P> 162<A NAME="value()"><!-- --></A><H3> 163value</H3> 164<PRE> 165public abstract boolean <B>value</B></PRE> 166<DL> 167<DD>Optional argument that defines whether this annotation is active 168 or not. The only use for value 'false' if for overriding purposes 169 (which is not needed often); most likely it is needed for use 170 with "mix-in annotations" (aka "annotation overrides"). 171 For most cases, however, default value of "true" is just fine 172 and should be omitted. 173<P> 174<DD><DL> 175</DL> 176</DD> 177<DD><DL> 178</DL> 179<DL> 180<DT><B>Default:</B><DD>true</DD> 181</DL> 182</DL> 183<!-- ========= END OF CLASS DATA ========= --> 184<HR> 185 186 187<!-- ======= START OF BOTTOM NAVBAR ====== --> 188<A NAME="navbar_bottom"><!-- --></A> 189<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 190<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 191<TR> 192<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 193<A NAME="navbar_bottom_firstrow"><!-- --></A> 194<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 195 <TR ALIGN="center" VALIGN="top"> 196 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 197 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 198 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonIgnore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 199 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 200 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 201 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 202 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 203 </TR> 204</TABLE> 205</TD> 206<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 207</EM> 208</TD> 209</TR> 210 211<TR> 212<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 213 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 214 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 215<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 216 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonIgnore.html" target="_top"><B>FRAMES</B></A> 217 <A HREF="JsonIgnore.html" target="_top"><B>NO FRAMES</B></A> 218 <SCRIPT type="text/javascript"> 219 <!-- 220 if(window==top) { 221 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 222 } 223 //--> 224</SCRIPT> 225<NOSCRIPT> 226 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 227</NOSCRIPT> 228 229 230</FONT></TD> 231</TR> 232<TR> 233<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 234 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 235<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 236DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 237</TR> 238</TABLE> 239<A NAME="skip-navbar_bottom"></A> 240<!-- ======== END OF BOTTOM NAVBAR ======= --> 241 242<HR> 243Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 244</BODY> 245</HTML> 246