• 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>
8JsonInclude.Include (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.Include (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/JsonInclude.Include.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/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A>&nbsp;
68&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.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/JsonInclude.Include.html" target="_top"><B>FRAMES</B></A>  &nbsp;
71&nbsp;<A HREF="JsonInclude.Include.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;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
90DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</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>
102Enum JsonInclude.Include</H2>
103<PRE>
104<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
105  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</A>&lt;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A>&gt;
106      <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.fasterxml.jackson.annotation.JsonInclude.Include</B>
107</PRE>
108<DL>
109<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>&lt;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A>&gt;</DD>
110</DL>
111<DL>
112<DT><B>Enclosing class:</B><DD><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</A></DD>
113</DL>
114<HR>
115<DL>
116<DT><PRE>public static enum <B>JsonInclude.Include</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A>&lt;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A>&gt;</DL>
117</PRE>
118
119<P>
120Enumeration used with <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonInclude</CODE></A>
121 to define which properties
122 of Java Beans are to be included in serialization.
123<p>
124 Note: Jackson 1.x had similarly named ("Inclusion") enumeration included
125 in <code>JsonSerialize</code> annotation: it is not deprecated
126 and this value used instead.
127<P>
128
129<P>
130<HR>
131
132<P>
133<!-- =========== ENUM CONSTANT SUMMARY =========== -->
134
135<A NAME="enum_constant_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139<B>Enum Constant Summary</B></FONT></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#ALWAYS">ALWAYS</A></B></CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value that indicates that property is to be always included,
146 independent of value of the property.</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_DEFAULT">NON_DEFAULT</A></B></CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value that indicates that only properties that have values
153 that differ from default settings (meaning values they have
154 when Bean is constructed with its no-arguments constructor)
155 are to be included.</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_EMPTY">NON_EMPTY</A></B></CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value that indicates that only properties that have values
162 that values that are null or what is considered empty are
163 not to be included.</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_NULL">NON_NULL</A></B></CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value that indicates that only properties with non-null
170 values are to be included.</TD>
171</TR>
172</TABLE>
173&nbsp;
174<!-- ========== METHOD SUMMARY =========== -->
175
176<A NAME="method_summary"><!-- --></A>
177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
178<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
179<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
180<B>Method Summary</B></FONT></TH>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>static&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A></CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#valueOf(java.lang.String)">valueOf</A></B>(<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>&nbsp;name)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>static&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A>[]</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#values()">values</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
197the order they are declared.</TD>
198</TR>
199</TABLE>
200&nbsp;<A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
203<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A></B></TH>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</A></CODE></TD>
207</TR>
208</TABLE>
209&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
210<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
212<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
216</TR>
217</TABLE>
218&nbsp;
219<P>
220
221<!-- ============ ENUM CONSTANT DETAIL =========== -->
222
223<A NAME="enum_constant_detail"><!-- --></A>
224<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
225<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
226<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
227<B>Enum Constant Detail</B></FONT></TH>
228</TR>
229</TABLE>
230
231<A NAME="ALWAYS"><!-- --></A><H3>
232ALWAYS</H3>
233<PRE>
234public static final <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A> <B>ALWAYS</B></PRE>
235<DL>
236<DD>Value that indicates that property is to be always included,
237 independent of value of the property.
238<P>
239<DL>
240</DL>
241</DL>
242<HR>
243
244<A NAME="NON_NULL"><!-- --></A><H3>
245NON_NULL</H3>
246<PRE>
247public static final <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A> <B>NON_NULL</B></PRE>
248<DL>
249<DD>Value that indicates that only properties with non-null
250 values are to be included.
251<P>
252<DL>
253</DL>
254</DL>
255<HR>
256
257<A NAME="NON_DEFAULT"><!-- --></A><H3>
258NON_DEFAULT</H3>
259<PRE>
260public static final <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A> <B>NON_DEFAULT</B></PRE>
261<DL>
262<DD>Value that indicates that only properties that have values
263 that differ from default settings (meaning values they have
264 when Bean is constructed with its no-arguments constructor)
265 are to be included. Value is generally not useful with
266 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A>s, since they have no default values;
267 and if used, works same as <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#ALWAYS"><CODE>ALWAYS</CODE></A>.
268<P>
269<DL>
270</DL>
271</DL>
272<HR>
273
274<A NAME="NON_EMPTY"><!-- --></A><H3>
275NON_EMPTY</H3>
276<PRE>
277public static final <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A> <B>NON_EMPTY</B></PRE>
278<DL>
279<DD>Value that indicates that only properties that have values
280 that values that are null or what is considered empty are
281 not to be included.
282<p>
283 Default emptiness is defined for following type:
284<ul>
285 <li>For <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A>s and <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A>s,
286    method <code>isEmpty()</code> is called;
287   </li>
288 <li>For Java arrays, empty arrays are ones with length of 0
289   </li>
290 <li>For Java <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"><CODE>String</CODE></A>s, <code>length()</code> is called,
291   and return value of 0 indicates empty String (note that <code>String.isEmpty()</code>
292   was added in Java 1.6 and as such can not be used by Jackson
293   </li>
294 <ul>
295  and for other types, non-null values are to be included.
296<p>
297 Note that this default handling can be overridden by custom
298 <code>JsonSerializer</code> implementation: if method <code>isEmpty()</code>
299 is overridden, it will be called to see if non-null values are
300 considered empty (null is always considered empty).
301<P>
302<DL>
303</DL>
304</DL>
305
306<!-- ============ METHOD DETAIL ========== -->
307
308<A NAME="method_detail"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
311<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
312<B>Method Detail</B></FONT></TH>
313</TR>
314</TABLE>
315
316<A NAME="values()"><!-- --></A><H3>
317values</H3>
318<PRE>
319public static <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A>[] <B>values</B>()</PRE>
320<DL>
321<DD>Returns an array containing the constants of this enum type, in
322the order they are declared.  This method may be used to iterate
323over the constants as follows:
324<pre>
325for (JsonInclude.Include c : JsonInclude.Include.values())
326&nbsp;   System.out.println(c);
327</pre>
328<P>
329<DD><DL>
330
331<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
332the order they are declared</DL>
333</DD>
334</DL>
335<HR>
336
337<A NAME="valueOf(java.lang.String)"><!-- --></A><H3>
338valueOf</H3>
339<PRE>
340public static <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A> <B>valueOf</B>(<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>&nbsp;name)</PRE>
341<DL>
342<DD>Returns the enum constant of this type with the specified name.
343The string must match <I>exactly</I> an identifier used to declare an
344enum constant in this type.  (Extraneous whitespace characters are
345not permitted.)
346<P>
347<DD><DL>
348<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.
349<DT><B>Returns:</B><DD>the enum constant with the specified name
350<DT><B>Throws:</B>
351<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if this enum type has no constant
352with the specified name
353<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the argument is null</DL>
354</DD>
355</DL>
356<!-- ========= END OF CLASS DATA ========= -->
357<HR>
358
359
360<!-- ======= START OF BOTTOM NAVBAR ====== -->
361<A NAME="navbar_bottom"><!-- --></A>
362<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
363<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
364<TR><td rowspan='3'><script type="text/javascript"><!--
365google_ad_client = "pub-1467773697956887";
366/* Jackson-ad-small */
367google_ad_slot = "6699487946";
368google_ad_width = 234;
369google_ad_height = 60;
370//-->
371</script>
372<script type="text/javascript"
373src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
374</script>
375<!-- GA -->
376<script type="text/javascript">
377var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
378document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
379</script>
380<script type="text/javascript">
381try {
382var pageTracker = _gat._getTracker("UA-140287-6");
383pageTracker._trackPageview();
384} catch(err) {}
385</script>
386</td>
387<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
388<A NAME="navbar_bottom_firstrow"><!-- --></A>
389<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
390  <TR ALIGN="center" VALIGN="top">
391  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
392  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
393  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JsonInclude.Include.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
394  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
395  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
396  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
397  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
398  </TR>
399</TABLE>
400</TD>
401<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
402</EM>
403</TD>
404</TR>
405
406<TR>
407<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
408&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A>&nbsp;
409&nbsp;<A HREF="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD>
410<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
411  <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonInclude.Include.html" target="_top"><B>FRAMES</B></A>  &nbsp;
412&nbsp;<A HREF="JsonInclude.Include.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
413&nbsp;<SCRIPT type="text/javascript">
414  <!--
415  if(window==top) {
416    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
417  }
418  //-->
419</SCRIPT>
420<NOSCRIPT>
421  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
422</NOSCRIPT>
423
424
425</FONT></TD>
426</TR>
427<TR>
428<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
429  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
430<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
431DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
432</TR>
433</TABLE>
434<A NAME="skip-navbar_bottom"></A>
435<!-- ======== END OF BOTTOM NAVBAR ======= -->
436
437<HR>
438Copyright &#169; 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.
439</BODY>
440</HTML>
441