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 lang="en"> 4*2bf66424SCole Faust<head> 5*2bf66424SCole Faust<!-- Generated by javadoc (version 1.7.0_79) on Sat Jan 09 21:46:11 PST 2016 --> 6*2bf66424SCole Faust<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7*2bf66424SCole Faust<title>API Help (Jackson-annotations 2.7.0 API)</title> 8*2bf66424SCole Faust<meta name="date" content="2016-01-09"> 9*2bf66424SCole Faust<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> 10*2bf66424SCole Faust</head> 11*2bf66424SCole Faust<body> 12*2bf66424SCole Faust<script type="text/javascript"><!-- 13*2bf66424SCole Faust if (location.href.indexOf('is-external=true') == -1) { 14*2bf66424SCole Faust parent.document.title="API Help (Jackson-annotations 2.7.0 API)"; 15*2bf66424SCole Faust } 16*2bf66424SCole Faust//--> 17*2bf66424SCole Faust</script> 18*2bf66424SCole Faust<noscript> 19*2bf66424SCole Faust<div>JavaScript is disabled on your browser.</div> 20*2bf66424SCole Faust</noscript> 21*2bf66424SCole Faust<!-- ========= START OF TOP NAVBAR ======= --> 22*2bf66424SCole Faust<div class="topNav"><a name="navbar_top"> 23*2bf66424SCole Faust<!-- --> 24*2bf66424SCole Faust</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25*2bf66424SCole Faust<!-- --> 26*2bf66424SCole Faust</a> 27*2bf66424SCole Faust<ul class="navList" title="Navigation"> 28*2bf66424SCole Faust<li><a href="com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29*2bf66424SCole Faust<li>Class</li> 30*2bf66424SCole Faust<li>Use</li> 31*2bf66424SCole Faust<li><a href="com/fasterxml/jackson/annotation/package-tree.html">Tree</a></li> 32*2bf66424SCole Faust<li><a href="deprecated-list.html">Deprecated</a></li> 33*2bf66424SCole Faust<li><a href="index-all.html">Index</a></li> 34*2bf66424SCole Faust<li class="navBarCell1Rev">Help</li> 35*2bf66424SCole Faust</ul> 36*2bf66424SCole Faust</div> 37*2bf66424SCole Faust<div class="subNav"> 38*2bf66424SCole Faust<ul class="navList"> 39*2bf66424SCole Faust<li>Prev</li> 40*2bf66424SCole Faust<li>Next</li> 41*2bf66424SCole Faust</ul> 42*2bf66424SCole Faust<ul class="navList"> 43*2bf66424SCole Faust<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> 44*2bf66424SCole Faust<li><a href="help-doc.html" target="_top">No Frames</a></li> 45*2bf66424SCole Faust</ul> 46*2bf66424SCole Faust<ul class="navList" id="allclasses_navbar_top"> 47*2bf66424SCole Faust<li><a href="allclasses-noframe.html">All Classes</a></li> 48*2bf66424SCole Faust</ul> 49*2bf66424SCole Faust<div> 50*2bf66424SCole Faust<script type="text/javascript"><!-- 51*2bf66424SCole Faust allClassesLink = document.getElementById("allclasses_navbar_top"); 52*2bf66424SCole Faust if(window==top) { 53*2bf66424SCole Faust allClassesLink.style.display = "block"; 54*2bf66424SCole Faust } 55*2bf66424SCole Faust else { 56*2bf66424SCole Faust allClassesLink.style.display = "none"; 57*2bf66424SCole Faust } 58*2bf66424SCole Faust //--> 59*2bf66424SCole Faust</script> 60*2bf66424SCole Faust</div> 61*2bf66424SCole Faust<a name="skip-navbar_top"> 62*2bf66424SCole Faust<!-- --> 63*2bf66424SCole Faust</a></div> 64*2bf66424SCole Faust<!-- ========= END OF TOP NAVBAR ========= --> 65*2bf66424SCole Faust<div class="header"> 66*2bf66424SCole Faust<h1 class="title">How This API Document Is Organized</h1> 67*2bf66424SCole Faust<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div> 68*2bf66424SCole Faust</div> 69*2bf66424SCole Faust<div class="contentContainer"> 70*2bf66424SCole Faust<ul class="blockList"> 71*2bf66424SCole Faust<li class="blockList"> 72*2bf66424SCole Faust<h2>Package</h2> 73*2bf66424SCole Faust<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p> 74*2bf66424SCole Faust<ul> 75*2bf66424SCole Faust<li>Interfaces (italic)</li> 76*2bf66424SCole Faust<li>Classes</li> 77*2bf66424SCole Faust<li>Enums</li> 78*2bf66424SCole Faust<li>Exceptions</li> 79*2bf66424SCole Faust<li>Errors</li> 80*2bf66424SCole Faust<li>Annotation Types</li> 81*2bf66424SCole Faust</ul> 82*2bf66424SCole Faust</li> 83*2bf66424SCole Faust<li class="blockList"> 84*2bf66424SCole Faust<h2>Class/Interface</h2> 85*2bf66424SCole Faust<p>Each 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:</p> 86*2bf66424SCole Faust<ul> 87*2bf66424SCole Faust<li>Class inheritance diagram</li> 88*2bf66424SCole Faust<li>Direct Subclasses</li> 89*2bf66424SCole Faust<li>All Known Subinterfaces</li> 90*2bf66424SCole Faust<li>All Known Implementing Classes</li> 91*2bf66424SCole Faust<li>Class/interface declaration</li> 92*2bf66424SCole Faust<li>Class/interface description</li> 93*2bf66424SCole Faust</ul> 94*2bf66424SCole Faust<ul> 95*2bf66424SCole Faust<li>Nested Class Summary</li> 96*2bf66424SCole Faust<li>Field Summary</li> 97*2bf66424SCole Faust<li>Constructor Summary</li> 98*2bf66424SCole Faust<li>Method Summary</li> 99*2bf66424SCole Faust</ul> 100*2bf66424SCole Faust<ul> 101*2bf66424SCole Faust<li>Field Detail</li> 102*2bf66424SCole Faust<li>Constructor Detail</li> 103*2bf66424SCole Faust<li>Method Detail</li> 104*2bf66424SCole Faust</ul> 105*2bf66424SCole Faust<p>Each 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.</p> 106*2bf66424SCole Faust</li> 107*2bf66424SCole Faust<li class="blockList"> 108*2bf66424SCole Faust<h2>Annotation Type</h2> 109*2bf66424SCole Faust<p>Each annotation type has its own separate page with the following sections:</p> 110*2bf66424SCole Faust<ul> 111*2bf66424SCole Faust<li>Annotation Type declaration</li> 112*2bf66424SCole Faust<li>Annotation Type description</li> 113*2bf66424SCole Faust<li>Required Element Summary</li> 114*2bf66424SCole Faust<li>Optional Element Summary</li> 115*2bf66424SCole Faust<li>Element Detail</li> 116*2bf66424SCole Faust</ul> 117*2bf66424SCole Faust</li> 118*2bf66424SCole Faust<li class="blockList"> 119*2bf66424SCole Faust<h2>Enum</h2> 120*2bf66424SCole Faust<p>Each enum has its own separate page with the following sections:</p> 121*2bf66424SCole Faust<ul> 122*2bf66424SCole Faust<li>Enum declaration</li> 123*2bf66424SCole Faust<li>Enum description</li> 124*2bf66424SCole Faust<li>Enum Constant Summary</li> 125*2bf66424SCole Faust<li>Enum Constant Detail</li> 126*2bf66424SCole Faust</ul> 127*2bf66424SCole Faust</li> 128*2bf66424SCole Faust<li class="blockList"> 129*2bf66424SCole Faust<h2>Use</h2> 130*2bf66424SCole Faust<p>Each 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.</p> 131*2bf66424SCole Faust</li> 132*2bf66424SCole Faust<li class="blockList"> 133*2bf66424SCole Faust<h2>Tree (Class Hierarchy)</h2> 134*2bf66424SCole Faust<p>There 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>.</p> 135*2bf66424SCole Faust<ul> 136*2bf66424SCole Faust<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li> 137*2bf66424SCole Faust<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li> 138*2bf66424SCole Faust</ul> 139*2bf66424SCole Faust</li> 140*2bf66424SCole Faust<li class="blockList"> 141*2bf66424SCole Faust<h2>Deprecated API</h2> 142*2bf66424SCole Faust<p>The <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.</p> 143*2bf66424SCole Faust</li> 144*2bf66424SCole Faust<li class="blockList"> 145*2bf66424SCole Faust<h2>Index</h2> 146*2bf66424SCole Faust<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p> 147*2bf66424SCole Faust</li> 148*2bf66424SCole Faust<li class="blockList"> 149*2bf66424SCole Faust<h2>Prev/Next</h2> 150*2bf66424SCole Faust<p>These links take you to the next or previous class, interface, package, or related page.</p> 151*2bf66424SCole Faust</li> 152*2bf66424SCole Faust<li class="blockList"> 153*2bf66424SCole Faust<h2>Frames/No Frames</h2> 154*2bf66424SCole Faust<p>These links show and hide the HTML frames. All pages are available with or without frames.</p> 155*2bf66424SCole Faust</li> 156*2bf66424SCole Faust<li class="blockList"> 157*2bf66424SCole Faust<h2>All Classes</h2> 158*2bf66424SCole Faust<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p> 159*2bf66424SCole Faust</li> 160*2bf66424SCole Faust<li class="blockList"> 161*2bf66424SCole Faust<h2>Serialized Form</h2> 162*2bf66424SCole Faust<p>Each 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.</p> 163*2bf66424SCole Faust</li> 164*2bf66424SCole Faust<li class="blockList"> 165*2bf66424SCole Faust<h2>Constant Field Values</h2> 166*2bf66424SCole Faust<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p> 167*2bf66424SCole Faust</li> 168*2bf66424SCole Faust</ul> 169*2bf66424SCole Faust<em>This help file applies to API documentation generated using the standard doclet.</em></div> 170*2bf66424SCole Faust<!-- ======= START OF BOTTOM NAVBAR ====== --> 171*2bf66424SCole Faust<div class="bottomNav"><a name="navbar_bottom"> 172*2bf66424SCole Faust<!-- --> 173*2bf66424SCole Faust</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 174*2bf66424SCole Faust<!-- --> 175*2bf66424SCole Faust</a> 176*2bf66424SCole Faust<ul class="navList" title="Navigation"> 177*2bf66424SCole Faust<li><a href="com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 178*2bf66424SCole Faust<li>Class</li> 179*2bf66424SCole Faust<li>Use</li> 180*2bf66424SCole Faust<li><a href="com/fasterxml/jackson/annotation/package-tree.html">Tree</a></li> 181*2bf66424SCole Faust<li><a href="deprecated-list.html">Deprecated</a></li> 182*2bf66424SCole Faust<li><a href="index-all.html">Index</a></li> 183*2bf66424SCole Faust<li class="navBarCell1Rev">Help</li> 184*2bf66424SCole Faust</ul> 185*2bf66424SCole Faust</div> 186*2bf66424SCole Faust<div class="subNav"> 187*2bf66424SCole Faust<ul class="navList"> 188*2bf66424SCole Faust<li>Prev</li> 189*2bf66424SCole Faust<li>Next</li> 190*2bf66424SCole Faust</ul> 191*2bf66424SCole Faust<ul class="navList"> 192*2bf66424SCole Faust<li><a href="index.html?help-doc.html" target="_top">Frames</a></li> 193*2bf66424SCole Faust<li><a href="help-doc.html" target="_top">No Frames</a></li> 194*2bf66424SCole Faust</ul> 195*2bf66424SCole Faust<ul class="navList" id="allclasses_navbar_bottom"> 196*2bf66424SCole Faust<li><a href="allclasses-noframe.html">All Classes</a></li> 197*2bf66424SCole Faust</ul> 198*2bf66424SCole Faust<div> 199*2bf66424SCole Faust<script type="text/javascript"><!-- 200*2bf66424SCole Faust allClassesLink = document.getElementById("allclasses_navbar_bottom"); 201*2bf66424SCole Faust if(window==top) { 202*2bf66424SCole Faust allClassesLink.style.display = "block"; 203*2bf66424SCole Faust } 204*2bf66424SCole Faust else { 205*2bf66424SCole Faust allClassesLink.style.display = "none"; 206*2bf66424SCole Faust } 207*2bf66424SCole Faust //--> 208*2bf66424SCole Faust</script> 209*2bf66424SCole Faust</div> 210*2bf66424SCole Faust<a name="skip-navbar_bottom"> 211*2bf66424SCole Faust<!-- --> 212*2bf66424SCole Faust</a></div> 213*2bf66424SCole Faust<!-- ======== END OF BOTTOM NAVBAR ======= --> 214*2bf66424SCole Faust<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 215*2bf66424SCole Faust</body> 216*2bf66424SCole Faust</html> 217