Interface BeanProperty
- All Superinterfaces:
Named
- All Known Implementing Classes:
AttributePropertyWriter
,BeanProperty.Bogus
,BeanProperty.Std
,BeanPropertyWriter
,ConcreteBeanPropertyBase
,CreatorProperty
,FieldProperty
,InnerClassProperty
,ManagedReferenceProperty
,MapProperty
,MergingSettableBeanProperty
,MethodProperty
,ObjectIdReferenceProperty
,ObjectIdValueProperty
,PropertyWriter
,SettableBeanProperty
,SettableBeanProperty.Delegating
,SetterlessProperty
,UnwrappingBeanPropertyWriter
,ValueInjector
,VirtualBeanPropertyWriter
Instances are not typically passed when constructing serializers
and deserializers, but rather only passed when context
is known when
ContextualSerializer
and
ContextualDeserializer
resolution occurs (createContextual(...)
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.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Alternative "Null" implementation that can be used in cases where a non-nullBeanProperty
is neededstatic class
Simple stand-alone implementation, useful as a placeholder or base class for more complex implementations. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
depositSchemaProperty
(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) Method that can be called to visit the type structure that this property is part of.findAliases
(MapperConfig<?> config) Method for accessing set of possible alternate names that are accepted during deserialization.Deprecated.findPropertyFormat
(MapperConfig<?> config, Class<?> baseType) Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settingsfindPropertyInclusion
(MapperConfig<?> config, Class<?> baseType) Convenience method that is roughly equivalent to<A extends Annotation>
AgetAnnotation
(Class<A> acls) Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.<A extends Annotation>
AgetContextAnnotation
(Class<A> acls) Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype).Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.Accessor for additional optional information about property.getName()
Method to get logical name of the propertygetType()
Method to get declared type of the property.If property is indicated to be wrapped, name of wrapper element to use.boolean
Whether value for property is marked as required using annotations or associated schema.boolean
Accessor for checking whether there is an actual physical property behind this property abstraction or not.
-
Field Details
-
EMPTY_FORMAT
-
EMPTY_INCLUDE
-
-
Method Details
-
getName
String getName()Method to get logical name of the property -
getFullName
PropertyName getFullName()Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).- Since:
- 2.3
-
getType
JavaType getType()Method to get declared type of the property. -
getWrapperName
PropertyName getWrapperName()If property is indicated to be wrapped, name of wrapper element to use.- Since:
- 2.2
-
getMetadata
PropertyMetadata getMetadata()Accessor for additional optional information about property.- Returns:
- Metadata about property; never null.
- Since:
- 2.3
-
isRequired
boolean isRequired()Whether value for property is marked as required using annotations or associated schema. Equivalent to:getMetadata().isRequired()
- Since:
- 2.2
-
isVirtual
boolean isVirtual()Accessor for checking whether there is an actual physical property behind this property abstraction or not.- Since:
- 2.7
-
getAnnotation
Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.Note that this method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate
AnnotationIntrospector
s) should be accessed throughAnnotationIntrospector
. -
getContextAnnotation
Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype).Note that this method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate
AnnotationIntrospector
s) should be accessed throughAnnotationIntrospector
. -
getMember
AnnotatedMember getMember()Method for accessing primary physical entity that represents the property; annotated field, method or constructor property. -
findFormatOverrides
Deprecated.Convenience method that is roughly equivalent toreturn intr.findFormat(getMember());
and specifically does NOT try to find per-type format defaults to merge; usefindPropertyFormat(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)
if such defaults would be useful.- Since:
- 2.6
-
findPropertyFormat
Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings- Since:
- 2.7
-
findPropertyInclusion
Convenience method that is roughly equivalent toreturn config.getAnnotationIntrospector().findPropertyInclusion(getMember());
but also considers global default settings for inclusion- Since:
- 2.7
-
findAliases
Method for accessing set of possible alternate names that are accepted during deserialization.- Returns:
- List (possibly empty) of alternate names; never null
- Since:
- 2.9
-
depositSchemaProperty
void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException 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 throwUnsupportedOperationException
.NOTE: Starting with 2.7, takes explicit
SerializerProvider
argument to reduce the need to rely on provider visitor may or may not have assigned.- Parameters:
objectVisitor
- Visitor to used as the callback handler- Throws:
JsonMappingException
- Since:
- 2.2 (although signature did change in 2.7)
-
findPropertyFormat(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>)
instead.