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_79) on Fri Jan 15 20:28:43 PST 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>PropertyWriter (jackson-databind 2.7.0 API)</title> 8<meta name="date" content="2016-01-15"> 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="PropertyWriter (jackson-databind 2.7.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="../../../../../overview-summary.html">Overview</a></li> 29<li><a href="package-summary.html">Package</a></li> 30<li class="navBarCell1Rev">Class</li> 31<li><a href="class-use/PropertyWriter.html">Use</a></li> 32<li><a href="package-tree.html">Tree</a></li> 33<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 34<li><a href="../../../../../index-all.html">Index</a></li> 35<li><a href="../../../../../help-doc.html">Help</a></li> 36</ul> 37</div> 38<div class="subNav"> 39<ul class="navList"> 40<li><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../../com/fasterxml/jackson/databind/ser/ResolvableSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/ser/PropertyWriter.html" target="_top">Frames</a></li> 45<li><a href="PropertyWriter.html" target="_top">No Frames</a></li> 46</ul> 47<ul class="navList" id="allclasses_navbar_top"> 48<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 49</ul> 50<div> 51<script type="text/javascript"><!-- 52 allClassesLink = document.getElementById("allclasses_navbar_top"); 53 if(window==top) { 54 allClassesLink.style.display = "block"; 55 } 56 else { 57 allClassesLink.style.display = "none"; 58 } 59 //--> 60</script> 61</div> 62<div> 63<ul class="subNavList"> 64<li>Summary: </li> 65<li>Nested | </li> 66<li><a href="#fields_inherited_from_class_com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase">Field</a> | </li> 67<li><a href="#constructor_summary">Constr</a> | </li> 68<li><a href="#method_summary">Method</a></li> 69</ul> 70<ul class="subNavList"> 71<li>Detail: </li> 72<li>Field | </li> 73<li><a href="#constructor_detail">Constr</a> | </li> 74<li><a href="#method_detail">Method</a></li> 75</ul> 76</div> 77<a name="skip-navbar_top"> 78<!-- --> 79</a></div> 80<!-- ========= END OF TOP NAVBAR ========= --> 81<!-- ======== START OF CLASS DATA ======== --> 82<div class="header"> 83<div class="subTitle">com.fasterxml.jackson.databind.ser</div> 84<h2 title="Class PropertyWriter" class="title">Class PropertyWriter</h2> 85</div> 86<div class="contentContainer"> 87<ul class="inheritance"> 88<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 89<li> 90<ul class="inheritance"> 91<li><a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html" title="class in com.fasterxml.jackson.databind.introspect">com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase</a></li> 92<li> 93<ul class="inheritance"> 94<li>com.fasterxml.jackson.databind.ser.PropertyWriter</li> 95</ul> 96</li> 97</ul> 98</li> 99</ul> 100<div class="description"> 101<ul class="blockList"> 102<li class="blockList"> 103<dl> 104<dt>All Implemented Interfaces:</dt> 105<dd><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a>, <a href="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> 106</dl> 107<dl> 108<dt>Direct Known Subclasses:</dt> 109<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> 110</dl> 111<hr> 112<br> 113<pre>public abstract class <span class="strong">PropertyWriter</span> 114extends <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html" title="class in com.fasterxml.jackson.databind.introspect">ConcreteBeanPropertyBase</a> 115implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> 116<div class="block">Base class for writers used to output property values (name-value pairs) 117 as key/value pairs via streaming API. This is the most generic abstraction 118 implemented by both POJO and <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> serializers, and invoked 119 by filtering functionality.</div> 120<dl><dt><span class="strong">Since:</span></dt> 121 <dd>2.3</dd> 122<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#com.fasterxml.jackson.databind.ser.PropertyWriter">Serialized Form</a></dd></dl> 123</li> 124</ul> 125</div> 126<div class="summary"> 127<ul class="blockList"> 128<li class="blockList"> 129<!-- ======== NESTED CLASS SUMMARY ======== --> 130<ul class="blockList"> 131<li class="blockList"><a name="nested_class_summary"> 132<!-- --> 133</a> 134<h3>Nested Class Summary</h3> 135<ul class="blockList"> 136<li class="blockList"><a name="nested_classes_inherited_from_class_com.fasterxml.jackson.databind.BeanProperty"> 137<!-- --> 138</a> 139<h3>Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.<a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></h3> 140<code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></code></li> 141</ul> 142</li> 143</ul> 144<!-- =========== FIELD SUMMARY =========== --> 145<ul class="blockList"> 146<li class="blockList"><a name="field_summary"> 147<!-- --> 148</a> 149<h3>Field Summary</h3> 150<ul class="blockList"> 151<li class="blockList"><a name="fields_inherited_from_class_com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase"> 152<!-- --> 153</a> 154<h3>Fields inherited from class com.fasterxml.jackson.databind.introspect.<a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html" title="class in com.fasterxml.jackson.databind.introspect">ConcreteBeanPropertyBase</a></h3> 155<code><a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#_format">_format</a>, <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#_metadata">_metadata</a></code></li> 156</ul> 157<ul class="blockList"> 158<li class="blockList"><a name="fields_inherited_from_class_com.fasterxml.jackson.databind.BeanProperty"> 159<!-- --> 160</a> 161<h3>Fields inherited from interface com.fasterxml.jackson.databind.<a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></h3> 162<code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#EMPTY_FORMAT">EMPTY_FORMAT</a>, <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#EMPTY_INCLUDE">EMPTY_INCLUDE</a></code></li> 163</ul> 164</li> 165</ul> 166<!-- ======== CONSTRUCTOR SUMMARY ======== --> 167<ul class="blockList"> 168<li class="blockList"><a name="constructor_summary"> 169<!-- --> 170</a> 171<h3>Constructor Summary</h3> 172<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 173<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 174<tr> 175<th class="colFirst" scope="col">Modifier</th> 176<th class="colLast" scope="col">Constructor and Description</th> 177</tr> 178<tr class="altColor"> 179<td class="colFirst"><code>protected </code></td> 180<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#PropertyWriter(com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition)">PropertyWriter</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</a> propDef)</code> </td> 181</tr> 182<tr class="rowColor"> 183<td class="colFirst"><code>protected </code></td> 184<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#PropertyWriter(com.fasterxml.jackson.databind.PropertyMetadata)">PropertyWriter</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> md)</code> </td> 185</tr> 186<tr class="altColor"> 187<td class="colFirst"><code>protected </code></td> 188<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#PropertyWriter(com.fasterxml.jackson.databind.ser.PropertyWriter)">PropertyWriter</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">PropertyWriter</a> base)</code> </td> 189</tr> 190</table> 191</li> 192</ul> 193<!-- ========== METHOD SUMMARY =========== --> 194<ul class="blockList"> 195<li class="blockList"><a name="method_summary"> 196<!-- --> 197</a> 198<h3>Method Summary</h3> 199<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 200<caption><span>Methods</span><span class="tabEnd"> </span></caption> 201<tr> 202<th class="colFirst" scope="col">Modifier and Type</th> 203<th class="colLast" scope="col">Method and Description</th> 204</tr> 205<tr class="altColor"> 206<td class="colFirst"><code>abstract void</code></td> 207<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor,%20com.fasterxml.jackson.databind.SerializerProvider)">depositSchemaProperty</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor, 208 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 209<div class="block">Traversal method used for things like JSON Schema generation, or 210 POJO introspection.</div> 211</td> 212</tr> 213<tr class="rowColor"> 214<td class="colFirst"><code>abstract void</code></td> 215<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#depositSchemaProperty(com.fasterxml.jackson.databind.node.ObjectNode,%20com.fasterxml.jackson.databind.SerializerProvider)">depositSchemaProperty</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> propertiesNode, 216 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 217<div class="block"><strong>Deprecated.</strong> 218<div class="block"><i>Since 2.2</i></div> 219</div> 220</td> 221</tr> 222<tr class="altColor"> 223<td class="colFirst"><code><A extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> <br>A</code></td> 224<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#findAnnotation(java.lang.Class)">findAnnotation</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 225<div class="block">Convenience method for accessing annotation that may be associated 226 either directly on property, or, if not, via enclosing class (context).</div> 227</td> 228</tr> 229<tr class="rowColor"> 230<td class="colFirst"><code>abstract <A extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> <br>A</code></td> 231<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getAnnotation(java.lang.Class)">getAnnotation</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 232<div class="block">Method for accessing annotations directly declared for property that this 233 writer is associated with.</div> 234</td> 235</tr> 236<tr class="altColor"> 237<td class="colFirst"><code>abstract <A extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> <br>A</code></td> 238<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 239<div class="block">Method for accessing annotations declared in context of the property that this 240 writer is associated with; usually this means annotations on enclosing class 241 for property.</div> 242</td> 243</tr> 244<tr class="rowColor"> 245<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 246<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getFullName()">getFullName</a></strong>()</code> 247<div class="block">Method for getting full name definition, including possible 248 format-specific additional properties (such as namespace when 249 using XML backend).</div> 250</td> 251</tr> 252<tr class="altColor"> 253<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 254<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#getName()">getName</a></strong>()</code> 255<div class="block">Method to get logical name of the property</div> 256</td> 257</tr> 258<tr class="rowColor"> 259<td class="colFirst"><code>abstract void</code></td> 260<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsElement(java.lang.Object,%20com.fasterxml.jackson.core.JsonGenerator,%20com.fasterxml.jackson.databind.SerializerProvider)">serializeAsElement</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 261 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 262 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 263<div class="block">Serialization method called when output is to be done as an array, 264 that is, not using property names.</div> 265</td> 266</tr> 267<tr class="altColor"> 268<td class="colFirst"><code>abstract void</code></td> 269<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsField(java.lang.Object,%20com.fasterxml.jackson.core.JsonGenerator,%20com.fasterxml.jackson.databind.SerializerProvider)">serializeAsField</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 270 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 271 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 272<div class="block">The main serialization method called by filter when property is to be written normally.</div> 273</td> 274</tr> 275<tr class="rowColor"> 276<td class="colFirst"><code>abstract void</code></td> 277<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsOmittedField(java.lang.Object,%20com.fasterxml.jackson.core.JsonGenerator,%20com.fasterxml.jackson.databind.SerializerProvider)">serializeAsOmittedField</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 278 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 279 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 280<div class="block">Serialization method that filter needs to call in cases where property is to be 281 filtered, but the underlying data format requires a placeholder of some kind.</div> 282</td> 283</tr> 284<tr class="altColor"> 285<td class="colFirst"><code>abstract void</code></td> 286<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsPlaceholder(java.lang.Object,%20com.fasterxml.jackson.core.JsonGenerator,%20com.fasterxml.jackson.databind.SerializerProvider)">serializeAsPlaceholder</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 287 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 288 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 289<div class="block">Serialization method called when doing tabular (positional) output from databind, 290 but then value is to be omitted.</div> 291</td> 292</tr> 293</table> 294<ul class="blockList"> 295<li class="blockList"><a name="methods_inherited_from_class_com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase"> 296<!-- --> 297</a> 298<h3>Methods inherited from class com.fasterxml.jackson.databind.introspect.<a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html" title="class in com.fasterxml.jackson.databind.introspect">ConcreteBeanPropertyBase</a></h3> 299<code><a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#findFormatOverrides(com.fasterxml.jackson.databind.AnnotationIntrospector)">findFormatOverrides</a>, <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)">findPropertyFormat</a>, <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#findPropertyInclusion(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)">findPropertyInclusion</a>, <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#getMetadata()">getMetadata</a>, <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#isRequired()">isRequired</a>, <a href="../../../../../com/fasterxml/jackson/databind/introspect/ConcreteBeanPropertyBase.html#isVirtual()">isVirtual</a></code></li> 300</ul> 301<ul class="blockList"> 302<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 303<!-- --> 304</a> 305<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 306<code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> 307</ul> 308<ul class="blockList"> 309<li class="blockList"><a name="methods_inherited_from_class_com.fasterxml.jackson.databind.BeanProperty"> 310<!-- --> 311</a> 312<h3>Methods inherited from interface com.fasterxml.jackson.databind.<a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></h3> 313<code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">getMember</a>, <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">getType</a>, <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">getWrapperName</a></code></li> 314</ul> 315</li> 316</ul> 317</li> 318</ul> 319</div> 320<div class="details"> 321<ul class="blockList"> 322<li class="blockList"> 323<!-- ========= CONSTRUCTOR DETAIL ======== --> 324<ul class="blockList"> 325<li class="blockList"><a name="constructor_detail"> 326<!-- --> 327</a> 328<h3>Constructor Detail</h3> 329<a name="PropertyWriter(com.fasterxml.jackson.databind.PropertyMetadata)"> 330<!-- --> 331</a> 332<ul class="blockList"> 333<li class="blockList"> 334<h4>PropertyWriter</h4> 335<pre>protected PropertyWriter(<a href="../../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> md)</pre> 336</li> 337</ul> 338<a name="PropertyWriter(com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition)"> 339<!-- --> 340</a> 341<ul class="blockList"> 342<li class="blockList"> 343<h4>PropertyWriter</h4> 344<pre>protected PropertyWriter(<a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</a> propDef)</pre> 345</li> 346</ul> 347<a name="PropertyWriter(com.fasterxml.jackson.databind.ser.PropertyWriter)"> 348<!-- --> 349</a> 350<ul class="blockListLast"> 351<li class="blockList"> 352<h4>PropertyWriter</h4> 353<pre>protected PropertyWriter(<a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">PropertyWriter</a> base)</pre> 354</li> 355</ul> 356</li> 357</ul> 358<!-- ============ METHOD DETAIL ========== --> 359<ul class="blockList"> 360<li class="blockList"><a name="method_detail"> 361<!-- --> 362</a> 363<h3>Method Detail</h3> 364<a name="getName()"> 365<!-- --> 366</a> 367<ul class="blockList"> 368<li class="blockList"> 369<h4>getName</h4> 370<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> 371<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">BeanProperty</a></code></strong></div> 372<div class="block">Method to get logical name of the property</div> 373<dl> 374<dt><strong>Specified by:</strong></dt> 375<dd><code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">getName</a></code> in interface <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 376<dt><strong>Specified by:</strong></dt> 377<dd><code><a href="../../../../../com/fasterxml/jackson/databind/util/Named.html#getName()">getName</a></code> in interface <code><a href="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></code></dd> 378</dl> 379</li> 380</ul> 381<a name="getFullName()"> 382<!-- --> 383</a> 384<ul class="blockList"> 385<li class="blockList"> 386<h4>getFullName</h4> 387<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getFullName()</pre> 388<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getFullName()">BeanProperty</a></code></strong></div> 389<div class="block">Method for getting full name definition, including possible 390 format-specific additional properties (such as namespace when 391 using XML backend).</div> 392<dl> 393<dt><strong>Specified by:</strong></dt> 394<dd><code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getFullName()">getFullName</a></code> in interface <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 395</dl> 396</li> 397</ul> 398<a name="findAnnotation(java.lang.Class)"> 399<!-- --> 400</a> 401<ul class="blockList"> 402<li class="blockList"> 403<h4>findAnnotation</h4> 404<pre>public <A extends <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 405<div class="block">Convenience method for accessing annotation that may be associated 406 either directly on property, or, if not, via enclosing class (context). 407 This allows adding baseline contextual annotations, for example, by adding 408 an annotation for a given class and making that apply to all properties 409 unless overridden by per-property annotations. 410<p> 411 This method is functionally equivalent to: 412<pre> 413 MyAnnotation ann = propWriter.getAnnotation(MyAnnotation.class); 414 if (ann == null) { 415 ann = propWriter.getContextAnnotation(MyAnnotation.class); 416 } 417</pre> 418 that is, tries to find a property annotation first, but if one is not 419 found, tries to find context-annotation (from enclosing class) of 420 same type.</div> 421<dl><dt><span class="strong">Since:</span></dt> 422 <dd>2.5</dd></dl> 423</li> 424</ul> 425<a name="getAnnotation(java.lang.Class)"> 426<!-- --> 427</a> 428<ul class="blockList"> 429<li class="blockList"> 430<h4>getAnnotation</h4> 431<pre>public abstract <A extends <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 432<div class="block">Method for accessing annotations directly declared for property that this 433 writer is associated with.</div> 434<dl> 435<dt><strong>Specified by:</strong></dt> 436<dd><code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">getAnnotation</a></code> in interface <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 437<dt><span class="strong">Since:</span></dt> 438 <dd>2.5</dd></dl> 439</li> 440</ul> 441<a name="getContextAnnotation(java.lang.Class)"> 442<!-- --> 443</a> 444<ul class="blockList"> 445<li class="blockList"> 446<h4>getContextAnnotation</h4> 447<pre>public abstract <A extends <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 448<div class="block">Method for accessing annotations declared in context of the property that this 449 writer is associated with; usually this means annotations on enclosing class 450 for property.</div> 451<dl> 452<dt><strong>Specified by:</strong></dt> 453<dd><code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</a></code> in interface <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 454<dt><span class="strong">Since:</span></dt> 455 <dd>2.5</dd></dl> 456</li> 457</ul> 458<a name="serializeAsField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)"> 459<!-- --> 460</a> 461<ul class="blockList"> 462<li class="blockList"> 463<h4>serializeAsField</h4> 464<pre>public abstract void serializeAsField(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 465 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 466 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 467 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 468<div class="block">The main serialization method called by filter when property is to be written normally.</div> 469<dl><dt><span class="strong">Throws:</span></dt> 470<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> 471</li> 472</ul> 473<a name="serializeAsOmittedField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)"> 474<!-- --> 475</a> 476<ul class="blockList"> 477<li class="blockList"> 478<h4>serializeAsOmittedField</h4> 479<pre>public abstract void serializeAsOmittedField(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 480 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 481 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 482 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 483<div class="block">Serialization method that filter needs to call in cases where property is to be 484 filtered, but the underlying data format requires a placeholder of some kind. 485 This is usually the case for tabular (positional) data formats such as CSV.</div> 486<dl><dt><span class="strong">Throws:</span></dt> 487<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> 488</li> 489</ul> 490<a name="serializeAsElement(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)"> 491<!-- --> 492</a> 493<ul class="blockList"> 494<li class="blockList"> 495<h4>serializeAsElement</h4> 496<pre>public abstract void serializeAsElement(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 497 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 498 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 499 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 500<div class="block">Serialization method called when output is to be done as an array, 501 that is, not using property names. This is needed when serializing 502 container (<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>, array) types, 503 or POJOs using <code>tabular</code> ("as array") output format. 504<p> 505 Note that this mode of operation is independent of underlying 506 data format; so it is typically NOT called for fully tabular formats such as CSV, 507 where logical output is still as form of POJOs.</div> 508<dl><dt><span class="strong">Throws:</span></dt> 509<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> 510</li> 511</ul> 512<a name="serializeAsPlaceholder(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)"> 513<!-- --> 514</a> 515<ul class="blockList"> 516<li class="blockList"> 517<h4>serializeAsPlaceholder</h4> 518<pre>public abstract void serializeAsPlaceholder(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value, 519 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonGenerator</a> jgen, 520 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 521 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> 522<div class="block">Serialization method called when doing tabular (positional) output from databind, 523 but then value is to be omitted. This requires output of a placeholder value 524 of some sort; often similar to <a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html#serializeAsOmittedField(java.lang.Object,%20com.fasterxml.jackson.core.JsonGenerator,%20com.fasterxml.jackson.databind.SerializerProvider)"><code>serializeAsOmittedField(java.lang.Object, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider)</code></a>.</div> 525<dl><dt><span class="strong">Throws:</span></dt> 526<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl> 527</li> 528</ul> 529<a name="depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor, com.fasterxml.jackson.databind.SerializerProvider)"> 530<!-- --> 531</a> 532<ul class="blockList"> 533<li class="blockList"> 534<h4>depositSchemaProperty</h4> 535<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, 536 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 537 throws <a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 538<div class="block">Traversal method used for things like JSON Schema generation, or 539 POJO introspection.</div> 540<dl> 541<dt><strong>Specified by:</strong></dt> 542<dd><code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html#depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor,%20com.fasterxml.jackson.databind.SerializerProvider)">depositSchemaProperty</a></code> in interface <code><a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 543<dt><span class="strong">Parameters:</span></dt><dd><code>objectVisitor</code> - Visitor to used as the callback handler</dd> 544<dt><span class="strong">Throws:</span></dt> 545<dd><code><a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd></dl> 546</li> 547</ul> 548<a name="depositSchemaProperty(com.fasterxml.jackson.databind.node.ObjectNode, com.fasterxml.jackson.databind.SerializerProvider)"> 549<!-- --> 550</a> 551<ul class="blockListLast"> 552<li class="blockList"> 553<h4>depositSchemaProperty</h4> 554<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 555public abstract void depositSchemaProperty(<a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> propertiesNode, 556 <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 557 throws <a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 558<div class="block"><span class="strong">Deprecated.</span> <i>Since 2.2</i></div> 559<div class="block">Legacy method called for JSON Schema generation; should not be called by new code</div> 560<dl><dt><span class="strong">Throws:</span></dt> 561<dd><code><a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd></dl> 562</li> 563</ul> 564</li> 565</ul> 566</li> 567</ul> 568</div> 569</div> 570<!-- ========= END OF CLASS DATA ========= --> 571<!-- ======= START OF BOTTOM NAVBAR ====== --> 572<div class="bottomNav"><a name="navbar_bottom"> 573<!-- --> 574</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 575<!-- --> 576</a> 577<ul class="navList" title="Navigation"> 578<li><a href="../../../../../overview-summary.html">Overview</a></li> 579<li><a href="package-summary.html">Package</a></li> 580<li class="navBarCell1Rev">Class</li> 581<li><a href="class-use/PropertyWriter.html">Use</a></li> 582<li><a href="package-tree.html">Tree</a></li> 583<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 584<li><a href="../../../../../index-all.html">Index</a></li> 585<li><a href="../../../../../help-doc.html">Help</a></li> 586</ul> 587</div> 588<div class="subNav"> 589<ul class="navList"> 590<li><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="strong">Prev Class</span></a></li> 591<li><a href="../../../../../com/fasterxml/jackson/databind/ser/ResolvableSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><span class="strong">Next Class</span></a></li> 592</ul> 593<ul class="navList"> 594<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/ser/PropertyWriter.html" target="_top">Frames</a></li> 595<li><a href="PropertyWriter.html" target="_top">No Frames</a></li> 596</ul> 597<ul class="navList" id="allclasses_navbar_bottom"> 598<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 599</ul> 600<div> 601<script type="text/javascript"><!-- 602 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 603 if(window==top) { 604 allClassesLink.style.display = "block"; 605 } 606 else { 607 allClassesLink.style.display = "none"; 608 } 609 //--> 610</script> 611</div> 612<div> 613<ul class="subNavList"> 614<li>Summary: </li> 615<li>Nested | </li> 616<li><a href="#fields_inherited_from_class_com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase">Field</a> | </li> 617<li><a href="#constructor_summary">Constr</a> | </li> 618<li><a href="#method_summary">Method</a></li> 619</ul> 620<ul class="subNavList"> 621<li>Detail: </li> 622<li>Field | </li> 623<li><a href="#constructor_detail">Constr</a> | </li> 624<li><a href="#method_detail">Method</a></li> 625</ul> 626</div> 627<a name="skip-navbar_bottom"> 628<!-- --> 629</a></div> 630<!-- ======== END OF BOTTOM NAVBAR ======= --> 631<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 632</body> 633</html> 634