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