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 Wed Jul 20 08:39:08 PDT 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>BeanProperty (jackson-databind 2.8.0 API)</title> 8<meta name="date" content="2016-07-20"> 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="BeanProperty (jackson-databind 2.8.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/BeanProperty.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/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top">Frames</a></li> 45<li><a href="BeanProperty.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><a href="#nested_class_summary">Nested</a> | </li> 66<li><a href="#field_summary">Field</a> | </li> 67<li>Constr | </li> 68<li><a href="#method_summary">Method</a></li> 69</ul> 70<ul class="subNavList"> 71<li>Detail: </li> 72<li><a href="#field_detail">Field</a> | </li> 73<li>Constr | </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</div> 84<h2 title="Interface BeanProperty" class="title">Interface BeanProperty</h2> 85</div> 86<div class="contentContainer"> 87<div class="description"> 88<ul class="blockList"> 89<li class="blockList"> 90<dl> 91<dt>All Superinterfaces:</dt> 92<dd><a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></dd> 93</dl> 94<dl> 95<dt>All Known Implementing Classes:</dt> 96<dd><a href="../../../../com/fasterxml/jackson/databind/ser/impl/AttributePropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser.impl">AttributePropertyWriter</a>, <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a>, <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/introspect/ConcreteBeanPropertyBase.html" title="class in com.fasterxml.jackson.databind.introspect">ConcreteBeanPropertyBase</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/CreatorProperty.html" title="class in com.fasterxml.jackson.databind.deser">CreatorProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/FieldProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">FieldProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/InnerClassProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">InnerClassProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ManagedReferenceProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">ManagedReferenceProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/ser/std/MapProperty.html" title="class in com.fasterxml.jackson.databind.ser.std">MapProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/MethodProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">MethodProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ObjectIdReferenceProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">ObjectIdReferenceProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ObjectIdValueProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">ObjectIdValueProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">PropertyWriter</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/SettableBeanProperty.html" title="class in com.fasterxml.jackson.databind.deser">SettableBeanProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/SetterlessProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">SetterlessProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/ser/impl/UnwrappingBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser.impl">UnwrappingBeanPropertyWriter</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ValueInjector.html" title="class in com.fasterxml.jackson.databind.deser.impl">ValueInjector</a>, <a href="../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a></dd> 97</dl> 98<hr> 99<br> 100<pre>public interface <span class="strong">BeanProperty</span> 101extends <a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></pre> 102<div class="block">Bean properties are logical entities that represent data 103 that Java objects (POJOs (Plain Old Java Objects), sometimes also called "beans") 104 contain; and that are accessed using accessors (methods like getters 105 and setters, fields, constructor parametrers). 106 Instances allow access to annotations directly associated 107 to property (via field or method), as well as contextual 108 annotations (annotations for class that contains properties). 109<p> 110 Instances are not typically passed when constructing serializers 111 and deserializers, but rather only passed when context 112 is known when 113 <a href="../../../../com/fasterxml/jackson/databind/ser/ContextualSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><code>ContextualSerializer</code></a> and 114 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a> 115 resolution occurs (<code>createContextual(...)</code> method is called). 116 References may (need to) be retained by serializers and deserializers, 117 especially when further resolving dependant handlers like value 118 serializers/deserializers or structured types.</div> 119</li> 120</ul> 121</div> 122<div class="summary"> 123<ul class="blockList"> 124<li class="blockList"> 125<!-- ======== NESTED CLASS SUMMARY ======== --> 126<ul class="blockList"> 127<li class="blockList"><a name="nested_class_summary"> 128<!-- --> 129</a> 130<h3>Nested Class Summary</h3> 131<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 132<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 133<tr> 134<th class="colFirst" scope="col">Modifier and Type</th> 135<th class="colLast" scope="col">Interface and Description</th> 136</tr> 137<tr class="altColor"> 138<td class="colFirst"><code>static class </code></td> 139<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></strong></code> 140<div class="block">Simple stand-alone implementation, useful as a placeholder 141 or base class for more complex implementations.</div> 142</td> 143</tr> 144</table> 145</li> 146</ul> 147<!-- =========== FIELD SUMMARY =========== --> 148<ul class="blockList"> 149<li class="blockList"><a name="field_summary"> 150<!-- --> 151</a> 152<h3>Field Summary</h3> 153<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 154<caption><span>Fields</span><span class="tabEnd"> </span></caption> 155<tr> 156<th class="colFirst" scope="col">Modifier and Type</th> 157<th class="colLast" scope="col">Field and Description</th> 158</tr> 159<tr class="altColor"> 160<td class="colFirst"><code>static <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a></code></td> 161<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#EMPTY_FORMAT">EMPTY_FORMAT</a></strong></code> </td> 162</tr> 163<tr class="rowColor"> 164<td class="colFirst"><code>static <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a></code></td> 165<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#EMPTY_INCLUDE">EMPTY_INCLUDE</a></strong></code> </td> 166</tr> 167</table> 168</li> 169</ul> 170<!-- ========== METHOD SUMMARY =========== --> 171<ul class="blockList"> 172<li class="blockList"><a name="method_summary"> 173<!-- --> 174</a> 175<h3>Method Summary</h3> 176<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 177<caption><span>Methods</span><span class="tabEnd"> </span></caption> 178<tr> 179<th class="colFirst" scope="col">Modifier and Type</th> 180<th class="colLast" scope="col">Method and Description</th> 181</tr> 182<tr class="altColor"> 183<td class="colFirst"><code>void</code></td> 184<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.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, 185 <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> 186<div class="block">Method that can be called to visit the type structure that this 187 property is part of.</div> 188</td> 189</tr> 190<tr class="rowColor"> 191<td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a></code></td> 192<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findFormatOverrides(com.fasterxml.jackson.databind.AnnotationIntrospector)">findFormatOverrides</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector</a> intr)</code> 193<div class="block"><strong>Deprecated.</strong> 194<div class="block"><i>since 2.8 use <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)"><code>findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)</code></a> instead.</i></div> 195</div> 196</td> 197</tr> 198<tr class="altColor"> 199<td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a></code></td> 200<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)">findPropertyFormat</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, 201 <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><?> baseType)</code> 202<div class="block">Helper method used to look up format settings applicable to this property, 203 considering both possible per-type configuration settings</div> 204</td> 205</tr> 206<tr class="rowColor"> 207<td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a></code></td> 208<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyInclusion(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)">findPropertyInclusion</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, 209 <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><?> baseType)</code> 210<div class="block">Convenience method that is roughly equivalent to</div> 211</td> 212</tr> 213<tr class="altColor"> 214<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> 215<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.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> 216<div class="block">Method for finding annotation associated with this property; 217 meaning annotation associated with one of entities used to 218 access property.</div> 219</td> 220</tr> 221<tr class="rowColor"> 222<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> 223<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.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> 224<div class="block">Method for finding annotation associated with context of 225 this property; usually class in which member is declared 226 (or its subtype if processing subtype).</div> 227</td> 228</tr> 229<tr class="altColor"> 230<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 231<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getFullName()">getFullName</a></strong>()</code> 232<div class="block">Method for getting full name definition, including possible 233 format-specific additional properties (such as namespace when 234 using XML backend).</div> 235</td> 236</tr> 237<tr class="rowColor"> 238<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td> 239<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">getMember</a></strong>()</code> 240<div class="block">Method for accessing primary physical entity that represents the property; 241 annotated field, method or constructor property.</div> 242</td> 243</tr> 244<tr class="altColor"> 245<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></code></td> 246<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMetadata()">getMetadata</a></strong>()</code> 247<div class="block">Accessor for additional optional information about property.</div> 248</td> 249</tr> 250<tr class="rowColor"> 251<td class="colFirst"><code><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> 252<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">getName</a></strong>()</code> 253<div class="block">Method to get logical name of the property</div> 254</td> 255</tr> 256<tr class="altColor"> 257<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 258<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">getType</a></strong>()</code> 259<div class="block">Method to get declared type of the property.</div> 260</td> 261</tr> 262<tr class="rowColor"> 263<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 264<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">getWrapperName</a></strong>()</code> 265<div class="block">If property is indicated to be wrapped, name of 266 wrapper element to use.</div> 267</td> 268</tr> 269<tr class="altColor"> 270<td class="colFirst"><code>boolean</code></td> 271<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired()">isRequired</a></strong>()</code> 272<div class="block">Whether value for property is marked as required using 273 annotations or associated schema.</div> 274</td> 275</tr> 276<tr class="rowColor"> 277<td class="colFirst"><code>boolean</code></td> 278<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isVirtual()">isVirtual</a></strong>()</code> 279<div class="block">Accessor for checking whether there is an actual physical property 280 behind this property abstraction or not.</div> 281</td> 282</tr> 283</table> 284</li> 285</ul> 286</li> 287</ul> 288</div> 289<div class="details"> 290<ul class="blockList"> 291<li class="blockList"> 292<!-- ============ FIELD DETAIL =========== --> 293<ul class="blockList"> 294<li class="blockList"><a name="field_detail"> 295<!-- --> 296</a> 297<h3>Field Detail</h3> 298<a name="EMPTY_FORMAT"> 299<!-- --> 300</a> 301<ul class="blockList"> 302<li class="blockList"> 303<h4>EMPTY_FORMAT</h4> 304<pre>static final <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a> EMPTY_FORMAT</pre> 305</li> 306</ul> 307<a name="EMPTY_INCLUDE"> 308<!-- --> 309</a> 310<ul class="blockListLast"> 311<li class="blockList"> 312<h4>EMPTY_INCLUDE</h4> 313<pre>static final <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a> EMPTY_INCLUDE</pre> 314</li> 315</ul> 316</li> 317</ul> 318<!-- ============ METHOD DETAIL ========== --> 319<ul class="blockList"> 320<li class="blockList"><a name="method_detail"> 321<!-- --> 322</a> 323<h3>Method Detail</h3> 324<a name="getName()"> 325<!-- --> 326</a> 327<ul class="blockList"> 328<li class="blockList"> 329<h4>getName</h4> 330<pre><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> 331<div class="block">Method to get logical name of the property</div> 332<dl> 333<dt><strong>Specified by:</strong></dt> 334<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> 335</dl> 336</li> 337</ul> 338<a name="getFullName()"> 339<!-- --> 340</a> 341<ul class="blockList"> 342<li class="blockList"> 343<h4>getFullName</h4> 344<pre><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getFullName()</pre> 345<div class="block">Method for getting full name definition, including possible 346 format-specific additional properties (such as namespace when 347 using XML backend).</div> 348<dl><dt><span class="strong">Since:</span></dt> 349 <dd>2.3</dd></dl> 350</li> 351</ul> 352<a name="getType()"> 353<!-- --> 354</a> 355<ul class="blockList"> 356<li class="blockList"> 357<h4>getType</h4> 358<pre><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> getType()</pre> 359<div class="block">Method to get declared type of the property.</div> 360</li> 361</ul> 362<a name="getWrapperName()"> 363<!-- --> 364</a> 365<ul class="blockList"> 366<li class="blockList"> 367<h4>getWrapperName</h4> 368<pre><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getWrapperName()</pre> 369<div class="block">If property is indicated to be wrapped, name of 370 wrapper element to use.</div> 371<dl><dt><span class="strong">Since:</span></dt> 372 <dd>2.2</dd></dl> 373</li> 374</ul> 375<a name="getMetadata()"> 376<!-- --> 377</a> 378<ul class="blockList"> 379<li class="blockList"> 380<h4>getMetadata</h4> 381<pre><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> getMetadata()</pre> 382<div class="block">Accessor for additional optional information about property.</div> 383<dl><dt><span class="strong">Returns:</span></dt><dd>Metadata about property; never null.</dd><dt><span class="strong">Since:</span></dt> 384 <dd>2.3</dd></dl> 385</li> 386</ul> 387<a name="isRequired()"> 388<!-- --> 389</a> 390<ul class="blockList"> 391<li class="blockList"> 392<h4>isRequired</h4> 393<pre>boolean isRequired()</pre> 394<div class="block">Whether value for property is marked as required using 395 annotations or associated schema. 396 Equivalent to: 397<code> 398 getMetadata().isRequired() 399</code></div> 400<dl><dt><span class="strong">Since:</span></dt> 401 <dd>2.2</dd></dl> 402</li> 403</ul> 404<a name="isVirtual()"> 405<!-- --> 406</a> 407<ul class="blockList"> 408<li class="blockList"> 409<h4>isVirtual</h4> 410<pre>boolean isVirtual()</pre> 411<div class="block">Accessor for checking whether there is an actual physical property 412 behind this property abstraction or not.</div> 413<dl><dt><span class="strong">Since:</span></dt> 414 <dd>2.7</dd></dl> 415</li> 416</ul> 417<a name="getAnnotation(java.lang.Class)"> 418<!-- --> 419</a> 420<ul class="blockList"> 421<li class="blockList"> 422<h4>getAnnotation</h4> 423<pre><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> 424<div class="block">Method for finding annotation associated with this property; 425 meaning annotation associated with one of entities used to 426 access property. 427<p> 428 Note that this method should only be called for custom annotations; 429 access to standard Jackson annotations (or ones supported by 430 alternate <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>s) should be accessed 431 through <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>.</div> 432</li> 433</ul> 434<a name="getContextAnnotation(java.lang.Class)"> 435<!-- --> 436</a> 437<ul class="blockList"> 438<li class="blockList"> 439<h4>getContextAnnotation</h4> 440<pre><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> 441<div class="block">Method for finding annotation associated with context of 442 this property; usually class in which member is declared 443 (or its subtype if processing subtype). 444<p> 445 Note that this method should only be called for custom annotations; 446 access to standard Jackson annotations (or ones supported by 447 alternate <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>s) should be accessed 448 through <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>.</div> 449</li> 450</ul> 451<a name="getMember()"> 452<!-- --> 453</a> 454<ul class="blockList"> 455<li class="blockList"> 456<h4>getMember</h4> 457<pre><a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getMember()</pre> 458<div class="block">Method for accessing primary physical entity that represents the property; 459 annotated field, method or constructor property.</div> 460</li> 461</ul> 462<a name="findFormatOverrides(com.fasterxml.jackson.databind.AnnotationIntrospector)"> 463<!-- --> 464</a> 465<ul class="blockList"> 466<li class="blockList"> 467<h4>findFormatOverrides</h4> 468<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> 469<a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a> findFormatOverrides(<a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector</a> intr)</pre> 470<div class="block"><span class="strong">Deprecated.</span> <i>since 2.8 use <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)"><code>findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)</code></a> instead.</i></div> 471<div class="block">Convenience method that is roughly equivalent to 472<pre> 473 return intr.findFormat(getMember()); 474</pre> 475 and specifically does NOT try to find per-type format defaults to merge; 476 use <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig,%20java.lang.Class)"><code>findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)</code></a> if such defaults would be useful.</div> 477<dl><dt><span class="strong">Since:</span></dt> 478 <dd>2.6</dd></dl> 479</li> 480</ul> 481<a name="findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig, java.lang.Class)"> 482<!-- --> 483</a> 484<ul class="blockList"> 485<li class="blockList"> 486<h4>findPropertyFormat</h4> 487<pre><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a> findPropertyFormat(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, 488 <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><?> baseType)</pre> 489<div class="block">Helper method used to look up format settings applicable to this property, 490 considering both possible per-type configuration settings</div> 491<dl><dt><span class="strong">Since:</span></dt> 492 <dd>2.7</dd></dl> 493</li> 494</ul> 495<a name="findPropertyInclusion(com.fasterxml.jackson.databind.cfg.MapperConfig, java.lang.Class)"> 496<!-- --> 497</a> 498<ul class="blockList"> 499<li class="blockList"> 500<h4>findPropertyInclusion</h4> 501<pre><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a> findPropertyInclusion(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, 502 <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><?> baseType)</pre> 503<div class="block">Convenience method that is roughly equivalent to 504<pre> 505 return config.getAnnotationIntrospector().findPropertyInclusion(getMember()); 506</pre> 507 but also considers global default settings for inclusion</div> 508<dl><dt><span class="strong">Since:</span></dt> 509 <dd>2.7</dd></dl> 510</li> 511</ul> 512<a name="depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor, com.fasterxml.jackson.databind.SerializerProvider)"> 513<!-- --> 514</a> 515<ul class="blockListLast"> 516<li class="blockList"> 517<h4>depositSchemaProperty</h4> 518<pre>void depositSchemaProperty(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor, 519 <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) 520 throws <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 521<div class="block">Method that can be called to visit the type structure that this 522 property is part of. 523 Note that not all implementations support traversal with this 524 method; those that do not should throw 525 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>. 526<p> 527 NOTE: Starting with 2.7, takes explicit <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a> 528 argument to reduce the need to rely on provider visitor may or may not 529 have assigned.</div> 530<dl><dt><span class="strong">Parameters:</span></dt><dd><code>objectVisitor</code> - Visitor to used as the callback handler</dd> 531<dt><span class="strong">Throws:</span></dt> 532<dd><code><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd><dt><span class="strong">Since:</span></dt> 533 <dd>2.2 (although signature did change in 2.7)</dd></dl> 534</li> 535</ul> 536</li> 537</ul> 538</li> 539</ul> 540</div> 541</div> 542<!-- ========= END OF CLASS DATA ========= --> 543<!-- ======= START OF BOTTOM NAVBAR ====== --> 544<div class="bottomNav"><a name="navbar_bottom"> 545<!-- --> 546</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 547<!-- --> 548</a> 549<ul class="navList" title="Navigation"> 550<li><a href="../../../../overview-summary.html">Overview</a></li> 551<li><a href="package-summary.html">Package</a></li> 552<li class="navBarCell1Rev">Class</li> 553<li><a href="class-use/BeanProperty.html">Use</a></li> 554<li><a href="package-tree.html">Tree</a></li> 555<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 556<li><a href="../../../../index-all.html">Index</a></li> 557<li><a href="../../../../help-doc.html">Help</a></li> 558</ul> 559</div> 560<div class="subNav"> 561<ul class="navList"> 562<li><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 563<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 564</ul> 565<ul class="navList"> 566<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top">Frames</a></li> 567<li><a href="BeanProperty.html" target="_top">No Frames</a></li> 568</ul> 569<ul class="navList" id="allclasses_navbar_bottom"> 570<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 571</ul> 572<div> 573<script type="text/javascript"><!-- 574 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 575 if(window==top) { 576 allClassesLink.style.display = "block"; 577 } 578 else { 579 allClassesLink.style.display = "none"; 580 } 581 //--> 582</script> 583</div> 584<div> 585<ul class="subNavList"> 586<li>Summary: </li> 587<li><a href="#nested_class_summary">Nested</a> | </li> 588<li><a href="#field_summary">Field</a> | </li> 589<li>Constr | </li> 590<li><a href="#method_summary">Method</a></li> 591</ul> 592<ul class="subNavList"> 593<li>Detail: </li> 594<li><a href="#field_detail">Field</a> | </li> 595<li>Constr | </li> 596<li><a href="#method_detail">Method</a></li> 597</ul> 598</div> 599<a name="skip-navbar_bottom"> 600<!-- --> 601</a></div> 602<!-- ======== END OF BOTTOM NAVBAR ======= --> 603<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 604</body> 605</html> 606