1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (version 1.7.0_10-ea) on Sun Jul 14 20:03:19 PDT 2013 --> 6<title>FormatSchema (Jackson JSON Processor)</title> 7<meta name="date" content="2013-07-14"> 8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> 9</head> 10<body> 11<script type="text/javascript"><!-- 12 if (location.href.indexOf('is-external=true') == -1) { 13 parent.document.title="FormatSchema (Jackson JSON Processor)"; 14 } 15//--> 16</script> 17<noscript> 18<div>JavaScript is disabled on your browser.</div> 19</noscript> 20<!-- ========= START OF TOP NAVBAR ======= --> 21<div class="topNav"><a name="navbar_top"> 22<!-- --> 23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 24<!-- --> 25</a> 26<ul class="navList" title="Navigation"> 27<li><a href="../../../overview-summary.html">Overview</a></li> 28<li><a href="package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/FormatSchema.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../index-all.html">Index</a></li> 34<li><a href="../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li><a href="../../../org/codehaus/jackson/Base64Variants.html" title="class in org.codehaus.jackson"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../index.html?org/codehaus/jackson/FormatSchema.html" target="_top">Frames</a></li> 44<li><a href="FormatSchema.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Nested | </li> 65<li>Field | </li> 66<li>Constr | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li>Field | </li> 72<li>Constr | </li> 73<li><a href="#method_detail">Method</a></li> 74</ul> 75</div> 76<a name="skip-navbar_top"> 77<!-- --> 78</a></div> 79<!-- ========= END OF TOP NAVBAR ========= --> 80<!-- ======== START OF CLASS DATA ======== --> 81<div class="header"> 82<div class="subTitle">org.codehaus.jackson</div> 83<h2 title="Interface FormatSchema" class="title">Interface FormatSchema</h2> 84</div> 85<div class="contentContainer"> 86<div class="description"> 87<ul class="blockList"> 88<li class="blockList"> 89<hr> 90<br> 91<pre>public interface <span class="strong">FormatSchema</span></pre> 92<div class="block">Simple tag interface used to mark schema objects that are used by some 93 <a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a> and <a href="../../../org/codehaus/jackson/JsonGenerator.html" title="class in org.codehaus.jackson"><code>JsonGenerator</code></a> implementations to further 94 specify structure of expected format. 95 Basic JSON-based parsers and generators do not use schemas, but some data 96 formats (like many binary data formats like Thrift, protobuf) mandate 97 use of schemas. 98<p> 99 Since there is little commonality between schemas for different data formats, 100 this interface does not define much meaningful functionality for accessing 101 schema details; rather, specific parser and generator implementations need 102 to cast to schema implementations they use. This marker interface is mostly 103 used for tagging "some kind of schema" -- instead of passing opaque 104 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><code>Object</code></a> -- for documentation purposes.</div> 105<dl><dt><span class="strong">Since:</span></dt> 106 <dd>1.8</dd></dl> 107</li> 108</ul> 109</div> 110<div class="summary"> 111<ul class="blockList"> 112<li class="blockList"> 113<!-- ========== METHOD SUMMARY =========== --> 114<ul class="blockList"> 115<li class="blockList"><a name="method_summary"> 116<!-- --> 117</a> 118<h3>Method Summary</h3> 119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 120<caption><span>Methods</span><span class="tabEnd"> </span></caption> 121<tr> 122<th class="colFirst" scope="col">Modifier and Type</th> 123<th class="colLast" scope="col">Method and Description</th> 124</tr> 125<tr class="altColor"> 126<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 127<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/FormatSchema.html#getSchemaType()">getSchemaType</a></strong>()</code> 128<div class="block">Method that can be used to get an identifier that can be used for diagnostics 129 purposes, to indicate what kind of data format this schema is used for: typically 130 it is a short name of format itself, but it can also contain additional information 131 in cases where data format supports multiple types of schemas.</div> 132</td> 133</tr> 134</table> 135</li> 136</ul> 137</li> 138</ul> 139</div> 140<div class="details"> 141<ul class="blockList"> 142<li class="blockList"> 143<!-- ============ METHOD DETAIL ========== --> 144<ul class="blockList"> 145<li class="blockList"><a name="method_detail"> 146<!-- --> 147</a> 148<h3>Method Detail</h3> 149<a name="getSchemaType()"> 150<!-- --> 151</a> 152<ul class="blockListLast"> 153<li class="blockList"> 154<h4>getSchemaType</h4> 155<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSchemaType()</pre> 156<div class="block">Method that can be used to get an identifier that can be used for diagnostics 157 purposes, to indicate what kind of data format this schema is used for: typically 158 it is a short name of format itself, but it can also contain additional information 159 in cases where data format supports multiple types of schemas.</div> 160</li> 161</ul> 162</li> 163</ul> 164</li> 165</ul> 166</div> 167</div> 168<!-- ========= END OF CLASS DATA ========= --> 169<!-- ======= START OF BOTTOM NAVBAR ====== --> 170<div class="bottomNav"><a name="navbar_bottom"> 171<!-- --> 172</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 173<!-- --> 174</a> 175<ul class="navList" title="Navigation"> 176<li><a href="../../../overview-summary.html">Overview</a></li> 177<li><a href="package-summary.html">Package</a></li> 178<li class="navBarCell1Rev">Class</li> 179<li><a href="class-use/FormatSchema.html">Use</a></li> 180<li><a href="package-tree.html">Tree</a></li> 181<li><a href="../../../deprecated-list.html">Deprecated</a></li> 182<li><a href="../../../index-all.html">Index</a></li> 183<li><a href="../../../help-doc.html">Help</a></li> 184</ul> 185</div> 186<div class="subNav"> 187<ul class="navList"> 188<li><a href="../../../org/codehaus/jackson/Base64Variants.html" title="class in org.codehaus.jackson"><span class="strong">Prev Class</span></a></li> 189<li><a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson"><span class="strong">Next Class</span></a></li> 190</ul> 191<ul class="navList"> 192<li><a href="../../../index.html?org/codehaus/jackson/FormatSchema.html" target="_top">Frames</a></li> 193<li><a href="FormatSchema.html" target="_top">No Frames</a></li> 194</ul> 195<ul class="navList" id="allclasses_navbar_bottom"> 196<li><a href="../../../allclasses-noframe.html">All Classes</a></li> 197</ul> 198<div> 199<script type="text/javascript"><!-- 200 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 201 if(window==top) { 202 allClassesLink.style.display = "block"; 203 } 204 else { 205 allClassesLink.style.display = "none"; 206 } 207 //--> 208</script> 209</div> 210<div> 211<ul class="subNavList"> 212<li>Summary: </li> 213<li>Nested | </li> 214<li>Field | </li> 215<li>Constr | </li> 216<li><a href="#method_summary">Method</a></li> 217</ul> 218<ul class="subNavList"> 219<li>Detail: </li> 220<li>Field | </li> 221<li>Constr | </li> 222<li><a href="#method_detail">Method</a></li> 223</ul> 224</div> 225<a name="skip-navbar_bottom"> 226<!-- --> 227</a></div> 228<!-- ======== END OF BOTTOM NAVBAR ======= --> 229</body> 230</html> 231