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_67) on Thu Jul 16 17:03:17 PDT 2015 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>OptBoolean (Jackson-annotations 2.6.0 API)</title> 8<meta name="date" content="2015-07-16"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="OptBoolean (Jackson-annotations 2.6.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/OptBoolean.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="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/OptBoolean.html" target="_top">Frames</a></li> 44<li><a href="OptBoolean.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><a href="#enum_constant_summary">Enum Constants</a> | </li> 66<li>Field | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 72<li>Field | </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">com.fasterxml.jackson.annotation</div> 83<h2 title="Enum OptBoolean" class="title">Enum OptBoolean</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><<a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a>></li> 91<li> 92<ul class="inheritance"> 93<li>com.fasterxml.jackson.annotation.OptBoolean</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><<a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a>></dd> 105</dl> 106<hr> 107<br> 108<pre>public enum <span class="strong">OptBoolean</span> 109extends <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><<a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a>></pre> 110<div class="block">Optional Boolean value ("nullean"). Needed just because Java annotations 111 can not take 'null' as a value (even as default), so there is no 112 way to distinguish between explicit `true` and `false`, and lack of 113 choice (related: annotations are limited to primitives, so 114 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang"><code>Boolean</code></a> not allowed as solution). 115<p> 116 Note: although use of `true` and `false` would be more convenient, they 117 can not be chosen since they are Java keyword and compiler won't allow 118 the choice. And since enum naming convention suggests all-upper-case, 119 that is what is done here.</div> 120<dl><dt><span class="strong">Since:</span></dt> 121 <dd>2.6</dd></dl> 122</li> 123</ul> 124</div> 125<div class="summary"> 126<ul class="blockList"> 127<li class="blockList"> 128<!-- =========== ENUM CONSTANT SUMMARY =========== --> 129<ul class="blockList"> 130<li class="blockList"><a name="enum_constant_summary"> 131<!-- --> 132</a> 133<h3>Enum Constant Summary</h3> 134<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 135<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 136<tr> 137<th class="colOne" scope="col">Enum Constant and Description</th> 138</tr> 139<tr class="altColor"> 140<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#DEFAULT">DEFAULT</a></strong></code> 141<div class="block">Value that indicates that the annotation property does NOT have an explicit 142 definition of enabled/disabled (or true/false); instead, a higher-level 143 configuration value is used; or lacking higher-level global setting, 144 default.</div> 145</td> 146</tr> 147<tr class="rowColor"> 148<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#FALSE">FALSE</a></strong></code> 149<div class="block">Value that indicates that the annotation property is explicitly defined to 150 be disabled, or false.</div> 151</td> 152</tr> 153<tr class="altColor"> 154<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#TRUE">TRUE</a></strong></code> 155<div class="block">Value that indicates that the annotation property is explicitly defined to 156 be enabled, or true.</div> 157</td> 158</tr> 159</table> 160</li> 161</ul> 162<!-- ========== METHOD SUMMARY =========== --> 163<ul class="blockList"> 164<li class="blockList"><a name="method_summary"> 165<!-- --> 166</a> 167<h3>Method Summary</h3> 168<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 169<caption><span>Methods</span><span class="tabEnd"> </span></caption> 170<tr> 171<th class="colFirst" scope="col">Modifier and Type</th> 172<th class="colLast" scope="col">Method and Description</th> 173</tr> 174<tr class="altColor"> 175<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> 176<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#asBoolean()">asBoolean</a></strong>()</code> </td> 177</tr> 178<tr class="rowColor"> 179<td class="colFirst"><code>boolean</code></td> 180<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#asPrimitive()">asPrimitive</a></strong>()</code> </td> 181</tr> 182<tr class="altColor"> 183<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></code></td> 184<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#fromBoolean(java.lang.Boolean)">fromBoolean</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> b)</code> </td> 185</tr> 186<tr class="rowColor"> 187<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></code></td> 188<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.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> name)</code> 189<div class="block">Returns the enum constant of this type with the specified name.</div> 190</td> 191</tr> 192<tr class="altColor"> 193<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a>[]</code></td> 194<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html#values()">values</a></strong>()</code> 195<div class="block">Returns an array containing the constants of this enum type, in 196the order they are declared.</div> 197</td> 198</tr> 199</table> 200<ul class="blockList"> 201<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> 202<!-- --> 203</a> 204<h3>Methods inherited from class 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> 205<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,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> 206</ul> 207<ul class="blockList"> 208<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 209<!-- --> 210</a> 211<h3>Methods inherited from class 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> 212<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,%20int)" title="class or interface in java.lang">wait</a></code></li> 213</ul> 214</li> 215</ul> 216</li> 217</ul> 218</div> 219<div class="details"> 220<ul class="blockList"> 221<li class="blockList"> 222<!-- ============ ENUM CONSTANT DETAIL =========== --> 223<ul class="blockList"> 224<li class="blockList"><a name="enum_constant_detail"> 225<!-- --> 226</a> 227<h3>Enum Constant Detail</h3> 228<a name="TRUE"> 229<!-- --> 230</a> 231<ul class="blockList"> 232<li class="blockList"> 233<h4>TRUE</h4> 234<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a> TRUE</pre> 235<div class="block">Value that indicates that the annotation property is explicitly defined to 236 be enabled, or true.</div> 237</li> 238</ul> 239<a name="FALSE"> 240<!-- --> 241</a> 242<ul class="blockList"> 243<li class="blockList"> 244<h4>FALSE</h4> 245<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a> FALSE</pre> 246<div class="block">Value that indicates that the annotation property is explicitly defined to 247 be disabled, or false.</div> 248</li> 249</ul> 250<a name="DEFAULT"> 251<!-- --> 252</a> 253<ul class="blockListLast"> 254<li class="blockList"> 255<h4>DEFAULT</h4> 256<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a> DEFAULT</pre> 257<div class="block">Value that indicates that the annotation property does NOT have an explicit 258 definition of enabled/disabled (or true/false); instead, a higher-level 259 configuration value is used; or lacking higher-level global setting, 260 default.</div> 261</li> 262</ul> 263</li> 264</ul> 265<!-- ============ METHOD DETAIL ========== --> 266<ul class="blockList"> 267<li class="blockList"><a name="method_detail"> 268<!-- --> 269</a> 270<h3>Method Detail</h3> 271<a name="values()"> 272<!-- --> 273</a> 274<ul class="blockList"> 275<li class="blockList"> 276<h4>values</h4> 277<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a>[] values()</pre> 278<div class="block">Returns an array containing the constants of this enum type, in 279the order they are declared. This method may be used to iterate 280over the constants as follows: 281<pre> 282for (OptBoolean c : OptBoolean.values()) 283 System.out.println(c); 284</pre></div> 285<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> 286</li> 287</ul> 288<a name="valueOf(java.lang.String)"> 289<!-- --> 290</a> 291<ul class="blockList"> 292<li class="blockList"> 293<h4>valueOf</h4> 294<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a> 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> name)</pre> 295<div class="block">Returns the enum constant of this type with the specified name. 296The string must match <i>exactly</i> an identifier used to declare an 297enum constant in this type. (Extraneous whitespace characters are 298not permitted.)</div> 299<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> 300<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> 301<dt><span class="strong">Throws:</span></dt> 302<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 with the specified name</dd> 303<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> 304</li> 305</ul> 306<a name="asBoolean()"> 307<!-- --> 308</a> 309<ul class="blockList"> 310<li class="blockList"> 311<h4>asBoolean</h4> 312<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> asBoolean()</pre> 313</li> 314</ul> 315<a name="asPrimitive()"> 316<!-- --> 317</a> 318<ul class="blockList"> 319<li class="blockList"> 320<h4>asPrimitive</h4> 321<pre>public boolean asPrimitive()</pre> 322</li> 323</ul> 324<a name="fromBoolean(java.lang.Boolean)"> 325<!-- --> 326</a> 327<ul class="blockListLast"> 328<li class="blockList"> 329<h4>fromBoolean</h4> 330<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a> fromBoolean(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> b)</pre> 331</li> 332</ul> 333</li> 334</ul> 335</li> 336</ul> 337</div> 338</div> 339<!-- ========= END OF CLASS DATA ========= --> 340<!-- ======= START OF BOTTOM NAVBAR ====== --> 341<div class="bottomNav"><a name="navbar_bottom"> 342<!-- --> 343</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 344<!-- --> 345</a> 346<ul class="navList" title="Navigation"> 347<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 348<li class="navBarCell1Rev">Class</li> 349<li><a href="class-use/OptBoolean.html">Use</a></li> 350<li><a href="package-tree.html">Tree</a></li> 351<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 352<li><a href="../../../../index-all.html">Index</a></li> 353<li><a href="../../../../help-doc.html">Help</a></li> 354</ul> 355</div> 356<div class="subNav"> 357<ul class="navList"> 358<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 359<li><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 360</ul> 361<ul class="navList"> 362<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/OptBoolean.html" target="_top">Frames</a></li> 363<li><a href="OptBoolean.html" target="_top">No Frames</a></li> 364</ul> 365<ul class="navList" id="allclasses_navbar_bottom"> 366<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 367</ul> 368<div> 369<script type="text/javascript"><!-- 370 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 371 if(window==top) { 372 allClassesLink.style.display = "block"; 373 } 374 else { 375 allClassesLink.style.display = "none"; 376 } 377 //--> 378</script> 379</div> 380<div> 381<ul class="subNavList"> 382<li>Summary: </li> 383<li>Nested | </li> 384<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 385<li>Field | </li> 386<li><a href="#method_summary">Method</a></li> 387</ul> 388<ul class="subNavList"> 389<li>Detail: </li> 390<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 391<li>Field | </li> 392<li><a href="#method_detail">Method</a></li> 393</ul> 394</div> 395<a name="skip-navbar_bottom"> 396<!-- --> 397</a></div> 398<!-- ======== END OF BOTTOM NAVBAR ======= --> 399<p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 400</body> 401</html> 402