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:16 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8BeanPropertyDefinition (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="BeanPropertyDefinition (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/BeanPropertyDefinition.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/introspect/BasicClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><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/introspect/BeanPropertyDefinition.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="BeanPropertyDefinition.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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.introspect</FONT> 93<BR> 94Class BeanPropertyDefinition</H2> 95<PRE> 96<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> 97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition</B> 98</PRE> 99<DL> 100<DT><B>All Implemented Interfaces:</B> <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><B>Direct Known Subclasses:</B> <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> 104</DL> 105<HR> 106<DL> 107<DT><PRE>public abstract class <B>BeanPropertyDefinition</B><DT>extends <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><DT>implements <A HREF="../../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</A></DL> 108</PRE> 109 110<P> 111Simple 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. 118<P> 119 120<P> 121<HR> 122 123<P> 124 125<!-- ======== CONSTRUCTOR SUMMARY ======== --> 126 127<A NAME="constructor_summary"><!-- --></A> 128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131<B>Constructor Summary</B></FONT></TH> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#BeanPropertyDefinition()">BeanPropertyDefinition</A></B>()</CODE> 135 136<BR> 137 </TD> 138</TR> 139</TABLE> 140 141<!-- ========== METHOD SUMMARY =========== --> 142 143<A NAME="method_summary"><!-- --></A> 144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 147<B>Method Summary</B></FONT></TH> 148</TR> 149<TR BGCOLOR="white" CLASS="TableRowColor"> 150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 151<CODE> boolean</CODE></FONT></TD> 152<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#couldDeserialize()">couldDeserialize</A></B>()</CODE> 153 154<BR> 155 </TD> 156</TR> 157<TR BGCOLOR="white" CLASS="TableRowColor"> 158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 159<CODE> boolean</CODE></FONT></TD> 160<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#couldSerialize()">couldSerialize</A></B>()</CODE> 161 162<BR> 163 </TD> 164</TR> 165<TR BGCOLOR="white" CLASS="TableRowColor"> 166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 167<CODE> <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ObjectIdInfo.html" title="class in com.fasterxml.jackson.databind.introspect">ObjectIdInfo</A></CODE></FONT></TD> 168<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findObjectIdInfo()">findObjectIdInfo</A></B>()</CODE> 169 170<BR> 171 Method used to check whether this logical property indicates that 172 value POJOs should be written using additional Object Identifier 173 (or, when multiple references exist, all but first AS Object Identifier).</TD> 174</TR> 175<TR BGCOLOR="white" CLASS="TableRowColor"> 176<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 177<CODE> <A HREF="../../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</A></CODE></FONT></TD> 178<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findReferenceType()">findReferenceType</A></B>()</CODE> 179 180<BR> 181 Method used to find whether property is part of a bi-directional 182 reference.</TD> 183</TR> 184<TR BGCOLOR="white" CLASS="TableRowColor"> 185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 186<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></FONT></TD> 187<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#findViews()">findViews</A></B>()</CODE> 188 189<BR> 190 Method used to find View-inclusion definitions for the property.</TD> 191</TR> 192<TR BGCOLOR="white" CLASS="TableRowColor"> 193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 194<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A></CODE></FONT></TD> 195<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getAccessor()">getAccessor</A></B>()</CODE> 196 197<BR> 198 Method used to find accessor (getter, field to access) to use for accessing 199 value of the property.</TD> 200</TR> 201<TR BGCOLOR="white" CLASS="TableRowColor"> 202<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 203<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</A></CODE></FONT></TD> 204<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getConstructorParameter()">getConstructorParameter</A></B>()</CODE> 205 206<BR> 207 </TD> 208</TR> 209<TR BGCOLOR="white" CLASS="TableRowColor"> 210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 211<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedField.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedField</A></CODE></FONT></TD> 212<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getField()">getField</A></B>()</CODE> 213 214<BR> 215 </TD> 216</TR> 217<TR BGCOLOR="white" CLASS="TableRowColor"> 218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 219<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A></CODE></FONT></TD> 220<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getGetter()">getGetter</A></B>()</CODE> 221 222<BR> 223 </TD> 224</TR> 225<TR BGCOLOR="white" CLASS="TableRowColor"> 226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 227<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></FONT></TD> 228<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getInternalName()">getInternalName</A></B>()</CODE> 229 230<BR> 231 Accessor that can be used to determine implicit name from underlying 232 element(s) before possible renaming.</TD> 233</TR> 234<TR BGCOLOR="white" CLASS="TableRowColor"> 235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 236<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A></CODE></FONT></TD> 237<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getMutator()">getMutator</A></B>()</CODE> 238 239<BR> 240 Method used to find mutator (constructor parameter, setter, field) to use for 241 changing value of the property.</TD> 242</TR> 243<TR BGCOLOR="white" CLASS="TableRowColor"> 244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 245<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></FONT></TD> 246<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()">getName</A></B>()</CODE> 247 248<BR> 249 Accessor for name used for external representation (in JSON).</TD> 250</TR> 251<TR BGCOLOR="white" CLASS="TableRowColor"> 252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 253<CODE> <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A></CODE></FONT></TD> 254<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getPrimaryMember()">getPrimaryMember</A></B>()</CODE> 255 256<BR> 257 Method used to find the property member (getter, setter, field) that has 258 the highest precedence in current context (getter method when serializing, 259 if available, and so forth), if any.</TD> 260</TR> 261<TR BGCOLOR="white" CLASS="TableRowColor"> 262<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 263<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A></CODE></FONT></TD> 264<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getSetter()">getSetter</A></B>()</CODE> 265 266<BR> 267 </TD> 268</TR> 269<TR BGCOLOR="white" CLASS="TableRowColor"> 270<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 271<CODE>abstract boolean</CODE></FONT></TD> 272<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasConstructorParameter()">hasConstructorParameter</A></B>()</CODE> 273 274<BR> 275 </TD> 276</TR> 277<TR BGCOLOR="white" CLASS="TableRowColor"> 278<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 279<CODE>abstract boolean</CODE></FONT></TD> 280<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasField()">hasField</A></B>()</CODE> 281 282<BR> 283 </TD> 284</TR> 285<TR BGCOLOR="white" CLASS="TableRowColor"> 286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 287<CODE>abstract boolean</CODE></FONT></TD> 288<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasGetter()">hasGetter</A></B>()</CODE> 289 290<BR> 291 </TD> 292</TR> 293<TR BGCOLOR="white" CLASS="TableRowColor"> 294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 295<CODE>abstract boolean</CODE></FONT></TD> 296<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#hasSetter()">hasSetter</A></B>()</CODE> 297 298<BR> 299 </TD> 300</TR> 301<TR BGCOLOR="white" CLASS="TableRowColor"> 302<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 303<CODE>abstract boolean</CODE></FONT></TD> 304<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isExplicitlyIncluded()">isExplicitlyIncluded</A></B>()</CODE> 305 306<BR> 307 Accessor that can be called to check whether property was included 308 due to an explicit marker (usually annotation), or just by naming 309 convention.</TD> 310</TR> 311<TR BGCOLOR="white" CLASS="TableRowColor"> 312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 313<CODE> boolean</CODE></FONT></TD> 314<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isRequired()">isRequired</A></B>()</CODE> 315 316<BR> 317 Method used to check if this property is expected to have a value; 318 and if none found, should either be considered invalid (and most likely 319 fail deserialization), or handled by other means (by providing default 320 value)</TD> 321</TR> 322<TR BGCOLOR="white" CLASS="TableRowColor"> 323<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 324<CODE> boolean</CODE></FONT></TD> 325<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#isTypeId()">isTypeId</A></B>()</CODE> 326 327<BR> 328 Method used to check whether this logical property has a marker 329 to indicate it should be used as the type id for polymorphic type 330 handling.</TD> 331</TR> 332<TR BGCOLOR="white" CLASS="TableRowColor"> 333<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 334<CODE>abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</A></CODE></FONT></TD> 335<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#withName(java.lang.String)">withName</A></B>(<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> 336 337<BR> 338 Method that can be used to create a definition with 339 same settings as this one, but with different 340 (external) name; that is, one for which 341 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()"><CODE>getName()</CODE></A> would return <code>newName</code>.</TD> 342</TR> 343</TABLE> 344 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 345<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 346<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 347<TH ALIGN="left"><B>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></B></TH> 348</TR> 349<TR BGCOLOR="white" CLASS="TableRowColor"> 350<TD><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></TD> 351</TR> 352</TABLE> 353 354<P> 355 356<!-- ========= CONSTRUCTOR DETAIL ======== --> 357 358<A NAME="constructor_detail"><!-- --></A> 359<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 360<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 361<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 362<B>Constructor Detail</B></FONT></TH> 363</TR> 364</TABLE> 365 366<A NAME="BeanPropertyDefinition()"><!-- --></A><H3> 367BeanPropertyDefinition</H3> 368<PRE> 369public <B>BeanPropertyDefinition</B>()</PRE> 370<DL> 371</DL> 372 373<!-- ============ METHOD DETAIL ========== --> 374 375<A NAME="method_detail"><!-- --></A> 376<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 377<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 378<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 379<B>Method Detail</B></FONT></TH> 380</TR> 381</TABLE> 382 383<A NAME="withName(java.lang.String)"><!-- --></A><H3> 384withName</H3> 385<PRE> 386public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" title="class in com.fasterxml.jackson.databind.introspect">BeanPropertyDefinition</A> <B>withName</B>(<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> 387<DL> 388<DD>Method that can be used to create a definition with 389 same settings as this one, but with different 390 (external) name; that is, one for which 391 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html#getName()"><CODE>getName()</CODE></A> would return <code>newName</code>. 392<P> 393<DD><DL> 394</DL> 395</DD> 396<DD><DL> 397</DL> 398</DD> 399</DL> 400<HR> 401 402<A NAME="getName()"><!-- --></A><H3> 403getName</H3> 404<PRE> 405public 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> <B>getName</B>()</PRE> 406<DL> 407<DD>Accessor for name used for external representation (in JSON). 408<P> 409<DD><DL> 410<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> 411</DD> 412<DD><DL> 413</DL> 414</DD> 415</DL> 416<HR> 417 418<A NAME="getInternalName()"><!-- --></A><H3> 419getInternalName</H3> 420<PRE> 421public 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> <B>getInternalName</B>()</PRE> 422<DL> 423<DD>Accessor that can be used to determine implicit name from underlying 424 element(s) before possible renaming. This is the "internal" 425 name derived from accessor ("x" from "getX"), and is not based on 426 annotations or naming strategy. 427<P> 428<DD><DL> 429</DL> 430</DD> 431<DD><DL> 432</DL> 433</DD> 434</DL> 435<HR> 436 437<A NAME="isExplicitlyIncluded()"><!-- --></A><H3> 438isExplicitlyIncluded</H3> 439<PRE> 440public abstract boolean <B>isExplicitlyIncluded</B>()</PRE> 441<DL> 442<DD>Accessor that can be called to check whether property was included 443 due to an explicit marker (usually annotation), or just by naming 444 convention. 445<P> 446<DD><DL> 447</DL> 448</DD> 449<DD><DL> 450 451<DT><B>Returns:</B><DD>True if property was explicitly included (usually by having 452 one of components being annotated); false if inclusion was purely 453 due to naming or visibility definitions (that is, implicit)</DL> 454</DD> 455</DL> 456<HR> 457 458<A NAME="couldDeserialize()"><!-- --></A><H3> 459couldDeserialize</H3> 460<PRE> 461public boolean <B>couldDeserialize</B>()</PRE> 462<DL> 463<DD><DL> 464</DL> 465</DD> 466<DD><DL> 467</DL> 468</DD> 469</DL> 470<HR> 471 472<A NAME="couldSerialize()"><!-- --></A><H3> 473couldSerialize</H3> 474<PRE> 475public boolean <B>couldSerialize</B>()</PRE> 476<DL> 477<DD><DL> 478</DL> 479</DD> 480<DD><DL> 481</DL> 482</DD> 483</DL> 484<HR> 485 486<A NAME="hasGetter()"><!-- --></A><H3> 487hasGetter</H3> 488<PRE> 489public abstract boolean <B>hasGetter</B>()</PRE> 490<DL> 491<DD><DL> 492</DL> 493</DD> 494<DD><DL> 495</DL> 496</DD> 497</DL> 498<HR> 499 500<A NAME="hasSetter()"><!-- --></A><H3> 501hasSetter</H3> 502<PRE> 503public abstract boolean <B>hasSetter</B>()</PRE> 504<DL> 505<DD><DL> 506</DL> 507</DD> 508<DD><DL> 509</DL> 510</DD> 511</DL> 512<HR> 513 514<A NAME="hasField()"><!-- --></A><H3> 515hasField</H3> 516<PRE> 517public abstract boolean <B>hasField</B>()</PRE> 518<DL> 519<DD><DL> 520</DL> 521</DD> 522<DD><DL> 523</DL> 524</DD> 525</DL> 526<HR> 527 528<A NAME="hasConstructorParameter()"><!-- --></A><H3> 529hasConstructorParameter</H3> 530<PRE> 531public abstract boolean <B>hasConstructorParameter</B>()</PRE> 532<DL> 533<DD><DL> 534</DL> 535</DD> 536<DD><DL> 537</DL> 538</DD> 539</DL> 540<HR> 541 542<A NAME="getGetter()"><!-- --></A><H3> 543getGetter</H3> 544<PRE> 545public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A> <B>getGetter</B>()</PRE> 546<DL> 547<DD><DL> 548</DL> 549</DD> 550<DD><DL> 551</DL> 552</DD> 553</DL> 554<HR> 555 556<A NAME="getSetter()"><!-- --></A><H3> 557getSetter</H3> 558<PRE> 559public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMethod.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMethod</A> <B>getSetter</B>()</PRE> 560<DL> 561<DD><DL> 562</DL> 563</DD> 564<DD><DL> 565</DL> 566</DD> 567</DL> 568<HR> 569 570<A NAME="getField()"><!-- --></A><H3> 571getField</H3> 572<PRE> 573public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedField.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedField</A> <B>getField</B>()</PRE> 574<DL> 575<DD><DL> 576</DL> 577</DD> 578<DD><DL> 579</DL> 580</DD> 581</DL> 582<HR> 583 584<A NAME="getConstructorParameter()"><!-- --></A><H3> 585getConstructorParameter</H3> 586<PRE> 587public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedParameter.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedParameter</A> <B>getConstructorParameter</B>()</PRE> 588<DL> 589<DD><DL> 590</DL> 591</DD> 592<DD><DL> 593</DL> 594</DD> 595</DL> 596<HR> 597 598<A NAME="getAccessor()"><!-- --></A><H3> 599getAccessor</H3> 600<PRE> 601public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A> <B>getAccessor</B>()</PRE> 602<DL> 603<DD>Method used to find accessor (getter, field to access) to use for accessing 604 value of the property. 605 Null if no such member exists. 606<P> 607<DD><DL> 608</DL> 609</DD> 610<DD><DL> 611</DL> 612</DD> 613</DL> 614<HR> 615 616<A NAME="getMutator()"><!-- --></A><H3> 617getMutator</H3> 618<PRE> 619public abstract <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A> <B>getMutator</B>()</PRE> 620<DL> 621<DD>Method used to find mutator (constructor parameter, setter, field) to use for 622 changing value of the property. 623 Null if no such member exists. 624<P> 625<DD><DL> 626</DL> 627</DD> 628<DD><DL> 629</DL> 630</DD> 631</DL> 632<HR> 633 634<A NAME="getPrimaryMember()"><!-- --></A><H3> 635getPrimaryMember</H3> 636<PRE> 637public <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</A> <B>getPrimaryMember</B>()</PRE> 638<DL> 639<DD>Method used to find the property member (getter, setter, field) that has 640 the highest precedence in current context (getter method when serializing, 641 if available, and so forth), if any. 642<P> 643<DD><DL> 644</DL> 645</DD> 646<DD><DL> 647<DT><B>Since:</B></DT> 648 <DD>2.1</DD> 649</DL> 650</DD> 651</DL> 652<HR> 653 654<A NAME="findViews()"><!-- --></A><H3> 655findViews</H3> 656<PRE> 657public <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><?>[] <B>findViews</B>()</PRE> 658<DL> 659<DD>Method used to find View-inclusion definitions for the property. 660<P> 661<DD><DL> 662</DL> 663</DD> 664<DD><DL> 665</DL> 666</DD> 667</DL> 668<HR> 669 670<A NAME="findReferenceType()"><!-- --></A><H3> 671findReferenceType</H3> 672<PRE> 673public <A HREF="../../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</A> <B>findReferenceType</B>()</PRE> 674<DL> 675<DD>Method used to find whether property is part of a bi-directional 676 reference. 677<P> 678<DD><DL> 679</DL> 680</DD> 681<DD><DL> 682</DL> 683</DD> 684</DL> 685<HR> 686 687<A NAME="isTypeId()"><!-- --></A><H3> 688isTypeId</H3> 689<PRE> 690public boolean <B>isTypeId</B>()</PRE> 691<DL> 692<DD>Method used to check whether this logical property has a marker 693 to indicate it should be used as the type id for polymorphic type 694 handling. 695<P> 696<DD><DL> 697</DL> 698</DD> 699<DD><DL> 700</DL> 701</DD> 702</DL> 703<HR> 704 705<A NAME="findObjectIdInfo()"><!-- --></A><H3> 706findObjectIdInfo</H3> 707<PRE> 708public <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ObjectIdInfo.html" title="class in com.fasterxml.jackson.databind.introspect">ObjectIdInfo</A> <B>findObjectIdInfo</B>()</PRE> 709<DL> 710<DD>Method used to check whether this logical property indicates that 711 value POJOs should be written using additional Object Identifier 712 (or, when multiple references exist, all but first AS Object Identifier). 713<P> 714<DD><DL> 715</DL> 716</DD> 717<DD><DL> 718</DL> 719</DD> 720</DL> 721<HR> 722 723<A NAME="isRequired()"><!-- --></A><H3> 724isRequired</H3> 725<PRE> 726public boolean <B>isRequired</B>()</PRE> 727<DL> 728<DD>Method used to check if this property is expected to have a value; 729 and if none found, should either be considered invalid (and most likely 730 fail deserialization), or handled by other means (by providing default 731 value) 732<P> 733<DD><DL> 734</DL> 735</DD> 736<DD><DL> 737</DL> 738</DD> 739</DL> 740<!-- ========= END OF CLASS DATA ========= --> 741<HR> 742 743 744<!-- ======= START OF BOTTOM NAVBAR ====== --> 745<A NAME="navbar_bottom"><!-- --></A> 746<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 747<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 748<TR> 749<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 750<A NAME="navbar_bottom_firstrow"><!-- --></A> 751<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 752 <TR ALIGN="center" VALIGN="top"> 753 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 754 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 755 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 756 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BeanPropertyDefinition.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 757 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 758 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 759 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 760 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 761 </TR> 762</TABLE> 763</TD> 764<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 765</EM> 766</TD> 767</TR> 768 769<TR> 770<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 771 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/BasicClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>PREV CLASS</B></A> 772 <A HREF="../../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><B>NEXT CLASS</B></A></FONT></TD> 773<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 774 <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/introspect/BeanPropertyDefinition.html" target="_top"><B>FRAMES</B></A> 775 <A HREF="BeanPropertyDefinition.html" target="_top"><B>NO FRAMES</B></A> 776 <SCRIPT type="text/javascript"> 777 <!-- 778 if(window==top) { 779 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 780 } 781 //--> 782</SCRIPT> 783<NOSCRIPT> 784 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 785</NOSCRIPT> 786 787 788</FONT></TD> 789</TR> 790<TR> 791<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 792 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 793<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 794DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 795</TR> 796</TABLE> 797<A NAME="skip-navbar_bottom"></A> 798<!-- ======== END OF BOTTOM NAVBAR ======= --> 799 800<HR> 801Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 802</BODY> 803</HTML> 804
