1*2bf66424SCole Faust<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2*2bf66424SCole Faust<!--NewPage--> 3*2bf66424SCole Faust<HTML> 4*2bf66424SCole Faust<HEAD> 5*2bf66424SCole Faust<!-- Generated by javadoc (build 1.6.0_35) on Fri Oct 05 20:53:30 PDT 2012 --> 6*2bf66424SCole Faust<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7*2bf66424SCole Faust<TITLE> 8*2bf66424SCole FaustAPI Help (Jackson-annotations 2.1.0 API) 9*2bf66424SCole Faust</TITLE> 10*2bf66424SCole Faust 11*2bf66424SCole Faust<META NAME="date" CONTENT="2012-10-05"> 12*2bf66424SCole Faust 13*2bf66424SCole Faust<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style"> 14*2bf66424SCole Faust 15*2bf66424SCole Faust<SCRIPT type="text/javascript"> 16*2bf66424SCole Faustfunction windowTitle() 17*2bf66424SCole Faust{ 18*2bf66424SCole Faust if (location.href.indexOf('is-external=true') == -1) { 19*2bf66424SCole Faust parent.document.title="API Help (Jackson-annotations 2.1.0 API)"; 20*2bf66424SCole Faust } 21*2bf66424SCole Faust} 22*2bf66424SCole Faust</SCRIPT> 23*2bf66424SCole Faust<NOSCRIPT> 24*2bf66424SCole Faust</NOSCRIPT> 25*2bf66424SCole Faust 26*2bf66424SCole Faust</HEAD> 27*2bf66424SCole Faust 28*2bf66424SCole Faust<BODY BGCOLOR="white" onload="windowTitle();"> 29*2bf66424SCole Faust<HR> 30*2bf66424SCole Faust 31*2bf66424SCole Faust 32*2bf66424SCole Faust<!-- ========= START OF TOP NAVBAR ======= --> 33*2bf66424SCole Faust<A NAME="navbar_top"><!-- --></A> 34*2bf66424SCole Faust<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35*2bf66424SCole Faust<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36*2bf66424SCole Faust<TR> 37*2bf66424SCole Faust<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38*2bf66424SCole Faust<A NAME="navbar_top_firstrow"><!-- --></A> 39*2bf66424SCole Faust<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40*2bf66424SCole Faust <TR ALIGN="center" VALIGN="top"> 41*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 43*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT> </TD> 44*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="com/fasterxml/jackson/annotation/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47*2bf66424SCole Faust <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </TD> 48*2bf66424SCole Faust </TR> 49*2bf66424SCole Faust</TABLE> 50*2bf66424SCole Faust</TD> 51*2bf66424SCole Faust<TD ALIGN="right" VALIGN="top" ROWSPAN=3><script type="text/javascript"><!-- 52*2bf66424SCole Faustgoogle_ad_client = "pub-1467773697956887"; 53*2bf66424SCole Faust/* Jackson-ad-small */ 54*2bf66424SCole Faustgoogle_ad_slot = "6699487946"; 55*2bf66424SCole Faustgoogle_ad_width = 234; 56*2bf66424SCole Faustgoogle_ad_height = 60; 57*2bf66424SCole Faust//--> 58*2bf66424SCole Faust</script> 59*2bf66424SCole Faust<script type="text/javascript" 60*2bf66424SCole Faustsrc="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 61*2bf66424SCole Faust</script> 62*2bf66424SCole Faust</TD> 63*2bf66424SCole Faust</TR> 64*2bf66424SCole Faust 65*2bf66424SCole Faust<TR> 66*2bf66424SCole Faust<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 67*2bf66424SCole Faust PREV 68*2bf66424SCole Faust NEXT</FONT></TD> 69*2bf66424SCole Faust<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70*2bf66424SCole Faust <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A> 71*2bf66424SCole Faust <A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> 72*2bf66424SCole Faust <SCRIPT type="text/javascript"> 73*2bf66424SCole Faust <!-- 74*2bf66424SCole Faust if(window==top) { 75*2bf66424SCole Faust document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>'); 76*2bf66424SCole Faust } 77*2bf66424SCole Faust //--> 78*2bf66424SCole Faust</SCRIPT> 79*2bf66424SCole Faust<NOSCRIPT> 80*2bf66424SCole Faust <A HREF="allclasses-noframe.html"><B>All Classes</B></A> 81*2bf66424SCole Faust</NOSCRIPT> 82*2bf66424SCole Faust 83*2bf66424SCole Faust 84*2bf66424SCole Faust</FONT></TD> 85*2bf66424SCole Faust</TR> 86*2bf66424SCole Faust</TABLE> 87*2bf66424SCole Faust<A NAME="skip-navbar_top"></A> 88*2bf66424SCole Faust<!-- ========= END OF TOP NAVBAR ========= --> 89*2bf66424SCole Faust 90*2bf66424SCole Faust<HR> 91*2bf66424SCole Faust<CENTER> 92*2bf66424SCole Faust<H1> 93*2bf66424SCole FaustHow This API Document Is Organized</H1> 94*2bf66424SCole Faust</CENTER> 95*2bf66424SCole FaustThis API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3> 96*2bf66424SCole FaustPackage</H3> 97*2bf66424SCole Faust<BLOCKQUOTE> 98*2bf66424SCole Faust 99*2bf66424SCole Faust<P> 100*2bf66424SCole FaustEach package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL> 101*2bf66424SCole Faust<LI>Interfaces (italic)<LI>Classes<LI>Enums<LI>Exceptions<LI>Errors<LI>Annotation Types</UL> 102*2bf66424SCole Faust</BLOCKQUOTE> 103*2bf66424SCole Faust<H3> 104*2bf66424SCole FaustClass/Interface</H3> 105*2bf66424SCole Faust<BLOCKQUOTE> 106*2bf66424SCole Faust 107*2bf66424SCole Faust<P> 108*2bf66424SCole FaustEach class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:<UL> 109*2bf66424SCole Faust<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description 110*2bf66424SCole Faust<P> 111*2bf66424SCole Faust<LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary 112*2bf66424SCole Faust<P> 113*2bf66424SCole Faust<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL> 114*2bf66424SCole FaustEach summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</BLOCKQUOTE> 115*2bf66424SCole Faust</BLOCKQUOTE> 116*2bf66424SCole Faust<H3> 117*2bf66424SCole FaustAnnotation Type</H3> 118*2bf66424SCole Faust<BLOCKQUOTE> 119*2bf66424SCole Faust 120*2bf66424SCole Faust<P> 121*2bf66424SCole FaustEach annotation type has its own separate page with the following sections:<UL> 122*2bf66424SCole Faust<LI>Annotation Type declaration<LI>Annotation Type description<LI>Required Element Summary<LI>Optional Element Summary<LI>Element Detail</UL> 123*2bf66424SCole Faust</BLOCKQUOTE> 124*2bf66424SCole Faust</BLOCKQUOTE> 125*2bf66424SCole Faust<H3> 126*2bf66424SCole FaustEnum</H3> 127*2bf66424SCole Faust<BLOCKQUOTE> 128*2bf66424SCole Faust 129*2bf66424SCole Faust<P> 130*2bf66424SCole FaustEach enum has its own separate page with the following sections:<UL> 131*2bf66424SCole Faust<LI>Enum declaration<LI>Enum description<LI>Enum Constant Summary<LI>Enum Constant Detail</UL> 132*2bf66424SCole Faust</BLOCKQUOTE> 133*2bf66424SCole Faust<H3> 134*2bf66424SCole FaustUse</H3> 135*2bf66424SCole Faust<BLOCKQUOTE> 136*2bf66424SCole FaustEach documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</BLOCKQUOTE> 137*2bf66424SCole Faust<H3> 138*2bf66424SCole FaustTree (Class Hierarchy)</H3> 139*2bf66424SCole Faust<BLOCKQUOTE> 140*2bf66424SCole FaustThere is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.<UL> 141*2bf66424SCole Faust<LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL> 142*2bf66424SCole Faust</BLOCKQUOTE> 143*2bf66424SCole Faust<H3> 144*2bf66424SCole FaustDeprecated API</H3> 145*2bf66424SCole Faust<BLOCKQUOTE> 146*2bf66424SCole FaustThe <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE> 147*2bf66424SCole Faust<H3> 148*2bf66424SCole FaustIndex</H3> 149*2bf66424SCole Faust<BLOCKQUOTE> 150*2bf66424SCole FaustThe <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE> 151*2bf66424SCole Faust<H3> 152*2bf66424SCole FaustPrev/Next</H3> 153*2bf66424SCole FaustThese links take you to the next or previous class, interface, package, or related page.<H3> 154*2bf66424SCole FaustFrames/No Frames</H3> 155*2bf66424SCole FaustThese links show and hide the HTML frames. All pages are available with or without frames. 156*2bf66424SCole Faust<P> 157*2bf66424SCole Faust<H3> 158*2bf66424SCole FaustSerialized Form</H3> 159*2bf66424SCole FaustEach serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. 160*2bf66424SCole Faust<P> 161*2bf66424SCole Faust<H3> 162*2bf66424SCole FaustConstant Field Values</H3> 163*2bf66424SCole FaustThe <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values. 164*2bf66424SCole Faust<P> 165*2bf66424SCole Faust<FONT SIZE="-1"> 166*2bf66424SCole Faust<EM> 167*2bf66424SCole FaustThis help file applies to API documentation generated using the standard doclet.</EM> 168*2bf66424SCole Faust</FONT> 169*2bf66424SCole Faust<BR> 170*2bf66424SCole Faust<HR> 171*2bf66424SCole Faust 172*2bf66424SCole Faust 173*2bf66424SCole Faust<!-- ======= START OF BOTTOM NAVBAR ====== --> 174*2bf66424SCole Faust<A NAME="navbar_bottom"><!-- --></A> 175*2bf66424SCole Faust<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 176*2bf66424SCole Faust<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 177*2bf66424SCole Faust<TR><td rowspan='3'><script type="text/javascript"><!-- 178*2bf66424SCole Faustgoogle_ad_client = "pub-1467773697956887"; 179*2bf66424SCole Faust/* Jackson-ad-small */ 180*2bf66424SCole Faustgoogle_ad_slot = "6699487946"; 181*2bf66424SCole Faustgoogle_ad_width = 234; 182*2bf66424SCole Faustgoogle_ad_height = 60; 183*2bf66424SCole Faust//--> 184*2bf66424SCole Faust</script> 185*2bf66424SCole Faust<script type="text/javascript" 186*2bf66424SCole Faustsrc="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 187*2bf66424SCole Faust</script> 188*2bf66424SCole Faust<!-- GA --> 189*2bf66424SCole Faust<script type="text/javascript"> 190*2bf66424SCole Faustvar gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 191*2bf66424SCole Faustdocument.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 192*2bf66424SCole Faust</script> 193*2bf66424SCole Faust<script type="text/javascript"> 194*2bf66424SCole Fausttry { 195*2bf66424SCole Faustvar pageTracker = _gat._getTracker("UA-140287-6"); 196*2bf66424SCole FaustpageTracker._trackPageview(); 197*2bf66424SCole Faust} catch(err) {} 198*2bf66424SCole Faust</script> 199*2bf66424SCole Faust</td> 200*2bf66424SCole Faust<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 201*2bf66424SCole Faust<A NAME="navbar_bottom_firstrow"><!-- --></A> 202*2bf66424SCole Faust<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 203*2bf66424SCole Faust <TR ALIGN="center" VALIGN="top"> 204*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 205*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 206*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT> </TD> 207*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="com/fasterxml/jackson/annotation/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 208*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 209*2bf66424SCole Faust <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 210*2bf66424SCole Faust <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </TD> 211*2bf66424SCole Faust </TR> 212*2bf66424SCole Faust</TABLE> 213*2bf66424SCole Faust</TD> 214*2bf66424SCole Faust<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 215*2bf66424SCole Faust</EM> 216*2bf66424SCole Faust</TD> 217*2bf66424SCole Faust</TR> 218*2bf66424SCole Faust 219*2bf66424SCole Faust<TR> 220*2bf66424SCole Faust<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 221*2bf66424SCole Faust PREV 222*2bf66424SCole Faust NEXT</FONT></TD> 223*2bf66424SCole Faust<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 224*2bf66424SCole Faust <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A> 225*2bf66424SCole Faust <A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> 226*2bf66424SCole Faust <SCRIPT type="text/javascript"> 227*2bf66424SCole Faust <!-- 228*2bf66424SCole Faust if(window==top) { 229*2bf66424SCole Faust document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>'); 230*2bf66424SCole Faust } 231*2bf66424SCole Faust //--> 232*2bf66424SCole Faust</SCRIPT> 233*2bf66424SCole Faust<NOSCRIPT> 234*2bf66424SCole Faust <A HREF="allclasses-noframe.html"><B>All Classes</B></A> 235*2bf66424SCole Faust</NOSCRIPT> 236*2bf66424SCole Faust 237*2bf66424SCole Faust 238*2bf66424SCole Faust</FONT></TD> 239*2bf66424SCole Faust</TR> 240*2bf66424SCole Faust</TABLE> 241*2bf66424SCole Faust<A NAME="skip-navbar_bottom"></A> 242*2bf66424SCole Faust<!-- ======== END OF BOTTOM NAVBAR ======= --> 243*2bf66424SCole Faust 244*2bf66424SCole Faust<HR> 245*2bf66424SCole FaustCopyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 246*2bf66424SCole Faust</BODY> 247*2bf66424SCole Faust</HTML> 248