Uses of Class
tools.jackson.databind.introspect.BeanPropertyDefinition
Packages that use BeanPropertyDefinition
Package
Description
Basic data binding (mapping) functionality that
allows for reading JSON content into Java Objects (POJOs)
and JSON Trees (
JsonNode
), as well as
writing Java Objects and trees as JSON.Package that contains most of configuration-related classes;
exception being couple of most-commonly used configuration
things (like Feature enumerations) that are at the
main level (
tools.jackson.databind
).Contains implementation classes of deserialization part of
data binding.
Contains those implementation classes of deserialization part of
data binding that are not considered part of public or semi-public
interfaces.
Functionality needed for Bean introspection, required for detecting
accessors and mutators for Beans, as well as locating and handling
method annotations.
Contains implementation classes of serialization part of
data binding.
Contains implementation classes of serialization part of
data binding.
Utility classes for Mapper package.
-
Uses of BeanPropertyDefinition in tools.jackson.databind
Methods in tools.jackson.databind that return types with arguments of type BeanPropertyDefinitionModifier and TypeMethodDescriptionabstract List<BeanPropertyDefinition>
BeanDescription.findBackReferences()
Method for locating all back-reference properties (setters, fields) bean hasabstract List<BeanPropertyDefinition>
BeanDescription.findProperties()
Methods in tools.jackson.databind with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionabstract Object
SerializationContext.includeFilterInstance
(BeanPropertyDefinition forProperty, Class<?> filterClass) Method that can be called to construct and configureJsonInclude
filter instance, given aClass
to instantiate (with default constructor, by default).<T> T
DeserializationContext.reportBadPropertyDefinition
(BeanDescription bean, BeanPropertyDefinition prop, String msg, Object... msgArgs) Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific property (of a type), unrelated to actual JSON content to map.<T> T
SerializationContext.reportBadPropertyDefinition
(BeanDescription bean, BeanPropertyDefinition prop, String message, Object... msgArgs) Helper method called to indicate problem in POJO (serialization) definitions or settings regarding specific property (of a type), unrelated to actual JSON content to map. -
Uses of BeanPropertyDefinition in tools.jackson.databind.cfg
Methods in tools.jackson.databind.cfg with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionHandlerInstantiator.includeFilterInstance
(SerializationConfig config, BeanPropertyDefinition forProperty, Class<?> filterClass) Method called to construct a Filter (any Object with implementation ofequals(Object)
that determines if given value is to be excluded (true) or included (false)) to be used based onJsonInclude
annotation (or equivalent). -
Uses of BeanPropertyDefinition in tools.jackson.databind.deser
Methods in tools.jackson.databind.deser that return types with arguments of type BeanPropertyDefinitionModifier and TypeMethodDescriptionprotected List<BeanPropertyDefinition>
BeanDeserializerFactory.filterBeanProps
(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder, List<BeanPropertyDefinition> propDefsIn, Set<String> ignored, Set<String> included) Helper method called to filter out explicit ignored properties, as well as properties that have "ignorable types".ValueDeserializerModifier.updateProperties
(DeserializationConfig config, BeanDescription beanDesc, List<BeanPropertyDefinition> propDefs) Method called byBeanDeserializerFactory
when it has collected initial list ofBeanPropertyDefinition
s, and done basic by-name and by-type filtering, but before constructing builder or actual property handlers; or arranging order.Methods in tools.jackson.databind.deser with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionprotected SettableBeanProperty
BeanDeserializerFactory.constructSettableProperty
(DeserializationContext ctxt, BeanDescription beanDesc, BeanPropertyDefinition propDef, JavaType propType0) Method that will construct a regular bean property setter using the given setter method.protected SettableBeanProperty
BeanDeserializerFactory.constructSetterlessProperty
(DeserializationContext ctxt, BeanDescription beanDesc, BeanPropertyDefinition propDef) Method that will construct a regular bean property setter using the given setter method.protected boolean
BeanDeserializerFactory.isIgnorableType
(DeserializationContext ctxt, BeanPropertyDefinition propDef, Class<?> type, Map<Class<?>, Boolean> ignoredTypes) Helper method that will check whether given raw type is marked as always ignorable (for purpose of ignoring properties with type)Method parameters in tools.jackson.databind.deser with type arguments of type BeanPropertyDefinitionModifier and TypeMethodDescriptionprotected List<BeanPropertyDefinition>
BeanDeserializerFactory.filterBeanProps
(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder, List<BeanPropertyDefinition> propDefsIn, Set<String> ignored, Set<String> included) Helper method called to filter out explicit ignored properties, as well as properties that have "ignorable types".ValueDeserializerModifier.updateProperties
(DeserializationConfig config, BeanDescription beanDesc, List<BeanPropertyDefinition> propDefs) Method called byBeanDeserializerFactory
when it has collected initial list ofBeanPropertyDefinition
s, and done basic by-name and by-type filtering, but before constructing builder or actual property handlers; or arranging order.Constructors in tools.jackson.databind.deser with parameters of type BeanPropertyDefinitionModifierConstructorDescriptionprotected
SettableBeanProperty
(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations) -
Uses of BeanPropertyDefinition in tools.jackson.databind.deser.bean
Fields in tools.jackson.databind.deser.bean declared as BeanPropertyDefinitionMethods in tools.jackson.databind.deser.bean that return BeanPropertyDefinitionMethods in tools.jackson.databind.deser.bean with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionstatic CreatorCandidate
CreatorCandidate.construct
(MapperConfig<?> config, AnnotatedWithParams creator, BeanPropertyDefinition[] propDefs) Constructors in tools.jackson.databind.deser.bean with parameters of type BeanPropertyDefinitionModifierConstructorDescription -
Uses of BeanPropertyDefinition in tools.jackson.databind.deser.impl
Constructors in tools.jackson.databind.deser.impl with parameters of type BeanPropertyDefinitionModifierConstructorDescriptionFieldProperty
(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedField field) MethodProperty
(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedMethod method) SetterlessProperty
(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedMethod method) -
Uses of BeanPropertyDefinition in tools.jackson.databind.exc
Fields in tools.jackson.databind.exc declared as BeanPropertyDefinitionModifier and TypeFieldDescriptionprotected BeanPropertyDefinition
InvalidDefinitionException._property
Methods in tools.jackson.databind.exc that return BeanPropertyDefinitionModifier and TypeMethodDescriptionInvalidDefinitionException.getProperty()
Accessor for property that had the definition problem if any (none, for example if the problem relates to type in general), if known.Methods in tools.jackson.databind.exc with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionstatic InvalidDefinitionException
InvalidDefinitionException.from
(tools.jackson.core.JsonGenerator g, String msg, BeanDescription bean, BeanPropertyDefinition prop) static InvalidDefinitionException
InvalidDefinitionException.from
(tools.jackson.core.JsonParser p, String msg, BeanDescription bean, BeanPropertyDefinition prop) Constructors in tools.jackson.databind.exc with parameters of type BeanPropertyDefinitionModifierConstructorDescriptionprotected
InvalidDefinitionException
(tools.jackson.core.JsonGenerator g, String msg, BeanDescription bean, BeanPropertyDefinition prop) protected
InvalidDefinitionException
(tools.jackson.core.JsonParser p, String msg, BeanDescription bean, BeanPropertyDefinition prop) -
Uses of BeanPropertyDefinition in tools.jackson.databind.introspect
Subclasses of BeanPropertyDefinition in tools.jackson.databind.introspectModifier and TypeClassDescriptionclass
Helper class used for aggregating information about a single potential POJO property.Fields in tools.jackson.databind.introspect with type parameters of type BeanPropertyDefinitionModifier and TypeFieldDescriptionprotected List<BeanPropertyDefinition>
BasicBeanDescription._properties
Properties collected for the POJO; initialized as needed.Methods in tools.jackson.databind.introspect that return BeanPropertyDefinitionModifier and TypeMethodDescriptionBasicBeanDescription.findProperty
(PropertyName name) PotentialCreator.propertyDefs()
abstract BeanPropertyDefinition
BeanPropertyDefinition.withName
(PropertyName newName) Method that can be used to create a definition with same settings as this one, but with different (external) name; that is, one for whichNamed.getName()
would returnnewName
.abstract BeanPropertyDefinition
BeanPropertyDefinition.withSimpleName
(String newSimpleName) Alternate "mutant factory" that will only change simple name, but leave other optional parts (like namespace) as is.Methods in tools.jackson.databind.introspect that return types with arguments of type BeanPropertyDefinitionModifier and TypeMethodDescriptionprotected List<BeanPropertyDefinition>
BasicBeanDescription._properties()
BasicBeanDescription.findBackReferences()
BasicBeanDescription.findProperties()
POJOPropertiesCollector.getProperties()
Methods in tools.jackson.databind.introspect with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionboolean
BasicBeanDescription.addProperty
(BeanPropertyDefinition def) Method parameters in tools.jackson.databind.introspect with type arguments of type BeanPropertyDefinitionModifier and TypeMethodDescriptionvoid
PotentialCreator.assignPropertyDefs
(List<? extends BeanPropertyDefinition> propertyDefs) -
Uses of BeanPropertyDefinition in tools.jackson.databind.ser
Methods in tools.jackson.databind.ser with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionprotected BeanPropertyWriter
PropertyBuilder._constructPropertyWriter
(BeanPropertyDefinition propDef, AnnotatedMember member, Annotations contextAnnotations, JavaType declaredType, ValueSerializer<?> ser, TypeSerializer typeSer, JavaType serType, boolean suppressNulls, Object suppressableValue, Class<?>[] includeInViews) Overridable factory method for actual construction ofBeanPropertyWriter
; often needed if subclassingPropertyBuilder.buildWriter(tools.jackson.databind.SerializationContext, tools.jackson.databind.introspect.BeanPropertyDefinition, tools.jackson.databind.JavaType, tools.jackson.databind.ValueSerializer<?>, tools.jackson.databind.jsontype.TypeSerializer, tools.jackson.databind.jsontype.TypeSerializer, tools.jackson.databind.introspect.AnnotatedMember, boolean)
method.protected BeanPropertyWriter
BeanSerializerFactory._constructWriter
(SerializationContext ctxt, BeanPropertyDefinition propDef, PropertyBuilder pb, boolean staticTyping, AnnotatedMember accessor) Secondary helper method for constructingBeanPropertyWriter
for given member (field or method).protected BeanPropertyWriter
PropertyBuilder.buildWriter
(SerializationContext ctxt, BeanPropertyDefinition propDef, JavaType declaredType, ValueSerializer<?> ser, TypeSerializer typeSer, TypeSerializer contentTypeSer, AnnotatedMember am, boolean defaultUseStaticTyping) SerializationContextExt.includeFilterInstance
(BeanPropertyDefinition forProperty, Class<?> filterClass) abstract VirtualBeanPropertyWriter
VirtualBeanPropertyWriter.withConfig
(MapperConfig<?> config, AnnotatedClass declaringClass, BeanPropertyDefinition propDef, JavaType type) Contextualization method called on a newly constructed virtual bean property.Method parameters in tools.jackson.databind.ser with type arguments of type BeanPropertyDefinitionModifier and TypeMethodDescriptionprotected void
BeanSerializerFactory.removeIgnorableTypes
(SerializationContext ctxt, BeanDescription beanDesc, List<BeanPropertyDefinition> properties) Method that will apply by-type limitations (as per [JACKSON-429]); by default this is based onJsonIgnoreType
annotation but can be supplied by module-provided introspectors too.protected void
BeanSerializerFactory.removeSetterlessGetters
(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyDefinition> properties) Helper method that will remove all properties that do not have a mutator.Constructors in tools.jackson.databind.ser with parameters of type BeanPropertyDefinitionModifierConstructorDescriptionBeanPropertyWriter
(BeanPropertyDefinition propDef, AnnotatedMember member, Annotations contextAnnotations, JavaType declaredType, ValueSerializer<?> ser, TypeSerializer typeSer, JavaType serType, boolean suppressNulls, Object suppressableValue, Class<?>[] includeInViews) protected
PropertyWriter
(BeanPropertyDefinition propDef) protected
VirtualBeanPropertyWriter
(BeanPropertyDefinition propDef, Annotations contextAnnotations, JavaType declaredType) Constructor used by most sub-types.protected
VirtualBeanPropertyWriter
(BeanPropertyDefinition propDef, Annotations contextAnnotations, JavaType declaredType, ValueSerializer<?> ser, TypeSerializer typeSer, JavaType serType, JsonInclude.Value inclusion, Class<?>[] includeInViews) Pass-through constructor that may be used by sub-classes that want full control over implementation. -
Uses of BeanPropertyDefinition in tools.jackson.databind.ser.impl
Methods in tools.jackson.databind.ser.impl with parameters of type BeanPropertyDefinitionModifier and TypeMethodDescriptionstatic AttributePropertyWriter
AttributePropertyWriter.construct
(String attrName, BeanPropertyDefinition propDef, Annotations contextAnnotations, JavaType declaredType) AttributePropertyWriter.withConfig
(MapperConfig<?> config, AnnotatedClass declaringClass, BeanPropertyDefinition propDef, JavaType type) Since this method should typically not be called on this sub-type, default implementation simply throws anIllegalStateException
.Constructors in tools.jackson.databind.ser.impl with parameters of type BeanPropertyDefinitionModifierConstructorDescriptionprotected
AttributePropertyWriter
(String attrName, BeanPropertyDefinition propDef, Annotations contextAnnotations, JavaType declaredType) protected
AttributePropertyWriter
(String attrName, BeanPropertyDefinition propDef, Annotations contextAnnotations, JavaType declaredType, JsonInclude.Value inclusion) -
Uses of BeanPropertyDefinition in tools.jackson.databind.util
Subclasses of BeanPropertyDefinition in tools.jackson.databind.utilModifier and TypeClassDescriptionclass
Simple immutableBeanPropertyDefinition
implementation that can be wrapped around aAnnotatedMember
that is a simple accessor (getter) or mutator (setter, constructor parameter) (or both, for fields).Methods in tools.jackson.databind.util that return BeanPropertyDefinitionModifier and TypeMethodDescriptionSimpleBeanPropertyDefinition.withInclusion
(JsonInclude.Value inclusion) SimpleBeanPropertyDefinition.withMetadata
(PropertyMetadata metadata) SimpleBeanPropertyDefinition.withName
(PropertyName newName) SimpleBeanPropertyDefinition.withSimpleName
(String newName)