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_10-ea) on Mon Apr 22 19:50:30 PDT 2013 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>BeanProperty (jackson-databind 2.2.0 API)</title> 8<meta name="date" content="2013-04-22"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="BeanProperty (jackson-databind 2.2.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../overview-summary.html">Overview</a></li> 29<li><a href="package-summary.html">Package</a></li> 30<li class="navBarCell1Rev">Class</li> 31<li><a href="class-use/BeanProperty.html">Use</a></li> 32<li><a href="package-tree.html">Tree</a></li> 33<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 34<li><a href="../../../../index-all.html">Index</a></li> 35<li><a href="../../../../help-doc.html">Help</a></li> 36</ul> 37</div> 38<div class="subNav"> 39<ul class="navList"> 40<li><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top">Frames</a></li> 45<li><a href="BeanProperty.html" target="_top">No Frames</a></li> 46</ul> 47<ul class="navList" id="allclasses_navbar_top"> 48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 49</ul> 50<div> 51<script type="text/javascript"><!-- 52 allClassesLink = document.getElementById("allclasses_navbar_top"); 53 if(window==top) { 54 allClassesLink.style.display = "block"; 55 } 56 else { 57 allClassesLink.style.display = "none"; 58 } 59 //--> 60</script> 61</div> 62<div> 63<ul class="subNavList"> 64<li>Summary: </li> 65<li><a href="#nested_class_summary">Nested</a> | </li> 66<li>Field | </li> 67<li>Constr | </li> 68<li><a href="#method_summary">Method</a></li> 69</ul> 70<ul class="subNavList"> 71<li>Detail: </li> 72<li>Field | </li> 73<li>Constr | </li> 74<li><a href="#method_detail">Method</a></li> 75</ul> 76</div> 77<a name="skip-navbar_top"> 78<!-- --> 79</a></div> 80<!-- ========= END OF TOP NAVBAR ========= --> 81<!-- ======== START OF CLASS DATA ======== --> 82<div class="header"> 83<div class="subTitle">com.fasterxml.jackson.databind</div> 84<h2 title="Interface BeanProperty" class="title">Interface BeanProperty</h2> 85</div> 86<div class="contentContainer"> 87<div class="description"> 88<ul class="blockList"> 89<li class="blockList"> 90<dl> 91<dt>All Superinterfaces:</dt> 92<dd><a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></dd> 93</dl> 94<dl> 95<dt>All Known Implementing Classes:</dt> 96<dd><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a>, <a href="../../../../com/fasterxml/jackson/databind/ser/BeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">BeanPropertyWriter</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/CreatorProperty.html" title="class in com.fasterxml.jackson.databind.deser">CreatorProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/FieldProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">FieldProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/InnerClassProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">InnerClassProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ManagedReferenceProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">ManagedReferenceProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/MethodProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">MethodProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ObjectIdValueProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">ObjectIdValueProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/SettableBeanProperty.html" title="class in com.fasterxml.jackson.databind.deser">SettableBeanProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/SetterlessProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">SetterlessProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/ser/impl/UnwrappingBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser.impl">UnwrappingBeanPropertyWriter</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ValueInjector.html" title="class in com.fasterxml.jackson.databind.deser.impl">ValueInjector</a></dd> 97</dl> 98<hr> 99<br> 100<pre>public interface <span class="strong">BeanProperty</span> 101extends <a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></pre> 102<div class="block">Bean properties are logical entities that represent data 103 that Java objects (POJOs (Plain Old Java Objects), sometimes also called "beans") 104 contain; and that are accessed using accessors (methods like getters 105 and setters, fields, contstructor parametrers). 106 Instances allow access to annotations directly associated 107 to property (via field or method), as well as contextual 108 annotations (annotations for class that contains properties). 109<p> 110 Instances are not typically passed when constructing serializers 111 and deserializers, but rather only passed when context 112 is known when 113 <a href="../../../../com/fasterxml/jackson/databind/ser/ContextualSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><code>ContextualSerializer</code></a> and 114 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a> 115 resolution occurs (<code>createContextual(...)</code> method is called). 116 References may (need to) be retained by serializers and deserializers, 117 especially when further resolving dependant handlers like value 118 serializers/deserializers or structured types.</div> 119</li> 120</ul> 121</div> 122<div class="summary"> 123<ul class="blockList"> 124<li class="blockList"> 125<!-- ======== NESTED CLASS SUMMARY ======== --> 126<ul class="blockList"> 127<li class="blockList"><a name="nested_class_summary"> 128<!-- --> 129</a> 130<h3>Nested Class Summary</h3> 131<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 132<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 133<tr> 134<th class="colFirst" scope="col">Modifier and Type</th> 135<th class="colLast" scope="col">Interface and Description</th> 136</tr> 137<tr class="altColor"> 138<td class="colFirst"><code>static class </code></td> 139<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></strong></code> 140<div class="block">Simple stand-alone implementation, useful as a placeholder 141 or base class for more complex implementations.</div> 142</td> 143</tr> 144</table> 145</li> 146</ul> 147<!-- ========== METHOD SUMMARY =========== --> 148<ul class="blockList"> 149<li class="blockList"><a name="method_summary"> 150<!-- --> 151</a> 152<h3>Method Summary</h3> 153<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 154<caption><span>Methods</span><span class="tabEnd"> </span></caption> 155<tr> 156<th class="colFirst" scope="col">Modifier and Type</th> 157<th class="colLast" scope="col">Method and Description</th> 158</tr> 159<tr class="altColor"> 160<td class="colFirst"><code>void</code></td> 161<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)">depositSchemaProperty</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor)</code> 162<div class="block">Method that can be called to visit the type structure that this 163 property is part of.</div> 164</td> 165</tr> 166<tr class="rowColor"> 167<td class="colFirst"><code><A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> <br>A</code></td> 168<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">getAnnotation</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 169<div class="block">Method for finding annotation associated with this property; 170 meaning annotation associated with one of entities used to 171 access property.</div> 172</td> 173</tr> 174<tr class="altColor"> 175<td class="colFirst"><code><A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> <br>A</code></td> 176<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> 177<div class="block">Method for finding annotation associated with context of 178 this property; usually class in which member is declared 179 (or its subtype if processing subtype).</div> 180</td> 181</tr> 182<tr class="rowColor"> 183<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> 184<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">getMember</a></strong>()</code> 185<div class="block">Method for accessing primary physical entity that represents the property; 186 annotated field, method or constructor property.</div> 187</td> 188</tr> 189<tr class="altColor"> 190<td class="colFirst"><code><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> 191<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">getName</a></strong>()</code> 192<div class="block">Method to get logical name of the property</div> 193</td> 194</tr> 195<tr class="rowColor"> 196<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 197<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">getType</a></strong>()</code> 198<div class="block">Method to get declared type of the property.</div> 199</td> 200</tr> 201<tr class="altColor"> 202<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 203<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">getWrapperName</a></strong>()</code> 204<div class="block">If property is indicated to be wrapped, name of 205 wrapper element to use.</div> 206</td> 207</tr> 208<tr class="rowColor"> 209<td class="colFirst"><code>boolean</code></td> 210<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired()">isRequired</a></strong>()</code> 211<div class="block">Whether value for property is marked as required using 212 annotations or associated schema.</div> 213</td> 214</tr> 215</table> 216</li> 217</ul> 218</li> 219</ul> 220</div> 221<div class="details"> 222<ul class="blockList"> 223<li class="blockList"> 224<!-- ============ METHOD DETAIL ========== --> 225<ul class="blockList"> 226<li class="blockList"><a name="method_detail"> 227<!-- --> 228</a> 229<h3>Method Detail</h3> 230<a name="getName()"> 231<!-- --> 232</a> 233<ul class="blockList"> 234<li class="blockList"> 235<h4>getName</h4> 236<pre><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> 237<div class="block">Method to get logical name of the property</div> 238<dl> 239<dt><strong>Specified by:</strong></dt> 240<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> 241</dl> 242</li> 243</ul> 244<a name="getType()"> 245<!-- --> 246</a> 247<ul class="blockList"> 248<li class="blockList"> 249<h4>getType</h4> 250<pre><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> getType()</pre> 251<div class="block">Method to get declared type of the property.</div> 252</li> 253</ul> 254<a name="getWrapperName()"> 255<!-- --> 256</a> 257<ul class="blockList"> 258<li class="blockList"> 259<h4>getWrapperName</h4> 260<pre><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getWrapperName()</pre> 261<div class="block">If property is indicated to be wrapped, name of 262 wrapper element to use.</div> 263<dl><dt><span class="strong">Since:</span></dt> 264 <dd>2.2</dd></dl> 265</li> 266</ul> 267<a name="isRequired()"> 268<!-- --> 269</a> 270<ul class="blockList"> 271<li class="blockList"> 272<h4>isRequired</h4> 273<pre>boolean isRequired()</pre> 274<div class="block">Whether value for property is marked as required using 275 annotations or associated schema.</div> 276<dl><dt><span class="strong">Since:</span></dt> 277 <dd>2.2</dd></dl> 278</li> 279</ul> 280<a name="getAnnotation(java.lang.Class)"> 281<!-- --> 282</a> 283<ul class="blockList"> 284<li class="blockList"> 285<h4>getAnnotation</h4> 286<pre><A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> A getAnnotation(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 287<div class="block">Method for finding annotation associated with this property; 288 meaning annotation associated with one of entities used to 289 access property.</div> 290</li> 291</ul> 292<a name="getContextAnnotation(java.lang.Class)"> 293<!-- --> 294</a> 295<ul class="blockList"> 296<li class="blockList"> 297<h4>getContextAnnotation</h4> 298<pre><A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>> A getContextAnnotation(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> 299<div class="block">Method for finding annotation associated with context of 300 this property; usually class in which member is declared 301 (or its subtype if processing subtype).</div> 302</li> 303</ul> 304<a name="getMember()"> 305<!-- --> 306</a> 307<ul class="blockList"> 308<li class="blockList"> 309<h4>getMember</h4> 310<pre><a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getMember()</pre> 311<div class="block">Method for accessing primary physical entity that represents the property; 312 annotated field, method or constructor property.</div> 313</li> 314</ul> 315<a name="depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)"> 316<!-- --> 317</a> 318<ul class="blockListLast"> 319<li class="blockList"> 320<h4>depositSchemaProperty</h4> 321<pre>void depositSchemaProperty(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor) 322 throws <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 323<div class="block">Method that can be called to visit the type structure that this 324 property is part of. 325 Note that not all implementations support traversal with this 326 method; those that do not should throw 327 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>.</div> 328<dl><dt><span class="strong">Parameters:</span></dt><dd><code>objectVisitor</code> - Visitor to used as the callback handler</dd> 329<dt><span class="strong">Throws:</span></dt> 330<dd><code><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd><dt><span class="strong">Since:</span></dt> 331 <dd>2.2</dd></dl> 332</li> 333</ul> 334</li> 335</ul> 336</li> 337</ul> 338</div> 339</div> 340<!-- ========= END OF CLASS DATA ========= --> 341<!-- ======= START OF BOTTOM NAVBAR ====== --> 342<div class="bottomNav"><a name="navbar_bottom"> 343<!-- --> 344</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 345<!-- --> 346</a> 347<ul class="navList" title="Navigation"> 348<li><a href="../../../../overview-summary.html">Overview</a></li> 349<li><a href="package-summary.html">Package</a></li> 350<li class="navBarCell1Rev">Class</li> 351<li><a href="class-use/BeanProperty.html">Use</a></li> 352<li><a href="package-tree.html">Tree</a></li> 353<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 354<li><a href="../../../../index-all.html">Index</a></li> 355<li><a href="../../../../help-doc.html">Help</a></li> 356</ul> 357</div> 358<div class="subNav"> 359<ul class="navList"> 360<li><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 361<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 362</ul> 363<ul class="navList"> 364<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top">Frames</a></li> 365<li><a href="BeanProperty.html" target="_top">No Frames</a></li> 366</ul> 367<ul class="navList" id="allclasses_navbar_bottom"> 368<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 369</ul> 370<div> 371<script type="text/javascript"><!-- 372 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 373 if(window==top) { 374 allClassesLink.style.display = "block"; 375 } 376 else { 377 allClassesLink.style.display = "none"; 378 } 379 //--> 380</script> 381</div> 382<div> 383<ul class="subNavList"> 384<li>Summary: </li> 385<li><a href="#nested_class_summary">Nested</a> | </li> 386<li>Field | </li> 387<li>Constr | </li> 388<li><a href="#method_summary">Method</a></li> 389</ul> 390<ul class="subNavList"> 391<li>Detail: </li> 392<li>Field | </li> 393<li>Constr | </li> 394<li><a href="#method_detail">Method</a></li> 395</ul> 396</div> 397<a name="skip-navbar_bottom"> 398<!-- --> 399</a></div> 400<!-- ======== END OF BOTTOM NAVBAR ======= --> 401<p class="legalCopy"><small>Copyright © 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 402</body> 403</html> 404