• Home
  • 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>
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>
8JsonIgnoreProperties (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="JsonIgnoreProperties (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>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JsonIgnoreProperties.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A>&nbsp;
68&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.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/JsonIgnoreProperties.html" target="_top"><B>FRAMES</B></A>  &nbsp;
71&nbsp;<A HREF="JsonIgnoreProperties.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
72&nbsp;<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:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
90DETAIL:&nbsp;<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 JsonIgnoreProperties</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#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#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#CONSTRUCTOR" title="class or interface in java.lang.annotation">CONSTRUCTOR</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>})
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>JsonIgnoreProperties</B></DL>
108</PRE>
109
110<P>
111Annotation that can be used to either suppress serialization of
112 properties (during serialization), or ignore processing of
113 JSON properties read (during deserialization).
114<p>
115 Example:
116<pre>
117 // to prevent specified fields from being serialized or deserialized
118 // (i.e. not include in JSON output; or being set even if they were included)
119 &#064;JsonIgnoreProperties({ "internalId", "secretKey" })
120 // To ignore any unknown properties in JSON input without exception:
121 &#064;JsonIgnoreProperties(ignoreUnknown=true)
122</pre>
123<p>
124 Starting with 2.0, this annotation can be applied both to classes and
125 to properties. If used for both, actual set will be union of all
126 ignorals: that is, you can only add properties to ignore, not remove
127 or override. So you can not remove properties to ignore using
128 per-property annotation.
129<P>
130
131<P>
132<HR>
133
134<P>
135<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
136
137<A NAME="annotation_type_optional_element_summary"><!-- --></A>
138<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
139<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
140<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
141<B>Optional Element Summary</B></FONT></TH>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;boolean</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html#ignoreUnknown()">ignoreUnknown</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Property that defines whether it is ok to just ignore any
150 unrecognized properties during deserialization.</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>&nbsp;<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>
155<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html#value()">value</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Names of properties to ignore.</TD>
159</TR>
160</TABLE>
161&nbsp;
162<P>
163<A NAME="value()"><!-- --></A><H3>
164value</H3>
165<PRE>
166public 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>
167<DL>
168<DD>Names of properties to ignore.
169<P>
170<DD><DL>
171</DL>
172</DD>
173<DD><DL>
174</DL>
175<DL>
176<DT><B>Default:</B><DD>{}</DD>
177</DL>
178</DL>
179<HR>
180
181<A NAME="ignoreUnknown()"><!-- --></A><H3>
182ignoreUnknown</H3>
183<PRE>
184public abstract boolean <B>ignoreUnknown</B></PRE>
185<DL>
186<DD>Property that defines whether it is ok to just ignore any
187 unrecognized properties during deserialization.
188 If true, all properties that are unrecognized -- that is,
189 there are no setters or creators that accept them -- are
190 ignored without warnings (although handlers for unknown
191 properties, if any, will still be called) without
192 exception.
193<p>
194 Does not have any effect on serialization.
195<P>
196<DD><DL>
197</DL>
198</DD>
199<DD><DL>
200</DL>
201<DL>
202<DT><B>Default:</B><DD>false</DD>
203</DL>
204</DL>
205<!-- ========= END OF CLASS DATA ========= -->
206<HR>
207
208
209<!-- ======= START OF BOTTOM NAVBAR ====== -->
210<A NAME="navbar_bottom"><!-- --></A>
211<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
212<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
213<TR><td rowspan='3'><script type="text/javascript"><!--
214google_ad_client = "pub-1467773697956887";
215/* Jackson-ad-small */
216google_ad_slot = "6699487946";
217google_ad_width = 234;
218google_ad_height = 60;
219//-->
220</script>
221<script type="text/javascript"
222src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
223</script>
224<!-- GA -->
225<script type="text/javascript">
226var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
227document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
228</script>
229<script type="text/javascript">
230try {
231var pageTracker = _gat._getTracker("UA-140287-6");
232pageTracker._trackPageview();
233} catch(err) {}
234</script>
235</td>
236<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
237<A NAME="navbar_bottom_firstrow"><!-- --></A>
238<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
239  <TR ALIGN="center" VALIGN="top">
240  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
241  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
242  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JsonIgnoreProperties.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
243  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
244  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
245  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
246  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
247  </TR>
248</TABLE>
249</TD>
250<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
251</EM>
252</TD>
253</TR>
254
255<TR>
256<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
257&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A>&nbsp;
258&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD>
259<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
260  <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" target="_top"><B>FRAMES</B></A>  &nbsp;
261&nbsp;<A HREF="JsonIgnoreProperties.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
262&nbsp;<SCRIPT type="text/javascript">
263  <!--
264  if(window==top) {
265    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
266  }
267  //-->
268</SCRIPT>
269<NOSCRIPT>
270  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
271</NOSCRIPT>
272
273
274</FONT></TD>
275</TR>
276<TR>
277<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
278  SUMMARY:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
279<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
280DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
281</TR>
282</TABLE>
283<A NAME="skip-navbar_bottom"></A>
284<!-- ======== END OF BOTTOM NAVBAR ======= -->
285
286<HR>
287Copyright &#169; 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.
288</BODY>
289</HTML>
290