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