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 19:07:21 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8API Help (jackson-databind 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="API Help (jackson-databind 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="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 PREV 60 NEXT</FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78</TABLE> 79<A NAME="skip-navbar_top"></A> 80<!-- ========= END OF TOP NAVBAR ========= --> 81 82<HR> 83<CENTER> 84<H1> 85How This API Document Is Organized</H1> 86</CENTER> 87This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3> 88Overview</H3> 89<BLOCKQUOTE> 90 91<P> 92The <A HREF="overview-summary.html">Overview</A> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</BLOCKQUOTE> 93<H3> 94Package</H3> 95<BLOCKQUOTE> 96 97<P> 98Each 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> 99<LI>Interfaces (italic)<LI>Classes<LI>Enums<LI>Exceptions<LI>Errors<LI>Annotation Types</UL> 100</BLOCKQUOTE> 101<H3> 102Class/Interface</H3> 103<BLOCKQUOTE> 104 105<P> 106Each 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> 107<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description 108<P> 109<LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary 110<P> 111<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL> 112Each 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> 113</BLOCKQUOTE> 114<H3> 115Annotation Type</H3> 116<BLOCKQUOTE> 117 118<P> 119Each annotation type has its own separate page with the following sections:<UL> 120<LI>Annotation Type declaration<LI>Annotation Type description<LI>Required Element Summary<LI>Optional Element Summary<LI>Element Detail</UL> 121</BLOCKQUOTE> 122</BLOCKQUOTE> 123<H3> 124Enum</H3> 125<BLOCKQUOTE> 126 127<P> 128Each enum has its own separate page with the following sections:<UL> 129<LI>Enum declaration<LI>Enum description<LI>Enum Constant Summary<LI>Enum Constant Detail</UL> 130</BLOCKQUOTE> 131<H3> 132Use</H3> 133<BLOCKQUOTE> 134Each 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> 135<H3> 136Tree (Class Hierarchy)</H3> 137<BLOCKQUOTE> 138There 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> 139<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> 140</BLOCKQUOTE> 141<H3> 142Deprecated API</H3> 143<BLOCKQUOTE> 144The <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> 145<H3> 146Index</H3> 147<BLOCKQUOTE> 148The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE> 149<H3> 150Prev/Next</H3> 151These links take you to the next or previous class, interface, package, or related page.<H3> 152Frames/No Frames</H3> 153These links show and hide the HTML frames. All pages are available with or without frames. 154<P> 155<H3> 156Serialized Form</H3> 157Each 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. 158<P> 159<H3> 160Constant Field Values</H3> 161The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values. 162<P> 163<FONT SIZE="-1"> 164<EM> 165This help file applies to API documentation generated using the standard doclet.</EM> 166</FONT> 167<BR> 168<HR> 169 170 171<!-- ======= START OF BOTTOM NAVBAR ====== --> 172<A NAME="navbar_bottom"><!-- --></A> 173<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 174<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 175<TR> 176<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 177<A NAME="navbar_bottom_firstrow"><!-- --></A> 178<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 179 <TR ALIGN="center" VALIGN="top"> 180 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 181 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD> 182 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 183 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT> </TD> 184 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 185 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 186 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 187 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT> </TD> 188 </TR> 189</TABLE> 190</TD> 191<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 192</EM> 193</TD> 194</TR> 195 196<TR> 197<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 198 PREV 199 NEXT</FONT></TD> 200<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 201 <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A> 202 <A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> 203 <SCRIPT type="text/javascript"> 204 <!-- 205 if(window==top) { 206 document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>'); 207 } 208 //--> 209</SCRIPT> 210<NOSCRIPT> 211 <A HREF="allclasses-noframe.html"><B>All Classes</B></A> 212</NOSCRIPT> 213 214 215</FONT></TD> 216</TR> 217</TABLE> 218<A NAME="skip-navbar_bottom"></A> 219<!-- ======== END OF BOTTOM NAVBAR ======= --> 220 221<HR> 222Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 223</BODY> 224</HTML> 225