Instances are not typically passed when constructing serializers
and deserializers, but rather only passed when context
is known when
com. and
com.
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.
| Modifier and Type | Class and Description |
|---|---|
| public static class | BeanProperty.
Alternative "Null" implementation that can be used in cases where a non-null
|
| public static class | BeanProperty.
Simple stand-alone implementation, useful as a placeholder or base class for more complex implementations. |
| Modifier and Type | Field and Description |
|---|---|
| public static final JsonFormat. | |
| public static final JsonInclude. |
| Modifier and Type | Method and Description |
|---|---|
| public void | depositSchemaProperty(JsonObjectFormatVisitor
Visitor to used as the callback handler objectVisitor, SerializerProvider provider)Method that can be called to visit the type structure that this property is part of. |
| public List | Returns: List (possibly empty) of alternate names; never nullMethod for accessing set of possible alternate names that are accepted during deserialization. |
| public JsonFormat. | findFormatOverrides(AnnotationIntrospector intr)
Deprecated
since 2.8 use
findPropertyFormat instead.
Convenience method that is roughly equivalent to return intr.findFormat(getMember()); |
| public JsonFormat. | findPropertyFormat(MapperConfig<?> config, Class<?> baseType)
Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings |
| public JsonInclude. | findPropertyInclusion(MapperConfig<?> config, Class<?> baseType)
Convenience method that is roughly equivalent to return config.getAnnotationIntrospector().findPropertyInclusion(getMember()); |
| public <A extends Annotation> A | getAnnotation(Class<A> acls)
Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property. |
| public <A extends Annotation> A | getContextAnnotation(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). |
| public PropertyName | getFullName()
Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend). |
| public AnnotatedMember | getMember()
Method for accessing primary physical entity that represents the property; annotated field, method or constructor property. |
| public PropertyMetadata | Returns: Metadata about property; never null.Accessor for additional optional information about property. |
| public String | getName()
Redeclares com. Method to get logical name of the property |
| public JavaType | |
| public PropertyName | |
| public boolean | isRequired()
Whether value for property is marked as required using annotations or associated schema. |
| public boolean | isVirtual()
Accessor for checking whether there is an actual physical property behind this property abstraction or not. |
| EMPTY_FORMAT | back to summary |
|---|---|
| public static final JsonFormat. | |
| EMPTY_INCLUDE | back to summary |
|---|---|
| public static final JsonInclude. | |
| depositSchemaProperty | back to summary |
|---|---|
| public 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 throw
Note Starting with 2.7, takes explicit
| |
| findAliases | back to summary |
|---|---|
| public List Method for accessing set of possible alternate names that are accepted during deserialization.
| |
| findFormatOverrides | back to summary |
|---|---|
| public JsonFormat. Deprecated since 2.8 use Convenience method that is roughly equivalent to return intr.findFormat(getMember());and specifically does NOT try to find per-type format defaults to merge; use findPropertyFormat if such defaults would be useful.
| |
| findPropertyFormat | back to summary |
|---|---|
| public JsonFormat. Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings
| |
| findPropertyInclusion | back to summary |
|---|---|
| public JsonInclude. Convenience method that is roughly equivalent to return config.getAnnotationIntrospector().findPropertyInclusion(getMember());but also considers global default settings for inclusion
| |
| getAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getAnnotation(Class<A> acls) 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 | |
| getContextAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getContextAnnotation(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).
Note that this method should only be called for custom annotations;
access to standard Jackson annotations (or ones supported by
alternate | |
| getFullName | back to summary |
|---|---|
| public PropertyName getFullName() Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
| |
| getMember | back to summary |
|---|---|
| public AnnotatedMember getMember() Method for accessing primary physical entity that represents the property; annotated field, method or constructor property. | |
| getMetadata | back to summary |
|---|---|
| public PropertyMetadata getMetadata() Accessor for additional optional information about property.
| |
| getName | back to summary |
|---|---|
| public String getName() Redeclares com. Method to get logical name of the property
| |
| getType | back to summary |
|---|---|
| public JavaType getType() Method to get declared type of the property. | |
| getWrapperName | back to summary |
|---|---|
| public PropertyName getWrapperName() If property is indicated to be wrapped, name of wrapper element to use.
| |
| isRequired | back to summary |
|---|---|
| public boolean isRequired() Whether value for property is marked as required using
annotations or associated schema.
Equivalent to:
| |
| isVirtual | back to summary |
|---|---|
| public boolean isVirtual() Accessor for checking whether there is an actual physical property behind this property abstraction or not.
| |
BeanProperty is needed
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | depositSchemaProperty(JsonObjectFormatVisitor
Visitor to used as the callback handler objectVisitor, SerializerProvider provider)Implements com. Method that can be called to visit the type structure that this property is part of. |
| public List | findAliases(MapperConfig<?> config)
Implements com. Method for accessing set of possible alternate names that are accepted during deserialization. |
| public JsonFormat. | findFormatOverrides(AnnotationIntrospector intr)
Implements com.
Deprecated
Convenience method that is roughly equivalent to return intr.findFormat(getMember()); |
| public JsonFormat. | findPropertyFormat(MapperConfig<?> config, Class<?> baseType)
Implements com. Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings |
| public JsonInclude. | findPropertyInclusion(MapperConfig<?> config, Class<?> baseType)
Implements com. Convenience method that is roughly equivalent to return config.getAnnotationIntrospector().findPropertyInclusion(getMember()); |
| public <A extends Annotation> A | getAnnotation(Class<A> acls)
Implements com. Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property. |
| public <A extends Annotation> A | getContextAnnotation(Class<A> acls)
Implements com. Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype). |
| public PropertyName | getFullName()
Implements com. Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend). |
| public AnnotatedMember | getMember()
Implements com. Method for accessing primary physical entity that represents the property; annotated field, method or constructor property. |
| public PropertyMetadata | getMetadata()
Implements com. Accessor for additional optional information about property. |
| public String | getName()
Implements com. Method to get logical name of the property |
| public JavaType | getType()
Implements com. Method to get declared type of the property. |
| public PropertyName | getWrapperName()
Implements com. If property is indicated to be wrapped, name of wrapper element to use. |
| public boolean | isRequired()
Implements com. Whether value for property is marked as required using annotations or associated schema. |
| public boolean | isVirtual()
Implements com. Accessor for checking whether there is an actual physical property behind this property abstraction or not. |
| Bogus | back to summary |
|---|---|
| public Bogus() | |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException Implements com. Doc from com. 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
Note Starting with 2.7, takes explicit
| |
| findAliases | back to summary |
|---|---|
| public List Implements com. Doc from com. Method for accessing set of possible alternate names that are accepted during deserialization.
| |
| findFormatOverrides | back to summary |
|---|---|
| public JsonFormat. Implements com. Doc from com. Deprecated
Convenience method that is roughly equivalent to return intr.findFormat(getMember());and specifically does NOT try to find per-type format defaults to merge; use findPropertyFormat if such defaults would be useful.
| |
| findPropertyFormat | back to summary |
|---|---|
| public JsonFormat. Implements com. Doc from com. Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings
| |
| findPropertyInclusion | back to summary |
|---|---|
| public JsonInclude. Implements com. Doc from com. Convenience method that is roughly equivalent to return config.getAnnotationIntrospector().findPropertyInclusion(getMember());but also considers global default settings for inclusion
| |
| getAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getAnnotation(Class<A> acls) Implements com. Doc from com. 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
| |
| getContextAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getContextAnnotation(Class<A> acls) Implements com. Doc from com. 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
| |
| getFullName | back to summary |
|---|---|
| public PropertyName getFullName() Implements com. Doc from com. Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
| |
| getMember | back to summary |
|---|---|
| public AnnotatedMember getMember() Implements com. Doc from com. Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
| |
| getMetadata | back to summary |
|---|---|
| public PropertyMetadata getMetadata() Implements com. Doc from com. Accessor for additional optional information about property.
| |
| getName | back to summary |
|---|---|
| public String getName() Implements com. Doc from com. Method to get logical name of the property
| |
| getType | back to summary |
|---|---|
| public JavaType getType() Implements com. Doc from com. Method to get declared type of the property.
| |
| getWrapperName | back to summary |
|---|---|
| public PropertyName getWrapperName() Implements com. Doc from com. If property is indicated to be wrapped, name of wrapper element to use.
| |
| isRequired | back to summary |
|---|---|
| public boolean isRequired() Implements com. Doc from com. Whether value for property is marked as required using
annotations or associated schema.
Equivalent to:
| |
| isVirtual | back to summary |
|---|---|
| public boolean isVirtual() Implements com. Doc from com. Accessor for checking whether there is an actual physical property behind this property abstraction or not.
| |
| Modifier and Type | Field and Description |
|---|---|
| protected final AnnotatedMember | _member
Physical entity (field, method or constructor argument) that is used to access value of property (or in case of constructor property, just placeholder) |
| protected final PropertyMetadata | |
| protected final PropertyName | |
| protected final JavaType | |
| protected final PropertyName | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | Std(PropertyName name, JavaType type, PropertyName wrapperName, AnnotatedMember member, PropertyMetadata metadata)
|
| public | Std(PropertyName name, JavaType type, PropertyName wrapperName, Annotations contextAnnotations, AnnotatedMember member, PropertyMetadata metadata)
Deprecated
Since 2.9
|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | depositSchemaProperty(JsonObjectFormatVisitor
Visitor to used as the callback handler objectVisitor, SerializerProvider provider)Implements com. Implementation of this method throws
|
| public List | findAliases(MapperConfig<?> config)
Implements com. Method for accessing set of possible alternate names that are accepted during deserialization. |
| public JsonFormat. | findFormatOverrides(AnnotationIntrospector intr)
Implements com.
Deprecated
Convenience method that is roughly equivalent to return intr.findFormat(getMember()); |
| public JsonFormat. | findPropertyFormat(MapperConfig<?> config, Class<?> baseType)
Implements com. Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings |
| public JsonInclude. | findPropertyInclusion(MapperConfig<?> config, Class<?> baseType)
Implements com. Convenience method that is roughly equivalent to return config.getAnnotationIntrospector().findPropertyInclusion(getMember()); |
| public <A extends Annotation> A | getAnnotation(Class<A> acls)
Implements com. Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property. |
| public <A extends Annotation> A | getContextAnnotation(Class<A> acls)
Implements com. Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype). |
| public PropertyName | getFullName()
Implements com. Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend). |
| public AnnotatedMember | getMember()
Implements com. Method for accessing primary physical entity that represents the property; annotated field, method or constructor property. |
| public PropertyMetadata | getMetadata()
Implements com. Accessor for additional optional information about property. |
| public String | getName()
Implements com. Method to get logical name of the property |
| public JavaType | getType()
Implements com. Method to get declared type of the property. |
| public PropertyName | getWrapperName()
Implements com. If property is indicated to be wrapped, name of wrapper element to use. |
| public boolean | isRequired()
Implements com. Whether value for property is marked as required using annotations or associated schema. |
| public boolean | isVirtual()
Implements com. Accessor for checking whether there is an actual physical property behind this property abstraction or not. |
| public BeanProperty. |
| _member | back to summary |
|---|---|
| protected final AnnotatedMember _member Physical entity (field, method or constructor argument) that is used to access value of property (or in case of constructor property, just placeholder) | |
| _metadata | back to summary |
|---|---|
| protected final PropertyMetadata _metadata | |
| _name | back to summary |
|---|---|
| protected final PropertyName _name | |
| _type | back to summary |
|---|---|
| protected final JavaType _type | |
| _wrapperName | back to summary |
|---|---|
| protected final PropertyName _wrapperName | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| Std | back to summary |
|---|---|
| public Std(PropertyName name, JavaType type, PropertyName wrapperName, AnnotatedMember member, PropertyMetadata metadata) | |
| Std | back to summary |
|---|---|
| public Std(PropertyName name, JavaType type, PropertyName wrapperName, Annotations contextAnnotations, AnnotatedMember member, PropertyMetadata metadata)
Deprecated Since 2.9
| |
| Std | back to summary |
|---|---|
public Std(BeanProperty.
| |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) Implements com. Implementation of this method throws
| |
| findAliases | back to summary |
|---|---|
| public List Implements com. Doc from com. Method for accessing set of possible alternate names that are accepted during deserialization.
| |
| findFormatOverrides | back to summary |
|---|---|
| public JsonFormat. Implements com. Doc from com. Deprecated
Convenience method that is roughly equivalent to return intr.findFormat(getMember());and specifically does NOT try to find per-type format defaults to merge; use findPropertyFormat if such defaults would be useful.
| |
| findPropertyFormat | back to summary |
|---|---|
| public JsonFormat. Implements com. Doc from com. Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings
| |
| findPropertyInclusion | back to summary |
|---|---|
| public JsonInclude. Implements com. Doc from com. Convenience method that is roughly equivalent to return config.getAnnotationIntrospector().findPropertyInclusion(getMember());but also considers global default settings for inclusion
| |
| getAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getAnnotation(Class<A> acls) Implements com. Doc from com. 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
| |
| getContextAnnotation | back to summary |
|---|---|
| public <A extends Annotation> A getContextAnnotation(Class<A> acls) Implements com. Doc from com. 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
| |
| getFullName | back to summary |
|---|---|
| public PropertyName getFullName() Implements com. Doc from com. Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
| |
| getMember | back to summary |
|---|---|
| public AnnotatedMember getMember() Implements com. Doc from com. Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
| |
| getMetadata | back to summary |
|---|---|
| public PropertyMetadata getMetadata() Implements com. Doc from com. Accessor for additional optional information about property.
| |
| getName | back to summary |
|---|---|
| public String getName() Implements com. Doc from com. Method to get logical name of the property
| |
| getType | back to summary |
|---|---|
| public JavaType getType() Implements com. Doc from com. Method to get declared type of the property.
| |
| getWrapperName | back to summary |
|---|---|
| public PropertyName getWrapperName() Implements com. Doc from com. If property is indicated to be wrapped, name of wrapper element to use.
| |
| isRequired | back to summary |
|---|---|
| public boolean isRequired() Implements com. Doc from com. Whether value for property is marked as required using
annotations or associated schema.
Equivalent to:
| |
| isVirtual | back to summary |
|---|---|
| public boolean isVirtual() Implements com. Doc from com. Accessor for checking whether there is an actual physical property behind this property abstraction or not.
| |
| withType | back to summary |
|---|---|
| public BeanProperty. | |