• 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 lang="en">
4<head>
5<!-- Generated by javadoc (version 1.7.0_10-ea) on Sun Jul 14 20:03:33 PDT 2013 -->
6<title>org.codehaus.jackson (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="org.codehaus.jackson (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 class="navBarCell1Rev">Package</li>
29<li>Class</li>
30<li><a href="package-use.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>Prev Package</li>
40<li><a href="../../../org/codehaus/jackson/annotate/package-summary.html">Next Package</a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../index.html?org/codehaus/jackson/package-summary.html" target="_top">Frames</a></li>
44<li><a href="package-summary.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<a name="skip-navbar_top">
62<!--   -->
63</a></div>
64<!-- ========= END OF TOP NAVBAR ========= -->
65<div class="header">
66<h1 title="Package" class="title">Package&nbsp;org.codehaus.jackson</h1>
67<div class="docSummary">
68<div class="block">Main public API classes of the core streaming JSON
69 processor: most importantly <a href="../../../org/codehaus/jackson/JsonFactory.html" title="class in org.codehaus.jackson"><code>JsonFactory</code></a>
70 used for constructing
71 JSON parser (<a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a>)
72 and generator
73 (<a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a>)
74 instances.</div>
75</div>
76<p>See:&nbsp;<a href="#package_description">Description</a></p>
77</div>
78<div class="contentContainer">
79<ul class="blockList">
80<li class="blockList">
81<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
82<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
83<tr>
84<th class="colFirst" scope="col">Interface</th>
85<th class="colLast" scope="col">Description</th>
86</tr>
87<tbody>
88<tr class="altColor">
89<td class="colFirst"><a href="../../../org/codehaus/jackson/FormatSchema.html" title="interface in org.codehaus.jackson">FormatSchema</a></td>
90<td class="colLast">
91<div class="block">Simple tag interface used to mark schema objects that are used by some
92 <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
93 specify structure of expected format.</div>
94</td>
95</tr>
96<tr class="rowColor">
97<td class="colFirst"><a href="../../../org/codehaus/jackson/PrettyPrinter.html" title="interface in org.codehaus.jackson">PrettyPrinter</a></td>
98<td class="colLast">
99<div class="block">Interface for objects that implement pretty printer functionality, such
100 as indentation.</div>
101</td>
102</tr>
103<tr class="altColor">
104<td class="colFirst"><a href="../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></td>
105<td class="colLast">
106<div class="block">Interface that defines how Jackson package can interact with efficient
107 pre-serialized or lazily-serialized and reused String representations.</div>
108</td>
109</tr>
110<tr class="rowColor">
111<td class="colFirst"><a href="../../../org/codehaus/jackson/Versioned.html" title="interface in org.codehaus.jackson">Versioned</a></td>
112<td class="colLast">
113<div class="block">Interface that those Jackson components that are explicitly versioned will implement.</div>
114</td>
115</tr>
116</tbody>
117</table>
118</li>
119<li class="blockList">
120<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
121<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
122<tr>
123<th class="colFirst" scope="col">Class</th>
124<th class="colLast" scope="col">Description</th>
125</tr>
126<tbody>
127<tr class="altColor">
128<td class="colFirst"><a href="../../../org/codehaus/jackson/Base64Variant.html" title="class in org.codehaus.jackson">Base64Variant</a></td>
129<td class="colLast">
130<div class="block">Abstract base class used to define specific details of which
131 variant of Base64 encoding/decoding is to be used.</div>
132</td>
133</tr>
134<tr class="rowColor">
135<td class="colFirst"><a href="../../../org/codehaus/jackson/Base64Variants.html" title="class in org.codehaus.jackson">Base64Variants</a></td>
136<td class="colLast">
137<div class="block">Container for commonly used Base64 variants.</div>
138</td>
139</tr>
140<tr class="altColor">
141<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonFactory.html" title="class in org.codehaus.jackson">JsonFactory</a></td>
142<td class="colLast">
143<div class="block">The main factory class of Jackson package, used to configure and
144 construct reader (aka parser, <a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a>)
145 and writer (aka generator, <a href="../../../org/codehaus/jackson/JsonGenerator.html" title="class in org.codehaus.jackson"><code>JsonGenerator</code></a>)
146 instances.</div>
147</td>
148</tr>
149<tr class="rowColor">
150<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonGenerator.html" title="class in org.codehaus.jackson">JsonGenerator</a></td>
151<td class="colLast">
152<div class="block">Base class that defines public API for writing JSON content.</div>
153</td>
154</tr>
155<tr class="altColor">
156<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonLocation.html" title="class in org.codehaus.jackson">JsonLocation</a></td>
157<td class="colLast">
158<div class="block">Object that encapsulates Location information used for reporting
159 parsing (or potentially generation) errors, as well as current location
160 within input streams.</div>
161</td>
162</tr>
163<tr class="rowColor">
164<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonNode.html" title="class in org.codehaus.jackson">JsonNode</a></td>
165<td class="colLast">
166<div class="block">Base class for all JSON nodes, which form the basis of JSON
167 Tree Model that Jackson implements.</div>
168</td>
169</tr>
170<tr class="altColor">
171<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson">JsonParser</a></td>
172<td class="colLast">
173<div class="block">Base class that defines public API for reading JSON content.</div>
174</td>
175</tr>
176<tr class="rowColor">
177<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonStreamContext.html" title="class in org.codehaus.jackson">JsonStreamContext</a></td>
178<td class="colLast">
179<div class="block">Shared base class for streaming processing contexts used during
180 reading and writing of Json content using Streaming API.</div>
181</td>
182</tr>
183<tr class="altColor">
184<td class="colFirst"><a href="../../../org/codehaus/jackson/ObjectCodec.html" title="class in org.codehaus.jackson">ObjectCodec</a></td>
185<td class="colLast">
186<div class="block">Abstract class that defines the interface that <a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a> and
187 <a href="../../../org/codehaus/jackson/JsonGenerator.html" title="class in org.codehaus.jackson"><code>JsonGenerator</code></a> use to serialize and deserialize regular
188 Java objects (POJOs aka Beans).</div>
189</td>
190</tr>
191<tr class="rowColor">
192<td class="colFirst"><a href="../../../org/codehaus/jackson/Version.html" title="class in org.codehaus.jackson">Version</a></td>
193<td class="colLast">
194<div class="block">Object that encapsulates version information of a component,
195 and is return by <a href="../../../org/codehaus/jackson/Versioned.html#version()"><code>Versioned.version()</code></a>.</div>
196</td>
197</tr>
198</tbody>
199</table>
200</li>
201<li class="blockList">
202<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
203<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
204<tr>
205<th class="colFirst" scope="col">Enum</th>
206<th class="colLast" scope="col">Description</th>
207</tr>
208<tbody>
209<tr class="altColor">
210<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a></td>
211<td class="colLast">
212<div class="block">Enumeration that defines legal encodings that can be used
213 for JSON content, based on list of allowed encodings from
214 <a href="http://www.ietf.org/rfc/rfc4627.txt">JSON specification</a>.</div>
215</td>
216</tr>
217<tr class="rowColor">
218<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonGenerator.Feature.html" title="enum in org.codehaus.jackson">JsonGenerator.Feature</a></td>
219<td class="colLast">
220<div class="block">Enumeration that defines all togglable features for generators.</div>
221</td>
222</tr>
223<tr class="altColor">
224<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonParser.Feature.html" title="enum in org.codehaus.jackson">JsonParser.Feature</a></td>
225<td class="colLast">
226<div class="block">Enumeration that defines all togglable features for parsers.</div>
227</td>
228</tr>
229<tr class="rowColor">
230<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonParser.NumberType.html" title="enum in org.codehaus.jackson">JsonParser.NumberType</a></td>
231<td class="colLast">
232<div class="block">Enumeration of possible "native" (optimal) types that can be
233 used for numbers.</div>
234</td>
235</tr>
236<tr class="altColor">
237<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonToken.html" title="enum in org.codehaus.jackson">JsonToken</a></td>
238<td class="colLast">
239<div class="block">Enumeration for basic token types used for returning results
240 of parsing JSON content.</div>
241</td>
242</tr>
243</tbody>
244</table>
245</li>
246<li class="blockList">
247<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
248<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
249<tr>
250<th class="colFirst" scope="col">Exception</th>
251<th class="colLast" scope="col">Description</th>
252</tr>
253<tbody>
254<tr class="altColor">
255<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonGenerationException.html" title="class in org.codehaus.jackson">JsonGenerationException</a></td>
256<td class="colLast">
257<div class="block">Exception type for exceptions during JSON writing, such as trying
258 to output  content in wrong context (non-matching end-array or end-object,
259 for example).</div>
260</td>
261</tr>
262<tr class="rowColor">
263<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonParseException.html" title="class in org.codehaus.jackson">JsonParseException</a></td>
264<td class="colLast">
265<div class="block">Exception type for parsing problems, used when non-well-formed content
266 (content that does not conform to JSON syntax as per specification)
267 is encountered.</div>
268</td>
269</tr>
270<tr class="altColor">
271<td class="colFirst"><a href="../../../org/codehaus/jackson/JsonProcessingException.html" title="class in org.codehaus.jackson">JsonProcessingException</a></td>
272<td class="colLast">
273<div class="block">Intermediate base class for all problems encountered when
274 processing (parsing, generating) JSON content
275 that are not pure I/O problems.</div>
276</td>
277</tr>
278</tbody>
279</table>
280</li>
281</ul>
282<a name="package_description">
283<!--   -->
284</a>
285<h2 title="Package org.codehaus.jackson Description">Package org.codehaus.jackson Description</h2>
286<div class="block">Main public API classes of the core streaming JSON
287 processor: most importantly <a href="../../../org/codehaus/jackson/JsonFactory.html" title="class in org.codehaus.jackson"><code>JsonFactory</code></a>
288 used for constructing
289 JSON parser (<a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a>)
290 and generator
291 (<a href="../../../org/codehaus/jackson/JsonParser.html" title="class in org.codehaus.jackson"><code>JsonParser</code></a>)
292 instances.
293 <p>
294 Public API of the higher-level mapping interfaces ("Mapping API")
295 is found from
296 under <a href="../../../org/codehaus/jackson/map/package-summary.html"><code>org.codehaus.jackson.map</code></a> and not included here,
297 except for following base interfaces:
298 <ul>
299<li><a href="../../../org/codehaus/jackson/JsonNode.html" title="class in org.codehaus.jackson"><code>JsonNode</code></a> is included
300within Streaming API to support integration of the Tree Model
301(which is based on <code>JsonNode</code>) with the basic
302parsers and generators (iff using mapping-supporting factory: which
303is part of Mapping API, not core)
304  </li>
305<li><a href="../../../org/codehaus/jackson/ObjectCodec.html" title="class in org.codehaus.jackson"><code>ObjectCodec</code></a> is included so that
306  reference to the object capable of serializing/deserializing
307  Objects to/from JSON (usually, <a href="../../../org/codehaus/jackson/map/ObjectMapper.html" title="class in org.codehaus.jackson.map"><code>ObjectMapper</code></a>)
308  can be exposed, without adding direct dependency to implementation.
309  </li>
310</ul>
311 </ul></div>
312</div>
313<!-- ======= START OF BOTTOM NAVBAR ====== -->
314<div class="bottomNav"><a name="navbar_bottom">
315<!--   -->
316</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
317<!--   -->
318</a>
319<ul class="navList" title="Navigation">
320<li><a href="../../../overview-summary.html">Overview</a></li>
321<li class="navBarCell1Rev">Package</li>
322<li>Class</li>
323<li><a href="package-use.html">Use</a></li>
324<li><a href="package-tree.html">Tree</a></li>
325<li><a href="../../../deprecated-list.html">Deprecated</a></li>
326<li><a href="../../../index-all.html">Index</a></li>
327<li><a href="../../../help-doc.html">Help</a></li>
328</ul>
329</div>
330<div class="subNav">
331<ul class="navList">
332<li>Prev Package</li>
333<li><a href="../../../org/codehaus/jackson/annotate/package-summary.html">Next Package</a></li>
334</ul>
335<ul class="navList">
336<li><a href="../../../index.html?org/codehaus/jackson/package-summary.html" target="_top">Frames</a></li>
337<li><a href="package-summary.html" target="_top">No Frames</a></li>
338</ul>
339<ul class="navList" id="allclasses_navbar_bottom">
340<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
341</ul>
342<div>
343<script type="text/javascript"><!--
344  allClassesLink = document.getElementById("allclasses_navbar_bottom");
345  if(window==top) {
346    allClassesLink.style.display = "block";
347  }
348  else {
349    allClassesLink.style.display = "none";
350  }
351  //-->
352</script>
353</div>
354<a name="skip-navbar_bottom">
355<!--   -->
356</a></div>
357<!-- ======== END OF BOTTOM NAVBAR ======= -->
358</body>
359</html>
360