1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Tue Oct 09 17:08:05 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8BeanProperty (jackson-databind 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-09"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="BeanProperty (jackson-databind 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BeanProperty.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="BeanProperty.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.fasterxml.jackson.databind</FONT> 93<BR> 94Interface BeanProperty</H2> 95<DL> 96<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</A></DD> 97</DL> 98<DL> 99<DT><B>All Known Implementing Classes:</B> <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> 100</DL> 101<HR> 102<DL> 103<DT><PRE>public interface <B>BeanProperty</B><DT>extends <A HREF="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</A></DL> 104</PRE> 105 106<P> 107Bean properties are logical entities that represent data 108 that Java objects (POJOs (Plain Old Java Objects), sometimes also called "beans") 109 contain; and that are accessed using accessors (methods like getters 110 and setters, fields, contstructor parametrers). 111 Instances allow access to annotations directly associated 112 to property (via field or method), as well as contextual 113 annotations (annotations for class that contains properties). 114<p> 115 Instances are not typically passed when constructing serializers 116 and deserializers, but rather only passed when context 117 is known when 118 <A HREF="../../../../com/fasterxml/jackson/databind/ser/ContextualSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><CODE>ContextualSerializer</CODE></A> and 119 <A HREF="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><CODE>ContextualDeserializer</CODE></A> 120 resolution occurs (<code>createContextual(...)</code> method is called). 121 References may (need to) be retained by serializers and deserializers, 122 especially when further resolving dependant handlers like value 123 serializers/deserializers or structured types. 124<P> 125 126<P> 127<HR> 128 129<P> 130<!-- ======== NESTED CLASS SUMMARY ======== --> 131 132<A NAME="nested_class_summary"><!-- --></A> 133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 136<B>Nested Class Summary</B></FONT></TH> 137</TR> 138<TR BGCOLOR="white" CLASS="TableRowColor"> 139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 140<CODE>static class</CODE></FONT></TD> 141<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</A></B></CODE> 142 143<BR> 144 Simple stand-alone implementation, useful as a placeholder 145 or base class for more complex implementations.</TD> 146</TR> 147</TABLE> 148 149<!-- ========== METHOD SUMMARY =========== --> 150 151<A NAME="method_summary"><!-- --></A> 152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 155<B>Method Summary</B></FONT></TH> 156</TR> 157<TR BGCOLOR="white" CLASS="TableRowColor"> 158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 159<CODE> 160<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 161<TR ALIGN="right" VALIGN=""> 162<TD NOWRAP><FONT SIZE="-1"> 163<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>> 164<BR> 165A</CODE></FONT></TD> 166</TR> 167</TABLE> 168</CODE></FONT></TD> 169<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation(java.lang.Class)">getAnnotation</A></B>(<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> 170 171<BR> 172 Method for finding annotation associated with this property; 173 meaning annotation associated with one of entities used to 174 access property.</TD> 175</TR> 176<TR BGCOLOR="white" CLASS="TableRowColor"> 177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 178<CODE> 179<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY=""> 180<TR ALIGN="right" VALIGN=""> 181<TD NOWRAP><FONT SIZE="-1"> 182<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>> 183<BR> 184A</CODE></FONT></TD> 185</TR> 186</TABLE> 187</CODE></FONT></TD> 188<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation(java.lang.Class)">getContextAnnotation</A></B>(<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> 189 190<BR> 191 Method for finding annotation associated with context of 192 this property; usually class in which member is declared 193 (or its subtype if processing subtype).</TD> 194</TR> 195<TR BGCOLOR="white" CLASS="TableRowColor"> 196<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 197<CODE> <A HREF="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A></CODE></FONT></TD> 198<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember()">getMember</A></B>()</CODE> 199 200<BR> 201 Method for accessing primary physical entity that represents the property; 202 annotated field, method or constructor property.</TD> 203</TR> 204<TR BGCOLOR="white" CLASS="TableRowColor"> 205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 206<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></FONT></TD> 207<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName()">getName</A></B>()</CODE> 208 209<BR> 210 Method to get logical name of the property</TD> 211</TR> 212<TR BGCOLOR="white" CLASS="TableRowColor"> 213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 214<CODE> <A HREF="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</A></CODE></FONT></TD> 215<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType()">getType</A></B>()</CODE> 216 217<BR> 218 Method to get declared type of the property.</TD> 219</TR> 220</TABLE> 221 222<P> 223 224<!-- ============ METHOD DETAIL ========== --> 225 226<A NAME="method_detail"><!-- --></A> 227<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 228<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 229<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 230<B>Method Detail</B></FONT></TH> 231</TR> 232</TABLE> 233 234<A NAME="getName()"><!-- --></A><H3> 235getName</H3> 236<PRE> 237<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> <B>getName</B>()</PRE> 238<DL> 239<DD>Method to get logical name of the property 240<P> 241<DD><DL> 242<DT><B>Specified by:</B><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></DL> 243</DD> 244<DD><DL> 245</DL> 246</DD> 247</DL> 248<HR> 249 250<A NAME="getType()"><!-- --></A><H3> 251getType</H3> 252<PRE> 253<A HREF="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</A> <B>getType</B>()</PRE> 254<DL> 255<DD>Method to get declared type of the property. 256<P> 257<DD><DL> 258</DL> 259</DD> 260<DD><DL> 261</DL> 262</DD> 263</DL> 264<HR> 265 266<A NAME="getAnnotation(java.lang.Class)"><!-- --></A><H3> 267getAnnotation</H3> 268<PRE> 269<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 <B>getAnnotation</B>(<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> 270<DL> 271<DD>Method for finding annotation associated with this property; 272 meaning annotation associated with one of entities used to 273 access property. 274<P> 275<DD><DL> 276</DL> 277</DD> 278<DD><DL> 279</DL> 280</DD> 281</DL> 282<HR> 283 284<A NAME="getContextAnnotation(java.lang.Class)"><!-- --></A><H3> 285getContextAnnotation</H3> 286<PRE> 287<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 <B>getContextAnnotation</B>(<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> 288<DL> 289<DD>Method for finding annotation associated with context of 290 this property; usually class in which member is declared 291 (or its subtype if processing subtype). 292<P> 293<DD><DL> 294</DL> 295</DD> 296<DD><DL> 297</DL> 298</DD> 299</DL> 300<HR> 301 302<A NAME="getMember()"><!-- --></A><H3> 303getMember</H3> 304<PRE> 305<A HREF="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A> <B>getMember</B>()</PRE> 306<DL> 307<DD>Method for accessing primary physical entity that represents the property; 308 annotated field, method or constructor property. 309<P> 310<DD><DL> 311</DL> 312</DD> 313<DD><DL> 314</DL> 315</DD> 316</DL> 317<!-- ========= END OF CLASS DATA ========= --> 318<HR> 319 320 321<!-- ======= START OF BOTTOM NAVBAR ====== --> 322<A NAME="navbar_bottom"><!-- --></A> 323<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 324<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 325<TR> 326<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 327<A NAME="navbar_bottom_firstrow"><!-- --></A> 328<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 329 <TR ALIGN="center" VALIGN="top"> 330 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 331 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 332 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BeanProperty.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 334 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 335 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 336 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 337 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 338 </TR> 339</TABLE> 340</TD> 341<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 342</EM> 343</TD> 344</TR> 345 346<TR> 347<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 348 <A HREF="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 349 <A HREF="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 350<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 351 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top"><B>FRAMES</B></A> 352 <A HREF="BeanProperty.html" target="_top"><B>NO FRAMES</B></A> 353 <SCRIPT type="text/javascript"> 354 <!-- 355 if(window==top) { 356 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 357 } 358 //--> 359</SCRIPT> 360<NOSCRIPT> 361 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 362</NOSCRIPT> 363 364 365</FONT></TD> 366</TR> 367<TR> 368<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 369 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 370<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 371DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 372</TR> 373</TABLE> 374<A NAME="skip-navbar_bottom"></A> 375<!-- ======== END OF BOTTOM NAVBAR ======= --> 376 377<HR> 378Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 379</BODY> 380</HTML> 381