<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_162) on Tue Jan 23 20:22:11 PST 2018 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>BeanProperty (jackson-databind 2.9.0 API)</title> <meta name="date" content="2018-01-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="BeanProperty (jackson-databind 2.9.0 API)"; } } catch(err) { } //--> var methods = {"i0":6,"i1":6,"i2":38,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/BeanProperty.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Bogus.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top">Frames</a></li> <li><a href="BeanProperty.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.fasterxml.jackson.databind</div> <h2 title="Interface BeanProperty" class="title">Interface BeanProperty</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Superinterfaces:</dt> <dd><a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></dd> </dl> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../com/fasterxml/jackson/databind/ser/impl/AttributePropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser.impl">AttributePropertyWriter</a>, <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Bogus.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Bogus</a>, <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/introspect/ConcreteBeanPropertyBase.html" title="class in com.fasterxml.jackson.databind.introspect">ConcreteBeanPropertyBase</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/ser/std/MapProperty.html" title="class in com.fasterxml.jackson.databind.ser.std">MapProperty</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/MergingSettableBeanProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">MergingSettableBeanProperty</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/ObjectIdReferenceProperty.html" title="class in com.fasterxml.jackson.databind.deser.impl">ObjectIdReferenceProperty</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/ser/PropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">PropertyWriter</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/SettableBeanProperty.Delegating.html" title="class in com.fasterxml.jackson.databind.deser">SettableBeanProperty.Delegating</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>, <a href="../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a></dd> </dl> <hr> <br> <pre>public interface <span class="typeNameLabel">BeanProperty</span> extends <a href="../../../../com/fasterxml/jackson/databind/util/Named.html" title="interface in com.fasterxml.jackson.databind.util">Named</a></pre> <div class="block">Bean properties are logical entities that represent data that Java objects (POJOs (Plain Old Java Objects), sometimes also called "beans") contain; and that are accessed using accessors (methods like getters and setters, fields, constructor parameters). Instances allow access to annotations directly associated to property (via field or method), as well as contextual annotations (annotations for class that contains properties). <p> Instances are not typically passed when constructing serializers and deserializers, but rather only passed when context is known when <a href="../../../../com/fasterxml/jackson/databind/ser/ContextualSerializer.html" title="interface in com.fasterxml.jackson.databind.ser"><code>ContextualSerializer</code></a> and <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a> resolution occurs (<code>createContextual(...)</code> method is called). References may (need to) be retained by serializers and deserializers, especially when further resolving dependent handlers like value serializers/deserializers or structured types.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested.class.summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Interface and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Bogus.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Bogus</a></span></code> <div class="block">Alternative "Null" implementation that can be used in cases where a non-null <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><code>BeanProperty</code></a> is needed</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></span></code> <div class="block">Simple stand-alone implementation, useful as a placeholder or base class for more complex implementations.</div> </td> </tr> </table> </li> </ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#EMPTY_FORMAT">EMPTY_FORMAT</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#EMPTY_INCLUDE">EMPTY_INCLUDE</a></span></code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#depositSchemaProperty-com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor-com.fasterxml.jackson.databind.SerializerProvider-">depositSchemaProperty</a></span>(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor, <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider)</code> <div class="block">Method that can be called to visit the type structure that this property is part of.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findAliases-com.fasterxml.jackson.databind.cfg.MapperConfig-">findAliases</a></span>(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config)</code> <div class="block">Method for accessing set of possible alternate names that are accepted during deserialization.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findFormatOverrides-com.fasterxml.jackson.databind.AnnotationIntrospector-">findFormatOverrides</a></span>(<a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector</a> intr)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">since 2.8 use <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-"><code>findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)</code></a> instead.</span></div> </div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-">findPropertyFormat</a></span>(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> baseType)</code> <div class="block">Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyInclusion-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-">findPropertyInclusion</a></span>(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> baseType)</code> <div class="block">Convenience method that is roughly equivalent to</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code><A extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>><br>A</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getAnnotation-java.lang.Class-">getAnnotation</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> <div class="block">Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><A extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>><br>A</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getContextAnnotation-java.lang.Class-">getContextAnnotation</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</code> <div class="block">Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype).</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getFullName--">getFullName</a></span>()</code> <div class="block">Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).</div> </td> </tr> <tr id="i8" class="altColor"> <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> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMember--">getMember</a></span>()</code> <div class="block">Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getMetadata--">getMetadata</a></span>()</code> <div class="block">Accessor for additional optional information about property.</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getName--">getName</a></span>()</code> <div class="block">Method to get logical name of the property</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getType--">getType</a></span>()</code> <div class="block">Method to get declared type of the property.</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#getWrapperName--">getWrapperName</a></span>()</code> <div class="block">If property is indicated to be wrapped, name of wrapper element to use.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isRequired--">isRequired</a></span>()</code> <div class="block">Whether value for property is marked as required using annotations or associated schema.</div> </td> </tr> <tr id="i14" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#isVirtual--">isVirtual</a></span>()</code> <div class="block">Accessor for checking whether there is an actual physical property behind this property abstraction or not.</div> </td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="EMPTY_FORMAT"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>EMPTY_FORMAT</h4> <pre>static final <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a> EMPTY_FORMAT</pre> </li> </ul> <a name="EMPTY_INCLUDE"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>EMPTY_INCLUDE</h4> <pre>static final <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a> EMPTY_INCLUDE</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getName</h4> <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> <div class="block">Method to get logical name of the property</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <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> </dl> </li> </ul> <a name="getFullName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFullName</h4> <pre><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getFullName()</pre> <div class="block">Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3</dd> </dl> </li> </ul> <a name="getType--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getType</h4> <pre><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a> getType()</pre> <div class="block">Method to get declared type of the property.</div> </li> </ul> <a name="getWrapperName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getWrapperName</h4> <pre><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a> getWrapperName()</pre> <div class="block">If property is indicated to be wrapped, name of wrapper element to use.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.2</dd> </dl> </li> </ul> <a name="getMetadata--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMetadata</h4> <pre><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a> getMetadata()</pre> <div class="block">Accessor for additional optional information about property.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Metadata about property; never null.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3</dd> </dl> </li> </ul> <a name="isRequired--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isRequired</h4> <pre>boolean isRequired()</pre> <div class="block">Whether value for property is marked as required using annotations or associated schema. Equivalent to: <code> getMetadata().isRequired() </code></div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.2</dd> </dl> </li> </ul> <a name="isVirtual--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isVirtual</h4> <pre>boolean isVirtual()</pre> <div class="block">Accessor for checking whether there is an actual physical property behind this property abstraction or not.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.7</dd> </dl> </li> </ul> <a name="getAnnotation-java.lang.Class-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getAnnotation</h4> <pre><A extends <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> <div class="block">Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property. <p> Note that this method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>s) should be accessed through <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>.</div> </li> </ul> <a name="getContextAnnotation-java.lang.Class-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getContextAnnotation</h4> <pre><A extends <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><A> acls)</pre> <div class="block">Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype). <p> Note that this method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>s) should be accessed through <a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><code>AnnotationIntrospector</code></a>.</div> </li> </ul> <a name="getMember--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMember</h4> <pre><a href="../../../../com/fasterxml/jackson/databind/introspect/AnnotatedMember.html" title="class in com.fasterxml.jackson.databind.introspect">AnnotatedMember</a> getMember()</pre> <div class="block">Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.</div> </li> </ul> <a name="findFormatOverrides-com.fasterxml.jackson.databind.AnnotationIntrospector-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findFormatOverrides</h4> <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a> findFormatOverrides(<a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector</a> intr)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 2.8 use <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-"><code>findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)</code></a> instead.</span></div> <div class="block">Convenience method that is roughly equivalent to <pre> return intr.findFormat(getMember()); </pre> and specifically does NOT try to find per-type format defaults to merge; use <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html#findPropertyFormat-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-"><code>findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)</code></a> if such defaults would be useful.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.6</dd> </dl> </li> </ul> <a name="findPropertyFormat-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findPropertyFormat</h4> <pre><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonFormat.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonFormat.Value</a> findPropertyFormat(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> baseType)</pre> <div class="block">Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.7</dd> </dl> </li> </ul> <a name="findPropertyInclusion-com.fasterxml.jackson.databind.cfg.MapperConfig-java.lang.Class-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findPropertyInclusion</h4> <pre><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.Value.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Value</a> findPropertyInclusion(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> baseType)</pre> <div class="block">Convenience method that is roughly equivalent to <pre> return config.getAnnotationIntrospector().findPropertyInclusion(getMember()); </pre> but also considers global default settings for inclusion</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.7</dd> </dl> </li> </ul> <a name="findAliases-com.fasterxml.jackson.databind.cfg.MapperConfig-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findAliases</h4> <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a>> findAliases(<a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html" title="class in com.fasterxml.jackson.databind.cfg">MapperConfig</a><?> config)</pre> <div class="block">Method for accessing set of possible alternate names that are accepted during deserialization.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>List (possibly empty) of alternate names; never null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.9</dd> </dl> </li> </ul> <a name="depositSchemaProperty-com.fasterxml.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor-com.fasterxml.jackson.databind.SerializerProvider-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>depositSchemaProperty</h4> <pre>void depositSchemaProperty(<a href="../../../../com/fasterxml/jackson/databind/jsonFormatVisitors/JsonObjectFormatVisitor.html" title="interface in com.fasterxml.jackson.databind.jsonFormatVisitors">JsonObjectFormatVisitor</a> objectVisitor, <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a> provider) throws <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> <div class="block">Method that can be called to visit the type structure that this property is part of. Note that not all implementations support traversal with this method; those that do not should throw <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>. <p> NOTE: Starting with 2.7, takes explicit <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a> argument to reduce the need to rely on provider visitor may or may not have assigned.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>objectVisitor</code> - Visitor to used as the callback handler</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.2 (although signature did change in 2.7)</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/BeanProperty.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Bogus.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/databind/BeanProperty.html" target="_top">Frames</a></li> <li><a href="BeanProperty.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> </body> </html>