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) on Sun Jul 19 11:36:53 PDT 2015 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>PropertyWriter (jackson-databind 2.6.0 API)</title> 8<meta name="date" content="2015-07-19"> 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="PropertyWriter (jackson-databind 2.6.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":6,"i1":38,"i2":10,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6}; 23var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; 24var altColor = "altColor"; 25var rowColor = "rowColor"; 26var tableTab = "tableTab"; 27var 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/PropertyWriter.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/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../../com/fasterxml/jackson/databind/ser/ResolvableSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/ser/PropertyWriter.html" target="_top">Frames</a></li> 58<li><a href="PropertyWriter.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.databind.ser</div> 97<h2 title="Class PropertyWriter" class="title">Class PropertyWriter</h2> 98</div> 99<div class="contentContainer"> 100<ul class="inheritance"> 101<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> 102<li> 103<ul class="inheritance"> 104<li>com.fasterxml.jackson.databind.ser.PropertyWriter</li> 105</ul> 106</li> 107</ul> 108<div class="description"> 109<ul class="blockList"> 110<li class="blockList"> 111<dl> 112<dt>Direct Known Subclasses:</dt> 113<dd><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">BeanPropertyWriter</a>, <a href="../../../../../com/fasterxml/jackson/databind/ser/std/MapProperty.html" title="class in com.fasterxml.jackson.databind.ser.std">MapProperty</a></dd> 114</dl> 115<hr> 116<br> 117<pre>public abstract class <span class="typeNameLabel">PropertyWriter</span> 118extends <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></pre> 119<div class="block">Base class for writers used to output property values (name-value pairs) 120 as key/value pairs via streaming API. This is the most generic abstraction 121 implemented by both POJO and <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> serializers, and invoked 122 by filtering functionality.</div> 123<dl> 124<dt><span class="simpleTagLabel">Since:</span></dt> 125<dd>2.3</dd> 126</dl> 127</li> 128</ul> 129</div> 130<div class="summary"> 131<ul class="blockList"> 132<li class="blockList"> 133<!-- ======== CONSTRUCTOR SUMMARY ======== --> 134<ul class="blockList"> 135<li class="blockList"><a name="constructor.summary"> 136<!-- --> 137</a> 138<h3>Constructor Summary</h3> 139<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 140<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 141<tr> 142<th class="colOne" scope="col">Constructor and Description</th> 143</tr> 144<tr class="altColor"> 145<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#PropertyWriter--">PropertyWriter</a></span>()</code> </td> 146</tr> 147</table> 148</li> 149</ul> 150<!-- ========== METHOD SUMMARY =========== --> 151<ul class="blockList"> 152<li class="blockList"><a name="method.summary"> 153<!-- --> 154</a> 155<h3>Method Summary</h3> 156<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 157<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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> 158<tr> 159<th class="colFirst" scope="col">Modifier and Type</th> 160<th class="colLast" scope="col">Method and Description</th> 161</tr> 162<tr id="i0" class="altColor"> 163<td class="colFirst"><code>abstract void</code></td> 164<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#depositSchemaProperty-com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor-">depositSchemaProperty</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor)</code> 165<div class="block">Traversal method used for things like JSON Schema generation, or 166 POJO introspection.</div> 167</td> 168</tr> 169<tr id="i1" class="rowColor"> 170<td class="colFirst"><code>abstract void</code></td> 171<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#depositSchemaProperty-com.fasterxml.jackson.databind.node.ObjectNode-com.fasterxml.jackson.databind.SerializerProvider-">depositSchemaProperty</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> propertiesNode, 172 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 173<div class="block"><span class="deprecatedLabel">Deprecated.</span> 174<div class="block"><span class="deprecationComment">Since 2.2</span></div> 175</div> 176</td> 177</tr> 178<tr id="i2" class="altColor"> 179<td class="colFirst"><code><A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>><br>A</code></td> 180<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#findAnnotation-java.lang.Class-">findAnnotation</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 181<div class="block">Convenience method for accessing annotation that may be associated 182 either directly on property, or, if not, via enclosing class (context).</div> 183</td> 184</tr> 185<tr id="i3" class="rowColor"> 186<td class="colFirst"><code>abstract <A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>><br>A</code></td> 187<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getAnnotation-java.lang.Class-">getAnnotation</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 188<div class="block">Method for accessing annotations directly declared for property that this 189 writer is associated with.</div> 190</td> 191</tr> 192<tr id="i4" class="altColor"> 193<td class="colFirst"><code>abstract <A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>><br>A</code></td> 194<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getContextAnnotation-java.lang.Class-">getContextAnnotation</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 195<div class="block">Method for accessing annotations declared in context of the property that this 196 writer is associated with; usually this means annotations on enclosing class 197 for property.</div> 198</td> 199</tr> 200<tr id="i5" class="rowColor"> 201<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 202<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getFullName--">getFullName</a></span>()</code> </td> 203</tr> 204<tr id="i6" class="altColor"> 205<td class="colFirst"><code>abstract <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> 206<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getName--">getName</a></span>()</code> </td> 207</tr> 208<tr id="i7" class="rowColor"> 209<td class="colFirst"><code>abstract void</code></td> 210<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsElement-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-">serializeAsElement</a></span>(<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> value, 211 com.fasterxml.jackson.core.JsonGenerator jgen, 212 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 213<div class="block">Serialization method called when output is to be done as an array, 214 that is, not using property names.</div> 215</td> 216</tr> 217<tr id="i8" class="altColor"> 218<td class="colFirst"><code>abstract void</code></td> 219<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsField-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-">serializeAsField</a></span>(<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> value, 220 com.fasterxml.jackson.core.JsonGenerator jgen, 221 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 222<div class="block">The main serialization method called by filter when property is to be written normally.</div> 223</td> 224</tr> 225<tr id="i9" class="rowColor"> 226<td class="colFirst"><code>abstract void</code></td> 227<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsOmittedField-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-">serializeAsOmittedField</a></span>(<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> value, 228 com.fasterxml.jackson.core.JsonGenerator jgen, 229 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 230<div class="block">Serialization method that filter needs to call in cases where property is to be 231 filtered, but the underlying data format requires a placeholder of some kind.</div> 232</td> 233</tr> 234<tr id="i10" class="altColor"> 235<td class="colFirst"><code>abstract void</code></td> 236<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsPlaceholder-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-">serializeAsPlaceholder</a></span>(<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> value, 237 com.fasterxml.jackson.core.JsonGenerator jgen, 238 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 239<div class="block">Serialization method called when doing tabular (positional) output from databind, 240 but then value is to be omitted.</div> 241</td> 242</tr> 243</table> 244<ul class="blockList"> 245<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 246<!-- --> 247</a> 248<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> 249<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.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/Object.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/Object.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/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#hashCode--" title="class or interface in java.lang">hashCode</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#toString--" title="class or interface in java.lang">toString</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> 250</ul> 251</li> 252</ul> 253</li> 254</ul> 255</div> 256<div class="details"> 257<ul class="blockList"> 258<li class="blockList"> 259<!-- ========= CONSTRUCTOR DETAIL ======== --> 260<ul class="blockList"> 261<li class="blockList"><a name="constructor.detail"> 262<!-- --> 263</a> 264<h3>Constructor Detail</h3> 265<a name="PropertyWriter--"> 266<!-- --> 267</a> 268<ul class="blockListLast"> 269<li class="blockList"> 270<h4>PropertyWriter</h4> 271<pre>public PropertyWriter()</pre> 272</li> 273</ul> 274</li> 275</ul> 276<!-- ============ METHOD DETAIL ========== --> 277<ul class="blockList"> 278<li class="blockList"><a name="method.detail"> 279<!-- --> 280</a> 281<h3>Method Detail</h3> 282<a name="getName--"> 283<!-- --> 284</a> 285<ul class="blockList"> 286<li class="blockList"> 287<h4>getName</h4> 288<pre>public abstract <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> getName()</pre> 289</li> 290</ul> 291<a name="getFullName--"> 292<!-- --> 293</a> 294<ul class="blockList"> 295<li class="blockList"> 296<h4>getFullName</h4> 297<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getFullName()</pre> 298</li> 299</ul> 300<a name="findAnnotation-java.lang.Class-"> 301<!-- --> 302</a> 303<ul class="blockList"> 304<li class="blockList"> 305<h4>findAnnotation</h4> 306<pre>public <A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> A findAnnotation(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 307<div class="block">Convenience method for accessing annotation that may be associated 308 either directly on property, or, if not, via enclosing class (context). 309 This allows adding baseline contextual annotations, for example, by adding 310 an annotation for a given class and making that apply to all properties 311 unless overridden by per-property annotations. 312<p> 313 This method is functionally equivalent to: 314<pre> 315 MyAnnotation ann = propWriter.getAnnotation(MyAnnotation.class); 316 if (ann == null) { 317 ann = propWriter.getContextAnnotation(MyAnnotation.class); 318 } 319</pre> 320 that is, tries to find a property annotation first, but if one is not 321 found, tries to find context-annotation (from enclosing class) of 322 same type.</div> 323<dl> 324<dt><span class="simpleTagLabel">Since:</span></dt> 325<dd>2.5</dd> 326</dl> 327</li> 328</ul> 329<a name="getAnnotation-java.lang.Class-"> 330<!-- --> 331</a> 332<ul class="blockList"> 333<li class="blockList"> 334<h4>getAnnotation</h4> 335<pre>public abstract <A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> A getAnnotation(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 336<div class="block">Method for accessing annotations directly declared for property that this 337 writer is associated with.</div> 338<dl> 339<dt><span class="simpleTagLabel">Since:</span></dt> 340<dd>2.5</dd> 341</dl> 342</li> 343</ul> 344<a name="getContextAnnotation-java.lang.Class-"> 345<!-- --> 346</a> 347<ul class="blockList"> 348<li class="blockList"> 349<h4>getContextAnnotation</h4> 350<pre>public abstract <A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> A getContextAnnotation(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 351<div class="block">Method for accessing annotations declared in context of the property that this 352 writer is associated with; usually this means annotations on enclosing class 353 for property.</div> 354<dl> 355<dt><span class="simpleTagLabel">Since:</span></dt> 356<dd>2.5</dd> 357</dl> 358</li> 359</ul> 360<a name="serializeAsField-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-"> 361<!-- --> 362</a> 363<ul class="blockList"> 364<li class="blockList"> 365<h4>serializeAsField</h4> 366<pre>public abstract void serializeAsField(<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> value, 367 com.fasterxml.jackson.core.JsonGenerator jgen, 368 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 369 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 370<div class="block">The main serialization method called by filter when property is to be written normally.</div> 371<dl> 372<dt><span class="throwsLabel">Throws:</span></dt> 373<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> 374</dl> 375</li> 376</ul> 377<a name="serializeAsOmittedField-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-"> 378<!-- --> 379</a> 380<ul class="blockList"> 381<li class="blockList"> 382<h4>serializeAsOmittedField</h4> 383<pre>public abstract void serializeAsOmittedField(<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> value, 384 com.fasterxml.jackson.core.JsonGenerator jgen, 385 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 386 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 387<div class="block">Serialization method that filter needs to call in cases where property is to be 388 filtered, but the underlying data format requires a placeholder of some kind. 389 This is usually the case for tabular (positional) data formats such as CSV.</div> 390<dl> 391<dt><span class="throwsLabel">Throws:</span></dt> 392<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> 393</dl> 394</li> 395</ul> 396<a name="serializeAsElement-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-"> 397<!-- --> 398</a> 399<ul class="blockList"> 400<li class="blockList"> 401<h4>serializeAsElement</h4> 402<pre>public abstract void serializeAsElement(<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> value, 403 com.fasterxml.jackson.core.JsonGenerator jgen, 404 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 405 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 406<div class="block">Serialization method called when output is to be done as an array, 407 that is, not using property names. This is needed when serializing 408 container (<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>, array) types, 409 or POJOs using <code>tabular</code> ("as array") output format. 410<p> 411 Note that this mode of operation is independent of underlying 412 data format; so it is typically NOT called for fully tabular formats such as CSV, 413 where logical output is still as form of POJOs.</div> 414<dl> 415<dt><span class="throwsLabel">Throws:</span></dt> 416<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> 417</dl> 418</li> 419</ul> 420<a name="serializeAsPlaceholder-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-"> 421<!-- --> 422</a> 423<ul class="blockList"> 424<li class="blockList"> 425<h4>serializeAsPlaceholder</h4> 426<pre>public abstract void serializeAsPlaceholder(<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> value, 427 com.fasterxml.jackson.core.JsonGenerator jgen, 428 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 429 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 430<div class="block">Serialization method called when doing tabular (positional) output from databind, 431 but then value is to be omitted. This requires output of a placeholder value 432 of some sort; often similar to <a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsOmittedField-java.lang.Object-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-"><code>serializeAsOmittedField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)</code></a>.</div> 433<dl> 434<dt><span class="throwsLabel">Throws:</span></dt> 435<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> 436</dl> 437</li> 438</ul> 439<a name="depositSchemaProperty-com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor-"> 440<!-- --> 441</a> 442<ul class="blockList"> 443<li class="blockList"> 444<h4>depositSchemaProperty</h4> 445<pre>public abstract void depositSchemaProperty(<a href="../../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor) 446 throws <a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 447<div class="block">Traversal method used for things like JSON Schema generation, or 448 POJO introspection.</div> 449<dl> 450<dt><span class="throwsLabel">Throws:</span></dt> 451<dd><code><a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd> 452</dl> 453</li> 454</ul> 455<a name="depositSchemaProperty-com.fasterxml.jackson.databind.node.ObjectNode-com.fasterxml.jackson.databind.SerializerProvider-"> 456<!-- --> 457</a> 458<ul class="blockListLast"> 459<li class="blockList"> 460<h4>depositSchemaProperty</h4> 461<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 462public abstract void depositSchemaProperty(<a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> propertiesNode, 463 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 464 throws <a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 465<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Since 2.2</span></div> 466<div class="block">Legacy method called for JSON Schema generation; should not be called by new code</div> 467<dl> 468<dt><span class="throwsLabel">Throws:</span></dt> 469<dd><code><a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd> 470</dl> 471</li> 472</ul> 473</li> 474</ul> 475</li> 476</ul> 477</div> 478</div> 479<!-- ========= END OF CLASS DATA ========= --> 480<!-- ======= START OF BOTTOM NAVBAR ====== --> 481<div class="bottomNav"><a name="navbar.bottom"> 482<!-- --> 483</a> 484<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 485<a name="navbar.bottom.firstrow"> 486<!-- --> 487</a> 488<ul class="navList" title="Navigation"> 489<li><a href="../../../../../overview-summary.html">Overview</a></li> 490<li><a href="package-summary.html">Package</a></li> 491<li class="navBarCell1Rev">Class</li> 492<li><a href="class-use/PropertyWriter.html">Use</a></li> 493<li><a href="package-tree.html">Tree</a></li> 494<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 495<li><a href="../../../../../index-all.html">Index</a></li> 496<li><a href="../../../../../help-doc.html">Help</a></li> 497</ul> 498</div> 499<div class="subNav"> 500<ul class="navList"> 501<li><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="typeNameLink">Prev Class</span></a></li> 502<li><a href="../../../../../com/fasterxml/jackson/databind/ser/ResolvableSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="typeNameLink">Next Class</span></a></li> 503</ul> 504<ul class="navList"> 505<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/ser/PropertyWriter.html" target="_top">Frames</a></li> 506<li><a href="PropertyWriter.html" target="_top">No Frames</a></li> 507</ul> 508<ul class="navList" id="allclasses_navbar_bottom"> 509<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 510</ul> 511<div> 512<script type="text/javascript"><!-- 513 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 514 if(window==top) { 515 allClassesLink.style.display = "block"; 516 } 517 else { 518 allClassesLink.style.display = "none"; 519 } 520 //--> 521</script> 522</div> 523<div> 524<ul class="subNavList"> 525<li>Summary: </li> 526<li>Nested | </li> 527<li>Field | </li> 528<li><a href="#constructor.summary">Constr</a> | </li> 529<li><a href="#method.summary">Method</a></li> 530</ul> 531<ul class="subNavList"> 532<li>Detail: </li> 533<li>Field | </li> 534<li><a href="#constructor.detail">Constr</a> | </li> 535<li><a href="#method.detail">Method</a></li> 536</ul> 537</div> 538<a name="skip.navbar.bottom"> 539<!-- --> 540</a></div> 541<!-- ======== END OF BOTTOM NAVBAR ======= --> 542<p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 543</body> 544</html> 545