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:42 PST 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>BeanPropertyDefinition (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="BeanPropertyDefinition (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/BeanPropertyDefinition.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/introspect/BasicClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" target="_top">Frames</a></li> 45<li><a href="BeanPropertyDefinition.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="#field_summary">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><a href="#field_detail">Field</a> | </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.introspect</div> 84<h2 title="Class BeanPropertyDefinition" class="title">Class BeanPropertyDefinition</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>com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition</li> 92</ul> 93</li> 94</ul> 95<div class="description"> 96<ul class="blockList"> 97<li class="blockList"> 98<dl> 99<dt>All Implemented Interfaces:</dt> 100<dd><a href="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></dd> 101</dl> 102<dl> 103<dt>Direct Known Subclasses:</dt> 104<dd><a href="../../../../../com/fasterxml/jackson/databind/introspect/POJOPropertyBuilder.html" title="class in com.fasterxml.jackson.databind.introspect">POJOPropertyBuilder</a>, <a href="../../../../../com/fasterxml/jackson/databind/util/SimpleBeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.util">SimpleBeanPropertyDefinition</a></dd> 105</dl> 106<hr> 107<br> 108<pre>public abstract class <span class="strong">BeanPropertyDefinition</span> 109extends <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> 110implements <a href="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></pre> 111<div class="block">Simple value classes that contain definitions of properties, 112 used during introspection of properties to use for 113 serialization and deserialization purposes. 114 These instances are created before actual <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><code>BeanProperty</code></a> 115 instances are created, i.e. they are used earlier in the process 116 flow, and are typically use to construct actual 117 <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><code>BeanProperty</code></a> instances.</div> 118</li> 119</ul> 120</div> 121<div class="summary"> 122<ul class="blockList"> 123<li class="blockList"> 124<!-- =========== FIELD SUMMARY =========== --> 125<ul class="blockList"> 126<li class="blockList"><a name="field_summary"> 127<!-- --> 128</a> 129<h3>Field Summary</h3> 130<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 131<caption><span>Fields</span><span class="tabEnd"> </span></caption> 132<tr> 133<th class="colFirst" scope="col">Modifier and Type</th> 134<th class="colLast" scope="col">Field and Description</th> 135</tr> 136<tr class="altColor"> 137<td class="colFirst"><code>protected 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> 138<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#EMPTY_INCLUDE">EMPTY_INCLUDE</a></strong></code> </td> 139</tr> 140</table> 141</li> 142</ul> 143<!-- ======== CONSTRUCTOR SUMMARY ======== --> 144<ul class="blockList"> 145<li class="blockList"><a name="constructor_summary"> 146<!-- --> 147</a> 148<h3>Constructor Summary</h3> 149<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 150<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 151<tr> 152<th class="colOne" scope="col">Constructor and Description</th> 153</tr> 154<tr class="altColor"> 155<td class="colOne"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#BeanPropertyDefinition()">BeanPropertyDefinition</a></strong>()</code> </td> 156</tr> 157</table> 158</li> 159</ul> 160<!-- ========== METHOD SUMMARY =========== --> 161<ul class="blockList"> 162<li class="blockList"><a name="method_summary"> 163<!-- --> 164</a> 165<h3>Method Summary</h3> 166<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 167<caption><span>Methods</span><span class="tabEnd"> </span></caption> 168<tr> 169<th class="colFirst" scope="col">Modifier and Type</th> 170<th class="colLast" scope="col">Method and Description</th> 171</tr> 172<tr class="altColor"> 173<td class="colFirst"><code>boolean</code></td> 174<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#couldDeserialize()">couldDeserialize</a></strong>()</code> </td> 175</tr> 176<tr class="rowColor"> 177<td class="colFirst"><code>boolean</code></td> 178<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#couldSerialize()">couldSerialize</a></strong>()</code> </td> 179</tr> 180<tr class="altColor"> 181<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> 182<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findInclusion()">findInclusion</a></strong>()</code> 183<div class="block">Method used to check if this property has specific inclusion override 184 associated with it or not.</div> 185</td> 186</tr> 187<tr class="rowColor"> 188<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/introspect/ObjectIdInfo.html" title="class in com.fasterxml.jackson.databind.introspect">ObjectIdInfo</a></code></td> 189<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findObjectIdInfo()">findObjectIdInfo</a></strong>()</code> 190<div class="block">Method used to check whether this logical property indicates that 191 value POJOs should be written using additional Object Identifier 192 (or, when multiple references exist, all but first AS Object Identifier).</div> 193</td> 194</tr> 195<tr class="altColor"> 196<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</a></code></td> 197<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findReferenceType()">findReferenceType</a></strong>()</code> 198<div class="block">Method used to find whether property is part of a bi-directional 199 reference.</div> 200</td> 201</tr> 202<tr class="rowColor"> 203<td class="colFirst"><code><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><?>[]</code></td> 204<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findViews()">findViews</a></strong>()</code> 205<div class="block">Method used to find View-inclusion definitions for the property.</div> 206</td> 207</tr> 208<tr class="altColor"> 209<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td> 210<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getAccessor()">getAccessor</a></strong>()</code> 211<div class="block">Method used to find accessor (getter, field to access) to use for accessing 212 value of the property.</div> 213</td> 214</tr> 215<tr class="rowColor"> 216<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</a></code></td> 217<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getConstructorParameter()">getConstructorParameter</a></strong>()</code> </td> 218</tr> 219<tr class="altColor"> 220<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</a>></code></td> 221<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getConstructorParameters()">getConstructorParameters</a></strong>()</code> 222<div class="block">Additional method that may be called instead of <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getConstructorParameter()"><code>getConstructorParameter()</code></a> 223 to get access to all constructor parameters, not just the highest priority one.</div> 224</td> 225</tr> 226<tr class="rowColor"> 227<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedField.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedField</a></code></td> 228<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getField()">getField</a></strong>()</code> </td> 229</tr> 230<tr class="altColor"> 231<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 232<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getFullName()">getFullName</a></strong>()</code> </td> 233</tr> 234<tr class="rowColor"> 235<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</a></code></td> 236<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getGetter()">getGetter</a></strong>()</code> </td> 237</tr> 238<tr class="altColor"> 239<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> 240<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getInternalName()">getInternalName</a></strong>()</code> 241<div class="block">Accessor that can be used to determine implicit name from underlying 242 element(s) before possible renaming.</div> 243</td> 244</tr> 245<tr class="rowColor"> 246<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></code></td> 247<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getMetadata()">getMetadata</a></strong>()</code> 248<div class="block">Method for accessing additional metadata.</div> 249</td> 250</tr> 251<tr class="altColor"> 252<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td> 253<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getMutator()">getMutator</a></strong>()</code> 254<div class="block">Method used to find mutator (constructor parameter, setter, field) to use for 255 changing value of the property.</div> 256</td> 257</tr> 258<tr class="rowColor"> 259<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> 260<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()">getName</a></strong>()</code> 261<div class="block">Accessor for name used for external representation (in JSON).</div> 262</td> 263</tr> 264<tr class="altColor"> 265<td class="colFirst"><code>abstract <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><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getNonConstructorMutator()">getNonConstructorMutator</a></strong>()</code> </td> 267</tr> 268<tr class="rowColor"> 269<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td> 270<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getPrimaryMember()">getPrimaryMember</a></strong>()</code> 271<div class="block">Method used to find the property member (getter, setter, field) that has 272 the highest precedence in current context (getter method when serializing, 273 if available, and so forth), if any.</div> 274</td> 275</tr> 276<tr class="altColor"> 277<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</a></code></td> 278<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getSetter()">getSetter</a></strong>()</code> </td> 279</tr> 280<tr class="rowColor"> 281<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 282<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getWrapperName()">getWrapperName</a></strong>()</code> 283<div class="block">Accessor for finding wrapper name to use for property (if any).</div> 284</td> 285</tr> 286<tr class="altColor"> 287<td class="colFirst"><code>abstract boolean</code></td> 288<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasConstructorParameter()">hasConstructorParameter</a></strong>()</code> </td> 289</tr> 290<tr class="rowColor"> 291<td class="colFirst"><code>abstract boolean</code></td> 292<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasField()">hasField</a></strong>()</code> </td> 293</tr> 294<tr class="altColor"> 295<td class="colFirst"><code>abstract boolean</code></td> 296<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasGetter()">hasGetter</a></strong>()</code> </td> 297</tr> 298<tr class="rowColor"> 299<td class="colFirst"><code>boolean</code></td> 300<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasName(com.fasterxml.jackson.databind.PropertyName)">hasName</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> name)</code> </td> 301</tr> 302<tr class="altColor"> 303<td class="colFirst"><code>abstract boolean</code></td> 304<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasSetter()">hasSetter</a></strong>()</code> </td> 305</tr> 306<tr class="rowColor"> 307<td class="colFirst"><code>abstract boolean</code></td> 308<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isExplicitlyIncluded()">isExplicitlyIncluded</a></strong>()</code> 309<div class="block">Accessor that can be called to check whether property was included 310 due to an explicit marker (usually annotation), or just by naming 311 convention.</div> 312</td> 313</tr> 314<tr class="altColor"> 315<td class="colFirst"><code>boolean</code></td> 316<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isExplicitlyNamed()">isExplicitlyNamed</a></strong>()</code> 317<div class="block">Accessor that can be called to check whether property name was 318 due to an explicit marker (usually annotation), or just by naming 319 convention or use of "use-default-name" marker (annotation).</div> 320</td> 321</tr> 322<tr class="rowColor"> 323<td class="colFirst"><code>boolean</code></td> 324<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isRequired()">isRequired</a></strong>()</code> 325<div class="block">Method used to check if this property is expected to have a value; 326 and if none found, should either be considered invalid (and most likely 327 fail deserialization), or handled by other means (by providing default 328 value)</div> 329</td> 330</tr> 331<tr class="altColor"> 332<td class="colFirst"><code>boolean</code></td> 333<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isTypeId()">isTypeId</a></strong>()</code> 334<div class="block">Method used to check whether this logical property has a marker 335 to indicate it should be used as the type id for polymorphic type 336 handling.</div> 337</td> 338</tr> 339<tr class="rowColor"> 340<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</a></code></td> 341<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#withName(com.fasterxml.jackson.databind.PropertyName)">withName</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> newName)</code> 342<div class="block">Method that can be used to create a definition with 343 same settings as this one, but with different 344 (external) name; that is, one for which 345 <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()"><code>getName()</code></a> would return <code>newName</code>.</div> 346</td> 347</tr> 348<tr class="altColor"> 349<td class="colFirst"><code>abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</a></code></td> 350<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#withSimpleName(java.lang.String)">withSimpleName</a></strong>(<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> newSimpleName)</code> 351<div class="block">Alternate "mutant factory" that will only change simple name, but 352 leave other optional parts (like namespace) as is.</div> 353</td> 354</tr> 355</table> 356<ul class="blockList"> 357<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 358<!-- --> 359</a> 360<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> 361<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> 362</ul> 363</li> 364</ul> 365</li> 366</ul> 367</div> 368<div class="details"> 369<ul class="blockList"> 370<li class="blockList"> 371<!-- ============ FIELD DETAIL =========== --> 372<ul class="blockList"> 373<li class="blockList"><a name="field_detail"> 374<!-- --> 375</a> 376<h3>Field Detail</h3> 377<a name="EMPTY_INCLUDE"> 378<!-- --> 379</a> 380<ul class="blockListLast"> 381<li class="blockList"> 382<h4>EMPTY_INCLUDE</h4> 383<pre>protected 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> 384</li> 385</ul> 386</li> 387</ul> 388<!-- ========= CONSTRUCTOR DETAIL ======== --> 389<ul class="blockList"> 390<li class="blockList"><a name="constructor_detail"> 391<!-- --> 392</a> 393<h3>Constructor Detail</h3> 394<a name="BeanPropertyDefinition()"> 395<!-- --> 396</a> 397<ul class="blockListLast"> 398<li class="blockList"> 399<h4>BeanPropertyDefinition</h4> 400<pre>public BeanPropertyDefinition()</pre> 401</li> 402</ul> 403</li> 404</ul> 405<!-- ============ METHOD DETAIL ========== --> 406<ul class="blockList"> 407<li class="blockList"><a name="method_detail"> 408<!-- --> 409</a> 410<h3>Method Detail</h3> 411<a name="withName(com.fasterxml.jackson.databind.PropertyName)"> 412<!-- --> 413</a> 414<ul class="blockList"> 415<li class="blockList"> 416<h4>withName</h4> 417<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</a> withName(<a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> newName)</pre> 418<div class="block">Method that can be used to create a definition with 419 same settings as this one, but with different 420 (external) name; that is, one for which 421 <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()"><code>getName()</code></a> would return <code>newName</code>.</div> 422<dl><dt><span class="strong">Since:</span></dt> 423 <dd>2.3</dd></dl> 424</li> 425</ul> 426<a name="withSimpleName(java.lang.String)"> 427<!-- --> 428</a> 429<ul class="blockList"> 430<li class="blockList"> 431<h4>withSimpleName</h4> 432<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</a> withSimpleName(<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> newSimpleName)</pre> 433<div class="block">Alternate "mutant factory" that will only change simple name, but 434 leave other optional parts (like namespace) as is.</div> 435<dl><dt><span class="strong">Since:</span></dt> 436 <dd>2.3</dd></dl> 437</li> 438</ul> 439<a name="getName()"> 440<!-- --> 441</a> 442<ul class="blockList"> 443<li class="blockList"> 444<h4>getName</h4> 445<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> 446<div class="block">Accessor for name used for external representation (in JSON).</div> 447<dl> 448<dt><strong>Specified by:</strong></dt> 449<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> 450</dl> 451</li> 452</ul> 453<a name="getFullName()"> 454<!-- --> 455</a> 456<ul class="blockList"> 457<li class="blockList"> 458<h4>getFullName</h4> 459<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getFullName()</pre> 460</li> 461</ul> 462<a name="hasName(com.fasterxml.jackson.databind.PropertyName)"> 463<!-- --> 464</a> 465<ul class="blockList"> 466<li class="blockList"> 467<h4>hasName</h4> 468<pre>public boolean hasName(<a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> name)</pre> 469<dl><dt><span class="strong">Since:</span></dt> 470 <dd>2.6</dd></dl> 471</li> 472</ul> 473<a name="getInternalName()"> 474<!-- --> 475</a> 476<ul class="blockList"> 477<li class="blockList"> 478<h4>getInternalName</h4> 479<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> getInternalName()</pre> 480<div class="block">Accessor that can be used to determine implicit name from underlying 481 element(s) before possible renaming. This is the "internal" 482 name derived from accessor ("x" from "getX"), and is not based on 483 annotations or naming strategy.</div> 484</li> 485</ul> 486<a name="getWrapperName()"> 487<!-- --> 488</a> 489<ul class="blockList"> 490<li class="blockList"> 491<h4>getWrapperName</h4> 492<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getWrapperName()</pre> 493<div class="block">Accessor for finding wrapper name to use for property (if any).</div> 494<dl><dt><span class="strong">Since:</span></dt> 495 <dd>2.2</dd></dl> 496</li> 497</ul> 498<a name="getMetadata()"> 499<!-- --> 500</a> 501<ul class="blockList"> 502<li class="blockList"> 503<h4>getMetadata</h4> 504<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> getMetadata()</pre> 505<div class="block">Method for accessing additional metadata. 506 NOTE: will never return null, so de-referencing return value 507 is safe.</div> 508<dl><dt><span class="strong">Since:</span></dt> 509 <dd>2.3</dd></dl> 510</li> 511</ul> 512<a name="isExplicitlyIncluded()"> 513<!-- --> 514</a> 515<ul class="blockList"> 516<li class="blockList"> 517<h4>isExplicitlyIncluded</h4> 518<pre>public abstract boolean isExplicitlyIncluded()</pre> 519<div class="block">Accessor that can be called to check whether property was included 520 due to an explicit marker (usually annotation), or just by naming 521 convention.</div> 522<dl><dt><span class="strong">Returns:</span></dt><dd>True if property was explicitly included (usually by having 523 one of components being annotated); false if inclusion was purely 524 due to naming or visibility definitions (that is, implicit)</dd></dl> 525</li> 526</ul> 527<a name="isExplicitlyNamed()"> 528<!-- --> 529</a> 530<ul class="blockList"> 531<li class="blockList"> 532<h4>isExplicitlyNamed</h4> 533<pre>public boolean isExplicitlyNamed()</pre> 534<div class="block">Accessor that can be called to check whether property name was 535 due to an explicit marker (usually annotation), or just by naming 536 convention or use of "use-default-name" marker (annotation). 537<p> 538 Note that entries that return true from this method will always 539 return true for <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isExplicitlyIncluded()"><code>isExplicitlyIncluded()</code></a>, but not necessarily 540 vice versa.</div> 541<dl><dt><span class="strong">Since:</span></dt> 542 <dd>2.4</dd></dl> 543</li> 544</ul> 545<a name="couldDeserialize()"> 546<!-- --> 547</a> 548<ul class="blockList"> 549<li class="blockList"> 550<h4>couldDeserialize</h4> 551<pre>public boolean couldDeserialize()</pre> 552</li> 553</ul> 554<a name="couldSerialize()"> 555<!-- --> 556</a> 557<ul class="blockList"> 558<li class="blockList"> 559<h4>couldSerialize</h4> 560<pre>public boolean couldSerialize()</pre> 561</li> 562</ul> 563<a name="hasGetter()"> 564<!-- --> 565</a> 566<ul class="blockList"> 567<li class="blockList"> 568<h4>hasGetter</h4> 569<pre>public abstract boolean hasGetter()</pre> 570</li> 571</ul> 572<a name="hasSetter()"> 573<!-- --> 574</a> 575<ul class="blockList"> 576<li class="blockList"> 577<h4>hasSetter</h4> 578<pre>public abstract boolean hasSetter()</pre> 579</li> 580</ul> 581<a name="hasField()"> 582<!-- --> 583</a> 584<ul class="blockList"> 585<li class="blockList"> 586<h4>hasField</h4> 587<pre>public abstract boolean hasField()</pre> 588</li> 589</ul> 590<a name="hasConstructorParameter()"> 591<!-- --> 592</a> 593<ul class="blockList"> 594<li class="blockList"> 595<h4>hasConstructorParameter</h4> 596<pre>public abstract boolean hasConstructorParameter()</pre> 597</li> 598</ul> 599<a name="getGetter()"> 600<!-- --> 601</a> 602<ul class="blockList"> 603<li class="blockList"> 604<h4>getGetter</h4> 605<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</a> getGetter()</pre> 606</li> 607</ul> 608<a name="getSetter()"> 609<!-- --> 610</a> 611<ul class="blockList"> 612<li class="blockList"> 613<h4>getSetter</h4> 614<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</a> getSetter()</pre> 615</li> 616</ul> 617<a name="getField()"> 618<!-- --> 619</a> 620<ul class="blockList"> 621<li class="blockList"> 622<h4>getField</h4> 623<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedField.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedField</a> getField()</pre> 624</li> 625</ul> 626<a name="getConstructorParameter()"> 627<!-- --> 628</a> 629<ul class="blockList"> 630<li class="blockList"> 631<h4>getConstructorParameter</h4> 632<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</a> getConstructorParameter()</pre> 633</li> 634</ul> 635<a name="getConstructorParameters()"> 636<!-- --> 637</a> 638<ul class="blockList"> 639<li class="blockList"> 640<h4>getConstructorParameters</h4> 641<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</a>> getConstructorParameters()</pre> 642<div class="block">Additional method that may be called instead of <a href="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getConstructorParameter()"><code>getConstructorParameter()</code></a> 643 to get access to all constructor parameters, not just the highest priority one.</div> 644<dl><dt><span class="strong">Since:</span></dt> 645 <dd>2.5</dd></dl> 646</li> 647</ul> 648<a name="getAccessor()"> 649<!-- --> 650</a> 651<ul class="blockList"> 652<li class="blockList"> 653<h4>getAccessor</h4> 654<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getAccessor()</pre> 655<div class="block">Method used to find accessor (getter, field to access) to use for accessing 656 value of the property. 657 Null if no such member exists.</div> 658</li> 659</ul> 660<a name="getMutator()"> 661<!-- --> 662</a> 663<ul class="blockList"> 664<li class="blockList"> 665<h4>getMutator</h4> 666<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getMutator()</pre> 667<div class="block">Method used to find mutator (constructor parameter, setter, field) to use for 668 changing value of the property. 669 Null if no such member exists.</div> 670</li> 671</ul> 672<a name="getNonConstructorMutator()"> 673<!-- --> 674</a> 675<ul class="blockList"> 676<li class="blockList"> 677<h4>getNonConstructorMutator</h4> 678<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getNonConstructorMutator()</pre> 679<dl><dt><span class="strong">Since:</span></dt> 680 <dd>2.3</dd></dl> 681</li> 682</ul> 683<a name="getPrimaryMember()"> 684<!-- --> 685</a> 686<ul class="blockList"> 687<li class="blockList"> 688<h4>getPrimaryMember</h4> 689<pre>public abstract <a href="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getPrimaryMember()</pre> 690<div class="block">Method used to find the property member (getter, setter, field) that has 691 the highest precedence in current context (getter method when serializing, 692 if available, and so forth), if any. 693<p> 694 Note: abstract since 2.5</div> 695<dl><dt><span class="strong">Since:</span></dt> 696 <dd>2.1</dd></dl> 697</li> 698</ul> 699<a name="findViews()"> 700<!-- --> 701</a> 702<ul class="blockList"> 703<li class="blockList"> 704<h4>findViews</h4> 705<pre>public <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><?>[] findViews()</pre> 706<div class="block">Method used to find View-inclusion definitions for the property.</div> 707</li> 708</ul> 709<a name="findReferenceType()"> 710<!-- --> 711</a> 712<ul class="blockList"> 713<li class="blockList"> 714<h4>findReferenceType</h4> 715<pre>public <a href="../../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</a> findReferenceType()</pre> 716<div class="block">Method used to find whether property is part of a bi-directional 717 reference.</div> 718</li> 719</ul> 720<a name="isTypeId()"> 721<!-- --> 722</a> 723<ul class="blockList"> 724<li class="blockList"> 725<h4>isTypeId</h4> 726<pre>public boolean isTypeId()</pre> 727<div class="block">Method used to check whether this logical property has a marker 728 to indicate it should be used as the type id for polymorphic type 729 handling.</div> 730</li> 731</ul> 732<a name="findObjectIdInfo()"> 733<!-- --> 734</a> 735<ul class="blockList"> 736<li class="blockList"> 737<h4>findObjectIdInfo</h4> 738<pre>public <a href="../../../../../com/fasterxml/jackson/databind/introspect/ObjectIdInfo.html" title="class in com.fasterxml.jackson.databind.introspect">ObjectIdInfo</a> findObjectIdInfo()</pre> 739<div class="block">Method used to check whether this logical property indicates that 740 value POJOs should be written using additional Object Identifier 741 (or, when multiple references exist, all but first AS Object Identifier).</div> 742</li> 743</ul> 744<a name="isRequired()"> 745<!-- --> 746</a> 747<ul class="blockList"> 748<li class="blockList"> 749<h4>isRequired</h4> 750<pre>public boolean isRequired()</pre> 751<div class="block">Method used to check if this property is expected to have a value; 752 and if none found, should either be considered invalid (and most likely 753 fail deserialization), or handled by other means (by providing default 754 value)</div> 755</li> 756</ul> 757<a name="findInclusion()"> 758<!-- --> 759</a> 760<ul class="blockListLast"> 761<li class="blockList"> 762<h4>findInclusion</h4> 763<pre>public <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> findInclusion()</pre> 764<div class="block">Method used to check if this property has specific inclusion override 765 associated with it or not.</div> 766<dl><dt><span class="strong">Since:</span></dt> 767 <dd>2.5</dd></dl> 768</li> 769</ul> 770</li> 771</ul> 772</li> 773</ul> 774</div> 775</div> 776<!-- ========= END OF CLASS DATA ========= --> 777<!-- ======= START OF BOTTOM NAVBAR ====== --> 778<div class="bottomNav"><a name="navbar_bottom"> 779<!-- --> 780</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 781<!-- --> 782</a> 783<ul class="navList" title="Navigation"> 784<li><a href="../../../../../overview-summary.html">Overview</a></li> 785<li><a href="package-summary.html">Package</a></li> 786<li class="navBarCell1Rev">Class</li> 787<li><a href="class-use/BeanPropertyDefinition.html">Use</a></li> 788<li><a href="package-tree.html">Tree</a></li> 789<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 790<li><a href="../../../../../index-all.html">Index</a></li> 791<li><a href="../../../../../help-doc.html">Help</a></li> 792</ul> 793</div> 794<div class="subNav"> 795<ul class="navList"> 796<li><a href="../../../../../com/fasterxml/jackson/databind/introspect/BasicClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><span class="strong">Prev Class</span></a></li> 797<li><a href="../../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><span class="strong">Next Class</span></a></li> 798</ul> 799<ul class="navList"> 800<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" target="_top">Frames</a></li> 801<li><a href="BeanPropertyDefinition.html" target="_top">No Frames</a></li> 802</ul> 803<ul class="navList" id="allclasses_navbar_bottom"> 804<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 805</ul> 806<div> 807<script type="text/javascript"><!-- 808 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 809 if(window==top) { 810 allClassesLink.style.display = "block"; 811 } 812 else { 813 allClassesLink.style.display = "none"; 814 } 815 //--> 816</script> 817</div> 818<div> 819<ul class="subNavList"> 820<li>Summary: </li> 821<li>Nested | </li> 822<li><a href="#field_summary">Field</a> | </li> 823<li><a href="#constructor_summary">Constr</a> | </li> 824<li><a href="#method_summary">Method</a></li> 825</ul> 826<ul class="subNavList"> 827<li>Detail: </li> 828<li><a href="#field_detail">Field</a> | </li> 829<li><a href="#constructor_detail">Constr</a> | </li> 830<li><a href="#method_detail">Method</a></li> 831</ul> 832</div> 833<a name="skip-navbar_bottom"> 834<!-- --> 835</a></div> 836<!-- ======== END OF BOTTOM NAVBAR ======= --> 837<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 838</body> 839</html> 840