|
| 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 (1.8.0_272) on Thu Sep 30 13:16:08 PDT 2021 --> |
| 6 | +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 7 | +<title>FormatFeature (Jackson-core 2.13.0 API)</title> |
| 8 | +<meta name="date" content="2021-09-30"> |
| 9 | +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| 10 | +<script type="text/javascript" src="../../../../script.js"></script> |
| 11 | +</head> |
| 12 | +<body> |
| 13 | +<script type="text/javascript"><!-- |
| 14 | + try { |
| 15 | + if (location.href.indexOf('is-external=true') == -1) { |
| 16 | + parent.document.title="FormatFeature (Jackson-core 2.13.0 API)"; |
| 17 | + } |
| 18 | + } |
| 19 | + catch(err) { |
| 20 | + } |
| 21 | +//--> |
| 22 | +var methods = {"i0":6,"i1":6,"i2":6}; |
| 23 | +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| 24 | +var altColor = "altColor"; |
| 25 | +var rowColor = "rowColor"; |
| 26 | +var tableTab = "tableTab"; |
| 27 | +var activeTableTab = "activeTableTab"; |
| 28 | +</script> |
| 29 | +<noscript> |
| 30 | +<div>JavaScript is disabled on your browser.</div> |
| 31 | +</noscript> |
| 32 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 33 | +<div class="topNav"><a name="navbar.top"> |
| 34 | +<!-- --> |
| 35 | +</a> |
| 36 | +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| 37 | +<a name="navbar.top.firstrow"> |
| 38 | +<!-- --> |
| 39 | +</a> |
| 40 | +<ul class="navList" title="Navigation"> |
| 41 | +<li><a href="../../../../overview-summary.html">Overview</a></li> |
| 42 | +<li><a href="package-summary.html">Package</a></li> |
| 43 | +<li class="navBarCell1Rev">Class</li> |
| 44 | +<li><a href="class-use/FormatFeature.html">Use</a></li> |
| 45 | +<li><a href="package-tree.html">Tree</a></li> |
| 46 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 47 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 48 | +<li><a href="../../../../help-doc.html">Help</a></li> |
| 49 | +</ul> |
| 50 | +</div> |
| 51 | +<div class="subNav"> |
| 52 | +<ul class="navList"> |
| 53 | +<li><a href="../../../../com/fasterxml/jackson/core/Base64Variants.html" title="class in com.fasterxml.jackson.core"><span class="typeNameLink">Prev Class</span></a></li> |
| 54 | +<li><a href="../../../../com/fasterxml/jackson/core/FormatSchema.html" title="interface in com.fasterxml.jackson.core"><span class="typeNameLink">Next Class</span></a></li> |
| 55 | +</ul> |
| 56 | +<ul class="navList"> |
| 57 | +<li><a href="../../../../index.html?com/fasterxml/jackson/core/FormatFeature.html" target="_top">Frames</a></li> |
| 58 | +<li><a href="FormatFeature.html" target="_top">No Frames</a></li> |
| 59 | +</ul> |
| 60 | +<ul class="navList" id="allclasses_navbar_top"> |
| 61 | +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| 62 | +</ul> |
| 63 | +<div> |
| 64 | +<script type="text/javascript"><!-- |
| 65 | + allClassesLink = document.getElementById("allclasses_navbar_top"); |
| 66 | + if(window==top) { |
| 67 | + allClassesLink.style.display = "block"; |
| 68 | + } |
| 69 | + else { |
| 70 | + allClassesLink.style.display = "none"; |
| 71 | + } |
| 72 | + //--> |
| 73 | +</script> |
| 74 | +</div> |
| 75 | +<div> |
| 76 | +<ul class="subNavList"> |
| 77 | +<li>Summary: </li> |
| 78 | +<li>Nested | </li> |
| 79 | +<li>Field | </li> |
| 80 | +<li>Constr | </li> |
| 81 | +<li><a href="#method.summary">Method</a></li> |
| 82 | +</ul> |
| 83 | +<ul class="subNavList"> |
| 84 | +<li>Detail: </li> |
| 85 | +<li>Field | </li> |
| 86 | +<li>Constr | </li> |
| 87 | +<li><a href="#method.detail">Method</a></li> |
| 88 | +</ul> |
| 89 | +</div> |
| 90 | +<a name="skip.navbar.top"> |
| 91 | +<!-- --> |
| 92 | +</a></div> |
| 93 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 94 | +<!-- ======== START OF CLASS DATA ======== --> |
| 95 | +<div class="header"> |
| 96 | +<div class="subTitle">com.fasterxml.jackson.core</div> |
| 97 | +<h2 title="Interface FormatFeature" class="title">Interface FormatFeature</h2> |
| 98 | +</div> |
| 99 | +<div class="contentContainer"> |
| 100 | +<div class="description"> |
| 101 | +<ul class="blockList"> |
| 102 | +<li class="blockList"> |
| 103 | +<dl> |
| 104 | +<dt>All Superinterfaces:</dt> |
| 105 | +<dd><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></dd> |
| 106 | +</dl> |
| 107 | +<dl> |
| 108 | +<dt>All Known Implementing Classes:</dt> |
| 109 | +<dd><a href="../../../../com/fasterxml/jackson/core/json/JsonReadFeature.html" title="enum in com.fasterxml.jackson.core.json">JsonReadFeature</a>, <a href="../../../../com/fasterxml/jackson/core/json/JsonWriteFeature.html" title="enum in com.fasterxml.jackson.core.json">JsonWriteFeature</a></dd> |
| 110 | +</dl> |
| 111 | +<hr> |
| 112 | +<br> |
| 113 | +<pre>public interface <span class="typeNameLabel">FormatFeature</span> |
| 114 | +extends <a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></pre> |
| 115 | +<div class="block">Marker interface that is to be implemented by data format - specific features. |
| 116 | + Interface used since Java Enums can not extend classes or other Enums, but |
| 117 | + they can implement interfaces; and as such we may be able to use limited |
| 118 | + amount of generic functionality. |
| 119 | +<p> |
| 120 | + Since 2.12 this is more of an extra marker feature, as its core API is now |
| 121 | + defined in more general <a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util"><code>JacksonFeature</code></a>.</div> |
| 122 | +<dl> |
| 123 | +<dt><span class="simpleTagLabel">Since:</span></dt> |
| 124 | +<dd>2.6</dd> |
| 125 | +</dl> |
| 126 | +</li> |
| 127 | +</ul> |
| 128 | +</div> |
| 129 | +<div class="summary"> |
| 130 | +<ul class="blockList"> |
| 131 | +<li class="blockList"> |
| 132 | +<!-- ========== METHOD SUMMARY =========== --> |
| 133 | +<ul class="blockList"> |
| 134 | +<li class="blockList"><a name="method.summary"> |
| 135 | +<!-- --> |
| 136 | +</a> |
| 137 | +<h3>Method Summary</h3> |
| 138 | +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| 139 | +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| 140 | +<tr> |
| 141 | +<th class="colFirst" scope="col">Modifier and Type</th> |
| 142 | +<th class="colLast" scope="col">Method and Description</th> |
| 143 | +</tr> |
| 144 | +<tr id="i0" class="altColor"> |
| 145 | +<td class="colFirst"><code>boolean</code></td> |
| 146 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/core/FormatFeature.html#enabledByDefault--">enabledByDefault</a></span>()</code> |
| 147 | +<div class="block">Accessor for checking whether this feature is enabled by default.</div> |
| 148 | +</td> |
| 149 | +</tr> |
| 150 | +<tr id="i1" class="rowColor"> |
| 151 | +<td class="colFirst"><code>boolean</code></td> |
| 152 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/core/FormatFeature.html#enabledIn-int-">enabledIn</a></span>(int flags)</code> |
| 153 | +<div class="block">Convenience method for checking whether feature is enabled in given bitmask</div> |
| 154 | +</td> |
| 155 | +</tr> |
| 156 | +<tr id="i2" class="altColor"> |
| 157 | +<td class="colFirst"><code>int</code></td> |
| 158 | +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/core/FormatFeature.html#getMask--">getMask</a></span>()</code> |
| 159 | +<div class="block">Returns bit mask for this feature instance; must be a single bit, |
| 160 | + that is of form <code>(1 << N)</code></div> |
| 161 | +</td> |
| 162 | +</tr> |
| 163 | +</table> |
| 164 | +</li> |
| 165 | +</ul> |
| 166 | +</li> |
| 167 | +</ul> |
| 168 | +</div> |
| 169 | +<div class="details"> |
| 170 | +<ul class="blockList"> |
| 171 | +<li class="blockList"> |
| 172 | +<!-- ============ METHOD DETAIL ========== --> |
| 173 | +<ul class="blockList"> |
| 174 | +<li class="blockList"><a name="method.detail"> |
| 175 | +<!-- --> |
| 176 | +</a> |
| 177 | +<h3>Method Detail</h3> |
| 178 | +<a name="enabledByDefault--"> |
| 179 | +<!-- --> |
| 180 | +</a> |
| 181 | +<ul class="blockList"> |
| 182 | +<li class="blockList"> |
| 183 | +<h4>enabledByDefault</h4> |
| 184 | +<pre>boolean enabledByDefault()</pre> |
| 185 | +<div class="block">Accessor for checking whether this feature is enabled by default.</div> |
| 186 | +<dl> |
| 187 | +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| 188 | +<dd><code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html#enabledByDefault--">enabledByDefault</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></code></dd> |
| 189 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 190 | +<dd>Whether this instance is enabled by default or not</dd> |
| 191 | +</dl> |
| 192 | +</li> |
| 193 | +</ul> |
| 194 | +<a name="getMask--"> |
| 195 | +<!-- --> |
| 196 | +</a> |
| 197 | +<ul class="blockList"> |
| 198 | +<li class="blockList"> |
| 199 | +<h4>getMask</h4> |
| 200 | +<pre>int getMask()</pre> |
| 201 | +<div class="block">Returns bit mask for this feature instance; must be a single bit, |
| 202 | + that is of form <code>(1 << N)</code></div> |
| 203 | +<dl> |
| 204 | +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| 205 | +<dd><code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html#getMask--">getMask</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></code></dd> |
| 206 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 207 | +<dd>Bit mask of this feature</dd> |
| 208 | +</dl> |
| 209 | +</li> |
| 210 | +</ul> |
| 211 | +<a name="enabledIn-int-"> |
| 212 | +<!-- --> |
| 213 | +</a> |
| 214 | +<ul class="blockListLast"> |
| 215 | +<li class="blockList"> |
| 216 | +<h4>enabledIn</h4> |
| 217 | +<pre>boolean enabledIn(int flags)</pre> |
| 218 | +<div class="block">Convenience method for checking whether feature is enabled in given bitmask</div> |
| 219 | +<dl> |
| 220 | +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| 221 | +<dd><code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html#enabledIn-int-">enabledIn</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/core/util/JacksonFeature.html" title="interface in com.fasterxml.jackson.core.util">JacksonFeature</a></code></dd> |
| 222 | +<dt><span class="paramLabel">Parameters:</span></dt> |
| 223 | +<dd><code>flags</code> - Bit field that contains a set of enabled features of this type</dd> |
| 224 | +<dt><span class="returnLabel">Returns:</span></dt> |
| 225 | +<dd>True if this feature is enabled in passed bit field</dd> |
| 226 | +</dl> |
| 227 | +</li> |
| 228 | +</ul> |
| 229 | +</li> |
| 230 | +</ul> |
| 231 | +</li> |
| 232 | +</ul> |
| 233 | +</div> |
| 234 | +</div> |
| 235 | +<!-- ========= END OF CLASS DATA ========= --> |
| 236 | +<!-- ======= START OF BOTTOM NAVBAR ====== --> |
| 237 | +<div class="bottomNav"><a name="navbar.bottom"> |
| 238 | +<!-- --> |
| 239 | +</a> |
| 240 | +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| 241 | +<a name="navbar.bottom.firstrow"> |
| 242 | +<!-- --> |
| 243 | +</a> |
| 244 | +<ul class="navList" title="Navigation"> |
| 245 | +<li><a href="../../../../overview-summary.html">Overview</a></li> |
| 246 | +<li><a href="package-summary.html">Package</a></li> |
| 247 | +<li class="navBarCell1Rev">Class</li> |
| 248 | +<li><a href="class-use/FormatFeature.html">Use</a></li> |
| 249 | +<li><a href="package-tree.html">Tree</a></li> |
| 250 | +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| 251 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 252 | +<li><a href="../../../../help-doc.html">Help</a></li> |
| 253 | +</ul> |
| 254 | +</div> |
| 255 | +<div class="subNav"> |
| 256 | +<ul class="navList"> |
| 257 | +<li><a href="../../../../com/fasterxml/jackson/core/Base64Variants.html" title="class in com.fasterxml.jackson.core"><span class="typeNameLink">Prev Class</span></a></li> |
| 258 | +<li><a href="../../../../com/fasterxml/jackson/core/FormatSchema.html" title="interface in com.fasterxml.jackson.core"><span class="typeNameLink">Next Class</span></a></li> |
| 259 | +</ul> |
| 260 | +<ul class="navList"> |
| 261 | +<li><a href="../../../../index.html?com/fasterxml/jackson/core/FormatFeature.html" target="_top">Frames</a></li> |
| 262 | +<li><a href="FormatFeature.html" target="_top">No Frames</a></li> |
| 263 | +</ul> |
| 264 | +<ul class="navList" id="allclasses_navbar_bottom"> |
| 265 | +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| 266 | +</ul> |
| 267 | +<div> |
| 268 | +<script type="text/javascript"><!-- |
| 269 | + allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| 270 | + if(window==top) { |
| 271 | + allClassesLink.style.display = "block"; |
| 272 | + } |
| 273 | + else { |
| 274 | + allClassesLink.style.display = "none"; |
| 275 | + } |
| 276 | + //--> |
| 277 | +</script> |
| 278 | +</div> |
| 279 | +<div> |
| 280 | +<ul class="subNavList"> |
| 281 | +<li>Summary: </li> |
| 282 | +<li>Nested | </li> |
| 283 | +<li>Field | </li> |
| 284 | +<li>Constr | </li> |
| 285 | +<li><a href="#method.summary">Method</a></li> |
| 286 | +</ul> |
| 287 | +<ul class="subNavList"> |
| 288 | +<li>Detail: </li> |
| 289 | +<li>Field | </li> |
| 290 | +<li>Constr | </li> |
| 291 | +<li><a href="#method.detail">Method</a></li> |
| 292 | +</ul> |
| 293 | +</div> |
| 294 | +<a name="skip.navbar.bottom"> |
| 295 | +<!-- --> |
| 296 | +</a></div> |
| 297 | +<!-- ======== END OF BOTTOM NAVBAR ======= --> |
| 298 | +<p class="legalCopy"><small>Copyright © 2008–2021 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> |
| 299 | +</body> |
| 300 | +</html> |
0 commit comments