• 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>SmileParser.Feature (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="SmileParser.Feature (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/SmileParser.Feature.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/smile/SmileParser.html" title="class in org.codehaus.jackson.smile"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../org/codehaus/jackson/smile/SmileParserBootstrapper.html" title="class in org.codehaus.jackson.smile"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?org/codehaus/jackson/smile/SmileParser.Feature.html" target="_top">Frames</a></li>
44<li><a href="SmileParser.Feature.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:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
66<li>Field&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
72<li>Field&nbsp;|&nbsp;</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.smile</div>
83<h2 title="Enum SmileParser.Feature" class="title">Enum SmileParser.Feature</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
88<li>
89<ul class="inheritance">
90<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a>&gt;</li>
91<li>
92<ul class="inheritance">
93<li>org.codehaus.jackson.smile.SmileParser.Feature</li>
94</ul>
95</li>
96</ul>
97</li>
98</ul>
99<div class="description">
100<ul class="blockList">
101<li class="blockList">
102<dl>
103<dt>All Implemented Interfaces:</dt>
104<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a>&gt;</dd>
105</dl>
106<dl>
107<dt>Enclosing class:</dt>
108<dd><a href="../../../../org/codehaus/jackson/smile/SmileParser.html" title="class in org.codehaus.jackson.smile">SmileParser</a></dd>
109</dl>
110<hr>
111<br>
112<pre>public static enum <span class="strong">SmileParser.Feature</span>
113extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a>&gt;</pre>
114<div class="block">Enumeration that defines all togglable features for Smile generators.</div>
115</li>
116</ul>
117</div>
118<div class="summary">
119<ul class="blockList">
120<li class="blockList">
121<!-- =========== ENUM CONSTANT SUMMARY =========== -->
122<ul class="blockList">
123<li class="blockList"><a name="enum_constant_summary">
124<!--   -->
125</a>
126<h3>Enum Constant Summary</h3>
127<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
128<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
129<tr>
130<th class="colOne" scope="col">Enum Constant and Description</th>
131</tr>
132<tr class="altColor">
133<td class="colOne"><code><strong><a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html#REQUIRE_HEADER">REQUIRE_HEADER</a></strong></code>
134<div class="block">Feature that determines whether 4-byte Smile header is mandatory in input,
135 or optional.</div>
136</td>
137</tr>
138</table>
139</li>
140</ul>
141<!-- ========== METHOD SUMMARY =========== -->
142<ul class="blockList">
143<li class="blockList"><a name="method_summary">
144<!--   -->
145</a>
146<h3>Method Summary</h3>
147<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
148<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
149<tr>
150<th class="colFirst" scope="col">Modifier and Type</th>
151<th class="colLast" scope="col">Method and Description</th>
152</tr>
153<tr class="altColor">
154<td class="colFirst"><code>static int</code></td>
155<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html#collectDefaults()">collectDefaults</a></strong>()</code>
156<div class="block">Method that calculates bit set (flags) of all features that
157 are enabled by default.</div>
158</td>
159</tr>
160<tr class="rowColor">
161<td class="colFirst"><code>boolean</code></td>
162<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html#enabledByDefault()">enabledByDefault</a></strong>()</code>&nbsp;</td>
163</tr>
164<tr class="altColor">
165<td class="colFirst"><code>int</code></td>
166<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html#getMask()">getMask</a></strong>()</code>&nbsp;</td>
167</tr>
168<tr class="rowColor">
169<td class="colFirst"><code>static <a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a></code></td>
170<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html#valueOf(java.lang.String)">valueOf</a></strong>(<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>&nbsp;name)</code>
171<div class="block">Returns the enum constant of this type with the specified name.</div>
172</td>
173</tr>
174<tr class="altColor">
175<td class="colFirst"><code>static <a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a>[]</code></td>
176<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html#values()">values</a></strong>()</code>
177<div class="block">Returns an array containing the constants of this enum type, in
178the order they are declared.</div>
179</td>
180</tr>
181</table>
182<ul class="blockList">
183<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum">
184<!--   -->
185</a>
186<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
187<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li>
188</ul>
189<ul class="blockList">
190<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
191<!--   -->
192</a>
193<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
194<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
195</ul>
196</li>
197</ul>
198</li>
199</ul>
200</div>
201<div class="details">
202<ul class="blockList">
203<li class="blockList">
204<!-- ============ ENUM CONSTANT DETAIL =========== -->
205<ul class="blockList">
206<li class="blockList"><a name="enum_constant_detail">
207<!--   -->
208</a>
209<h3>Enum Constant Detail</h3>
210<a name="REQUIRE_HEADER">
211<!--   -->
212</a>
213<ul class="blockListLast">
214<li class="blockList">
215<h4>REQUIRE_HEADER</h4>
216<pre>public static final&nbsp;<a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a> REQUIRE_HEADER</pre>
217<div class="block">Feature that determines whether 4-byte Smile header is mandatory in input,
218 or optional. If enabled, it means that only input that starts with the header
219 is accepted as valid; if disabled, header is optional. In latter case,r
220 settings for content are assumed to be defaults.</div>
221</li>
222</ul>
223</li>
224</ul>
225<!-- ============ METHOD DETAIL ========== -->
226<ul class="blockList">
227<li class="blockList"><a name="method_detail">
228<!--   -->
229</a>
230<h3>Method Detail</h3>
231<a name="values()">
232<!--   -->
233</a>
234<ul class="blockList">
235<li class="blockList">
236<h4>values</h4>
237<pre>public static&nbsp;<a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a>[]&nbsp;values()</pre>
238<div class="block">Returns an array containing the constants of this enum type, in
239the order they are declared.  This method may be used to iterate
240over the constants as follows:
241<pre>
242for (SmileParser.Feature c : SmileParser.Feature.values())
243&nbsp;   System.out.println(c);
244</pre></div>
245<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
246the order they are declared</dd></dl>
247</li>
248</ul>
249<a name="valueOf(java.lang.String)">
250<!--   -->
251</a>
252<ul class="blockList">
253<li class="blockList">
254<h4>valueOf</h4>
255<pre>public static&nbsp;<a href="../../../../org/codehaus/jackson/smile/SmileParser.Feature.html" title="enum in org.codehaus.jackson.smile">SmileParser.Feature</a>&nbsp;valueOf(<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>&nbsp;name)</pre>
256<div class="block">Returns the enum constant of this type with the specified name.
257The string must match <i>exactly</i> an identifier used to declare an
258enum constant in this type.  (Extraneous whitespace characters are
259not permitted.)</div>
260<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
261<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
262<dt><span class="strong">Throws:</span></dt>
263<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant
264with the specified name</dd>
265<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl>
266</li>
267</ul>
268<a name="collectDefaults()">
269<!--   -->
270</a>
271<ul class="blockList">
272<li class="blockList">
273<h4>collectDefaults</h4>
274<pre>public static&nbsp;int&nbsp;collectDefaults()</pre>
275<div class="block">Method that calculates bit set (flags) of all features that
276 are enabled by default.</div>
277</li>
278</ul>
279<a name="enabledByDefault()">
280<!--   -->
281</a>
282<ul class="blockList">
283<li class="blockList">
284<h4>enabledByDefault</h4>
285<pre>public&nbsp;boolean&nbsp;enabledByDefault()</pre>
286</li>
287</ul>
288<a name="getMask()">
289<!--   -->
290</a>
291<ul class="blockListLast">
292<li class="blockList">
293<h4>getMask</h4>
294<pre>public&nbsp;int&nbsp;getMask()</pre>
295</li>
296</ul>
297</li>
298</ul>
299</li>
300</ul>
301</div>
302</div>
303<!-- ========= END OF CLASS DATA ========= -->
304<!-- ======= START OF BOTTOM NAVBAR ====== -->
305<div class="bottomNav"><a name="navbar_bottom">
306<!--   -->
307</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
308<!--   -->
309</a>
310<ul class="navList" title="Navigation">
311<li><a href="../../../../overview-summary.html">Overview</a></li>
312<li><a href="package-summary.html">Package</a></li>
313<li class="navBarCell1Rev">Class</li>
314<li><a href="class-use/SmileParser.Feature.html">Use</a></li>
315<li><a href="package-tree.html">Tree</a></li>
316<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
317<li><a href="../../../../index-all.html">Index</a></li>
318<li><a href="../../../../help-doc.html">Help</a></li>
319</ul>
320</div>
321<div class="subNav">
322<ul class="navList">
323<li><a href="../../../../org/codehaus/jackson/smile/SmileParser.html" title="class in org.codehaus.jackson.smile"><span class="strong">Prev Class</span></a></li>
324<li><a href="../../../../org/codehaus/jackson/smile/SmileParserBootstrapper.html" title="class in org.codehaus.jackson.smile"><span class="strong">Next Class</span></a></li>
325</ul>
326<ul class="navList">
327<li><a href="../../../../index.html?org/codehaus/jackson/smile/SmileParser.Feature.html" target="_top">Frames</a></li>
328<li><a href="SmileParser.Feature.html" target="_top">No Frames</a></li>
329</ul>
330<ul class="navList" id="allclasses_navbar_bottom">
331<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
332</ul>
333<div>
334<script type="text/javascript"><!--
335  allClassesLink = document.getElementById("allclasses_navbar_bottom");
336  if(window==top) {
337    allClassesLink.style.display = "block";
338  }
339  else {
340    allClassesLink.style.display = "none";
341  }
342  //-->
343</script>
344</div>
345<div>
346<ul class="subNavList">
347<li>Summary:&nbsp;</li>
348<li>Nested&nbsp;|&nbsp;</li>
349<li><a href="#enum_constant_summary">Enum Constants</a>&nbsp;|&nbsp;</li>
350<li>Field&nbsp;|&nbsp;</li>
351<li><a href="#method_summary">Method</a></li>
352</ul>
353<ul class="subNavList">
354<li>Detail:&nbsp;</li>
355<li><a href="#enum_constant_detail">Enum Constants</a>&nbsp;|&nbsp;</li>
356<li>Field&nbsp;|&nbsp;</li>
357<li><a href="#method_detail">Method</a></li>
358</ul>
359</div>
360<a name="skip-navbar_bottom">
361<!--   -->
362</a></div>
363<!-- ======== END OF BOTTOM NAVBAR ======= -->
364</body>
365</html>
366