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