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:54 PST 2015 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>BeanProperty.Std (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="BeanProperty.Std (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/BeanProperty.Std.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/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../com/fasterxml/jackson/databind/DatabindContext.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.Std.html" target="_top">Frames</a></li> 45<li><a href="BeanProperty.Std.html" target="_top">No Frames</a></li> 46</ul> 47<ul class="navList" id="allclasses_navbar_top"> 48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 49</ul> 50<div> 51<script type="text/javascript"><!-- 52 allClassesLink = document.getElementById("allclasses_navbar_top"); 53 if(window==top) { 54 allClassesLink.style.display = "block"; 55 } 56 else { 57 allClassesLink.style.display = "none"; 58 } 59 //--> 60</script> 61</div> 62<div> 63<ul class="subNavList"> 64<li>Summary: </li> 65<li>Nested | </li> 66<li><a href="#field_summary">Field</a> | </li> 67<li><a href="#constructor_summary">Constr</a> | </li> 68<li><a href="#method_summary">Method</a></li> 69</ul> 70<ul class="subNavList"> 71<li>Detail: </li> 72<li><a href="#field_detail">Field</a> | </li> 73<li><a href="#constructor_detail">Constr</a> | </li> 74<li><a href="#method_detail">Method</a></li> 75</ul> 76</div> 77<a name="skip-navbar_top"> 78<!-- --> 79</a></div> 80<!-- ========= END OF TOP NAVBAR ========= --> 81<!-- ======== START OF CLASS DATA ======== --> 82<div class="header"> 83<div class="subTitle">com.fasterxml.jackson.databind</div> 84<h2 title="Class BeanProperty.Std" class="title">Class BeanProperty.Std</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.BeanProperty.Std</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/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a>, <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/deser/impl/ValueInjector.html" title="class in com.fasterxml.jackson.databind.deser.impl">ValueInjector</a></dd> 105</dl> 106<dl> 107<dt>Enclosing interface:</dt> 108<dd><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></dd> 109</dl> 110<hr> 111<br> 112<pre>public static class <span class="strong">BeanProperty.Std</span> 113extends <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> 114implements <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></pre> 115<div class="block">Simple stand-alone implementation, useful as a placeholder 116 or base class for more complex implementations.</div> 117</li> 118</ul> 119</div> 120<div class="summary"> 121<ul class="blockList"> 122<li class="blockList"> 123<!-- ======== NESTED CLASS SUMMARY ======== --> 124<ul class="blockList"> 125<li class="blockList"><a name="nested_class_summary"> 126<!-- --> 127</a> 128<h3>Nested Class Summary</h3> 129<ul class="blockList"> 130<li class="blockList"><a name="nested_classes_inherited_from_class_com.fasterxml.jackson.databind.BeanProperty"> 131<!-- --> 132</a> 133<h3>Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.<a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></h3> 134<code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></code></li> 135</ul> 136</li> 137</ul> 138<!-- =========== FIELD SUMMARY =========== --> 139<ul class="blockList"> 140<li class="blockList"><a name="field_summary"> 141<!-- --> 142</a> 143<h3>Field Summary</h3> 144<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 145<caption><span>Fields</span><span class="tabEnd"> </span></caption> 146<tr> 147<th class="colFirst" scope="col">Modifier and Type</th> 148<th class="colLast" scope="col">Field and Description</th> 149</tr> 150<tr class="altColor"> 151<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a></code></td> 152<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_contextAnnotations">_contextAnnotations</a></strong></code> 153<div class="block">Annotations defined in the context class (if any); may be null 154 if no annotations were found</div> 155</td> 156</tr> 157<tr class="rowColor"> 158<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a></code></td> 159<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_member">_member</a></strong></code> 160<div class="block">Physical entity (field, method or constructor argument) that 161 is used to access value of property (or in case of constructor 162 property, just placeholder)</div> 163</td> 164</tr> 165<tr class="altColor"> 166<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></code></td> 167<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_metadata">_metadata</a></strong></code> </td> 168</tr> 169<tr class="rowColor"> 170<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 171<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_name">_name</a></strong></code> </td> 172</tr> 173<tr class="altColor"> 174<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 175<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_type">_type</a></strong></code> </td> 176</tr> 177<tr class="rowColor"> 178<td class="colFirst"><code>protected <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 179<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#_wrapperName">_wrapperName</a></strong></code> </td> 180</tr> 181</table> 182</li> 183</ul> 184<!-- ======== CONSTRUCTOR SUMMARY ======== --> 185<ul class="blockList"> 186<li class="blockList"><a name="constructor_summary"> 187<!-- --> 188</a> 189<h3>Constructor Summary</h3> 190<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 191<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 192<tr> 193<th class="colOne" scope="col">Constructor and Description</th> 194</tr> 195<tr class="altColor"> 196<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#BeanProperty.Std(com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.util.Annotations, com.fasterxml.jackson.databind.introspect.AnnotatedMember, com.fasterxml.jackson.databind.PropertyMetadata)">BeanProperty.Std</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> name, 197 <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> type, 198 <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> wrapperName, 199 <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a> contextAnnotations, 200 <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> member, 201 <a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> metadata)</code> </td> 202</tr> 203<tr class="rowColor"> 204<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#BeanProperty.Std(java.lang.String, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.util.Annotations, com.fasterxml.jackson.databind.introspect.AnnotatedMember, boolean)">BeanProperty.Std</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> name, 205 <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> type, 206 <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> wrapperName, 207 <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a> contextAnnotations, 208 <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> member, 209 boolean isRequired)</code> 210<div class="block"><strong>Deprecated.</strong> </div> 211</td> 212</tr> 213</table> 214</li> 215</ul> 216<!-- ========== METHOD SUMMARY =========== --> 217<ul class="blockList"> 218<li class="blockList"><a name="method_summary"> 219<!-- --> 220</a> 221<h3>Method Summary</h3> 222<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 223<caption><span>Methods</span><span class="tabEnd"> </span></caption> 224<tr> 225<th class="colFirst" scope="col">Modifier and Type</th> 226<th class="colLast" scope="col">Method and Description</th> 227</tr> 228<tr class="altColor"> 229<td class="colFirst"><code>void</code></td> 230<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.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> 231<div class="block">Implementation of this method throws 232 <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>, since instances of this 233 implementation should not be used as part of actual structure 234 visited.</div> 235</td> 236</tr> 237<tr class="rowColor"> 238<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> 239<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.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> 240<div class="block">Method for finding annotation associated with this property; 241 meaning annotation associated with one of entities used to 242 access property.</div> 243</td> 244</tr> 245<tr class="altColor"> 246<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> 247<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.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> 248<div class="block">Method for finding annotation associated with context of 249 this property; usually class in which member is declared 250 (or its subtype if processing subtype).</div> 251</td> 252</tr> 253<tr class="rowColor"> 254<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 255<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getFullName()">getFullName</a></strong>()</code> 256<div class="block">Method for getting full name definition, including possible 257 format-specific additional properties (such as namespace when 258 using XML backend).</div> 259</td> 260</tr> 261<tr class="altColor"> 262<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> 263<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getMember()">getMember</a></strong>()</code> 264<div class="block">Method for accessing primary physical entity that represents the property; 265 annotated field, method or constructor property.</div> 266</td> 267</tr> 268<tr class="rowColor"> 269<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></code></td> 270<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getMetadata()">getMetadata</a></strong>()</code> 271<div class="block">Accessor for additional optional information about property.</div> 272</td> 273</tr> 274<tr class="altColor"> 275<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> 276<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getName()">getName</a></strong>()</code> 277<div class="block">Method to get logical name of the property</div> 278</td> 279</tr> 280<tr class="rowColor"> 281<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> 282<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getType()">getType</a></strong>()</code> 283<div class="block">Method to get declared type of the property.</div> 284</td> 285</tr> 286<tr class="altColor"> 287<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> 288<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#getWrapperName()">getWrapperName</a></strong>()</code> 289<div class="block">If property is indicated to be wrapped, name of 290 wrapper element to use.</div> 291</td> 292</tr> 293<tr class="rowColor"> 294<td class="colFirst"><code>boolean</code></td> 295<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#isRequired()">isRequired</a></strong>()</code> 296<div class="block">Whether value for property is marked as required using 297 annotations or associated schema.</div> 298</td> 299</tr> 300<tr class="altColor"> 301<td class="colFirst"><code>boolean</code></td> 302<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#isVirtual()">isVirtual</a></strong>()</code> 303<div class="block"> 304 TODO: move to <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><code>BeanProperty</code></a> in near future, once all standard 305 implementations define it.</div> 306</td> 307</tr> 308<tr class="rowColor"> 309<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></code></td> 310<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html#withType(com.fasterxml.jackson.databind.JavaType)">withType</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> type)</code> </td> 311</tr> 312</table> 313<ul class="blockList"> 314<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 315<!-- --> 316</a> 317<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> 318<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> 319</ul> 320</li> 321</ul> 322</li> 323</ul> 324</div> 325<div class="details"> 326<ul class="blockList"> 327<li class="blockList"> 328<!-- ============ FIELD DETAIL =========== --> 329<ul class="blockList"> 330<li class="blockList"><a name="field_detail"> 331<!-- --> 332</a> 333<h3>Field Detail</h3> 334<a name="_name"> 335<!-- --> 336</a> 337<ul class="blockList"> 338<li class="blockList"> 339<h4>_name</h4> 340<pre>protected final <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> _name</pre> 341</li> 342</ul> 343<a name="_type"> 344<!-- --> 345</a> 346<ul class="blockList"> 347<li class="blockList"> 348<h4>_type</h4> 349<pre>protected final <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> _type</pre> 350</li> 351</ul> 352<a name="_wrapperName"> 353<!-- --> 354</a> 355<ul class="blockList"> 356<li class="blockList"> 357<h4>_wrapperName</h4> 358<pre>protected final <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> _wrapperName</pre> 359</li> 360</ul> 361<a name="_metadata"> 362<!-- --> 363</a> 364<ul class="blockList"> 365<li class="blockList"> 366<h4>_metadata</h4> 367<pre>protected final <a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> _metadata</pre> 368</li> 369</ul> 370<a name="_member"> 371<!-- --> 372</a> 373<ul class="blockList"> 374<li class="blockList"> 375<h4>_member</h4> 376<pre>protected final <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> _member</pre> 377<div class="block">Physical entity (field, method or constructor argument) that 378 is used to access value of property (or in case of constructor 379 property, just placeholder)</div> 380</li> 381</ul> 382<a name="_contextAnnotations"> 383<!-- --> 384</a> 385<ul class="blockListLast"> 386<li class="blockList"> 387<h4>_contextAnnotations</h4> 388<pre>protected final <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a> _contextAnnotations</pre> 389<div class="block">Annotations defined in the context class (if any); may be null 390 if no annotations were found</div> 391</li> 392</ul> 393</li> 394</ul> 395<!-- ========= CONSTRUCTOR DETAIL ======== --> 396<ul class="blockList"> 397<li class="blockList"><a name="constructor_detail"> 398<!-- --> 399</a> 400<h3>Constructor Detail</h3> 401<a name="BeanProperty.Std(com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.util.Annotations, com.fasterxml.jackson.databind.introspect.AnnotatedMember, com.fasterxml.jackson.databind.PropertyMetadata)"> 402<!-- --> 403</a> 404<ul class="blockList"> 405<li class="blockList"> 406<h4>BeanProperty.Std</h4> 407<pre>public BeanProperty.Std(<a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> name, 408 <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> type, 409 <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> wrapperName, 410 <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a> contextAnnotations, 411 <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> member, 412 <a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> metadata)</pre> 413</li> 414</ul> 415<a name="BeanProperty.Std(java.lang.String, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.PropertyName, com.fasterxml.jackson.databind.util.Annotations, com.fasterxml.jackson.databind.introspect.AnnotatedMember, boolean)"> 416<!-- --> 417</a> 418<ul class="blockListLast"> 419<li class="blockList"> 420<h4>BeanProperty.Std</h4> 421<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> 422public BeanProperty.Std(<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> name, 423 <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> type, 424 <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> wrapperName, 425 <a href="../../../../com/fasterxml/jackson/databind/util/Annotations.html" title="interface in com.fasterxml.jackson.databind.util">Annotations</a> contextAnnotations, 426 <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> member, 427 boolean isRequired)</pre> 428<div class="block"><span class="strong">Deprecated.</span> </div> 429</li> 430</ul> 431</li> 432</ul> 433<!-- ============ METHOD DETAIL ========== --> 434<ul class="blockList"> 435<li class="blockList"><a name="method_detail"> 436<!-- --> 437</a> 438<h3>Method Detail</h3> 439<a name="withType(com.fasterxml.jackson.databind.JavaType)"> 440<!-- --> 441</a> 442<ul class="blockList"> 443<li class="blockList"> 444<h4>withType</h4> 445<pre>public <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a> withType(<a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> type)</pre> 446</li> 447</ul> 448<a name="getAnnotation(java.lang.Class)"> 449<!-- --> 450</a> 451<ul class="blockList"> 452<li class="blockList"> 453<h4>getAnnotation</h4> 454<pre>public <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> 455<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">BeanProperty</a></code></strong></div> 456<div class="block">Method for finding annotation associated with this property; 457 meaning annotation associated with one of entities used to 458 access property.</div> 459<dl> 460<dt><strong>Specified by:</strong></dt> 461<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">getAnnotation</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 462</dl> 463</li> 464</ul> 465<a name="getContextAnnotation(java.lang.Class)"> 466<!-- --> 467</a> 468<ul class="blockList"> 469<li class="blockList"> 470<h4>getContextAnnotation</h4> 471<pre>public <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> 472<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">BeanProperty</a></code></strong></div> 473<div class="block">Method for finding annotation associated with context of 474 this property; usually class in which member is declared 475 (or its subtype if processing subtype).</div> 476<dl> 477<dt><strong>Specified by:</strong></dt> 478<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 479</dl> 480</li> 481</ul> 482<a name="getName()"> 483<!-- --> 484</a> 485<ul class="blockList"> 486<li class="blockList"> 487<h4>getName</h4> 488<pre>public <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> 489<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">BeanProperty</a></code></strong></div> 490<div class="block">Method to get logical name of the property</div> 491<dl> 492<dt><strong>Specified by:</strong></dt> 493<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">getName</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 494<dt><strong>Specified by:</strong></dt> 495<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> 496</dl> 497</li> 498</ul> 499<a name="getFullName()"> 500<!-- --> 501</a> 502<ul class="blockList"> 503<li class="blockList"> 504<h4>getFullName</h4> 505<pre>public <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getFullName()</pre> 506<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getFullName()">BeanProperty</a></code></strong></div> 507<div class="block">Method for getting full name definition, including possible 508 format-specific additional properties (such as namespace when 509 using XML backend).</div> 510<dl> 511<dt><strong>Specified by:</strong></dt> 512<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getFullName()">getFullName</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 513</dl> 514</li> 515</ul> 516<a name="getType()"> 517<!-- --> 518</a> 519<ul class="blockList"> 520<li class="blockList"> 521<h4>getType</h4> 522<pre>public <a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> getType()</pre> 523<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">BeanProperty</a></code></strong></div> 524<div class="block">Method to get declared type of the property.</div> 525<dl> 526<dt><strong>Specified by:</strong></dt> 527<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">getType</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 528</dl> 529</li> 530</ul> 531<a name="getWrapperName()"> 532<!-- --> 533</a> 534<ul class="blockList"> 535<li class="blockList"> 536<h4>getWrapperName</h4> 537<pre>public <a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getWrapperName()</pre> 538<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">BeanProperty</a></code></strong></div> 539<div class="block">If property is indicated to be wrapped, name of 540 wrapper element to use.</div> 541<dl> 542<dt><strong>Specified by:</strong></dt> 543<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName()">getWrapperName</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 544</dl> 545</li> 546</ul> 547<a name="isRequired()"> 548<!-- --> 549</a> 550<ul class="blockList"> 551<li class="blockList"> 552<h4>isRequired</h4> 553<pre>public boolean isRequired()</pre> 554<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired()">BeanProperty</a></code></strong></div> 555<div class="block">Whether value for property is marked as required using 556 annotations or associated schema. 557 Equivalent to: 558<code> 559 getMetadata().isRequired() 560</code></div> 561<dl> 562<dt><strong>Specified by:</strong></dt> 563<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired()">isRequired</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 564</dl> 565</li> 566</ul> 567<a name="getMetadata()"> 568<!-- --> 569</a> 570<ul class="blockList"> 571<li class="blockList"> 572<h4>getMetadata</h4> 573<pre>public <a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> getMetadata()</pre> 574<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMetadata()">BeanProperty</a></code></strong></div> 575<div class="block">Accessor for additional optional information about property.</div> 576<dl> 577<dt><strong>Specified by:</strong></dt> 578<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMetadata()">getMetadata</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 579<dt><span class="strong">Returns:</span></dt><dd>Metadata about property; never null.</dd></dl> 580</li> 581</ul> 582<a name="getMember()"> 583<!-- --> 584</a> 585<ul class="blockList"> 586<li class="blockList"> 587<h4>getMember</h4> 588<pre>public <a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getMember()</pre> 589<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">BeanProperty</a></code></strong></div> 590<div class="block">Method for accessing primary physical entity that represents the property; 591 annotated field, method or constructor property.</div> 592<dl> 593<dt><strong>Specified by:</strong></dt> 594<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">getMember</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 595</dl> 596</li> 597</ul> 598<a name="isVirtual()"> 599<!-- --> 600</a> 601<ul class="blockList"> 602<li class="blockList"> 603<h4>isVirtual</h4> 604<pre>public boolean isVirtual()</pre> 605<div class="block"><p> 606 TODO: move to <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><code>BeanProperty</code></a> in near future, once all standard 607 implementations define it.</div> 608<dl><dt><span class="strong">Since:</span></dt> 609 <dd>2.5</dd></dl> 610</li> 611</ul> 612<a name="depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)"> 613<!-- --> 614</a> 615<ul class="blockListLast"> 616<li class="blockList"> 617<h4>depositSchemaProperty</h4> 618<pre>public void depositSchemaProperty(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor)</pre> 619<div class="block">Implementation of this method throws 620 <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>, since instances of this 621 implementation should not be used as part of actual structure 622 visited. Rather, other implementations should handle it.</div> 623<dl> 624<dt><strong>Specified by:</strong></dt> 625<dd><code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#depositSchemaProperty(com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor)">depositSchemaProperty</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></code></dd> 626<dt><span class="strong">Parameters:</span></dt><dd><code>objectVisitor</code> - Visitor to used as the callback handler</dd></dl> 627</li> 628</ul> 629</li> 630</ul> 631</li> 632</ul> 633</div> 634</div> 635<!-- ========= END OF CLASS DATA ========= --> 636<!-- ======= START OF BOTTOM NAVBAR ====== --> 637<div class="bottomNav"><a name="navbar_bottom"> 638<!-- --> 639</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 640<!-- --> 641</a> 642<ul class="navList" title="Navigation"> 643<li><a href="../../../../overview-summary.html">Overview</a></li> 644<li><a href="package-summary.html">Package</a></li> 645<li class="navBarCell1Rev">Class</li> 646<li><a href="class-use/BeanProperty.Std.html">Use</a></li> 647<li><a href="package-tree.html">Tree</a></li> 648<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 649<li><a href="../../../../index-all.html">Index</a></li> 650<li><a href="../../../../help-doc.html">Help</a></li> 651</ul> 652</div> 653<div class="subNav"> 654<ul class="navList"> 655<li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 656<li><a href="../../../../com/fasterxml/jackson/databind/DatabindContext.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 657</ul> 658<ul class="navList"> 659<li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.Std.html" target="_top">Frames</a></li> 660<li><a href="BeanProperty.Std.html" target="_top">No Frames</a></li> 661</ul> 662<ul class="navList" id="allclasses_navbar_bottom"> 663<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 664</ul> 665<div> 666<script type="text/javascript"><!-- 667 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 668 if(window==top) { 669 allClassesLink.style.display = "block"; 670 } 671 else { 672 allClassesLink.style.display = "none"; 673 } 674 //--> 675</script> 676</div> 677<div> 678<ul class="subNavList"> 679<li>Summary: </li> 680<li>Nested | </li> 681<li><a href="#field_summary">Field</a> | </li> 682<li><a href="#constructor_summary">Constr</a> | </li> 683<li><a href="#method_summary">Method</a></li> 684</ul> 685<ul class="subNavList"> 686<li>Detail: </li> 687<li><a href="#field_detail">Field</a> | </li> 688<li><a href="#constructor_detail">Constr</a> | </li> 689<li><a href="#method_detail">Method</a></li> 690</ul> 691</div> 692<a name="skip-navbar_bottom"> 693<!-- --> 694</a></div> 695<!-- ======== END OF BOTTOM NAVBAR ======= --> 696<p class="legalCopy"><small>Copyright © 2014-2015 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 697</body> 698</html> 699