com.fasterxml.jackson.databind

Class BeanProperty.Std

java.lang.Object

com.fasterxml.jackson.databind.BeanProperty.Std

All Implemented Interfaces:

BeanProperty, Named, Serializable

Direct Known Subclasses:

ValueInjector

Enclosing interface:

BeanProperty

public static class BeanProperty.Std
extends Object
implements BeanProperty, Serializable

Simple stand-alone implementation, useful as a placeholder or base class for more complex implementations.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.BeanProperty

BeanProperty.Bogus, BeanProperty.Std

Field Summary

Fields

Modifier and Type	Field and Description
protected 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 PropertyMetadata	_metadata
protected PropertyName	_name
protected JavaType	_type
protected PropertyName	_wrapperName

Fields inherited from interface com.fasterxml.jackson.databind.BeanProperty

EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors

Constructor and Description
Std(BeanProperty.Std base, JavaType newType)
Std(PropertyName name, JavaType type, PropertyName wrapperName, AnnotatedMember member, PropertyMetadata metadata)
Std(PropertyName name, JavaType type, PropertyName wrapperName, Annotations contextAnnotations, AnnotatedMember member, PropertyMetadata metadata) Deprecated. Since 2.9

Method Summary

Modifier and Type	Method and Description
void	depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) Implementation of this method throws UnsupportedOperationException, since instances of this implementation should not be used as part of actual structure visited.
List<PropertyName>	findAliases(MapperConfig<?> config) Method for accessing set of possible alternate names that are accepted during deserialization.
JsonFormat.Value	findFormatOverrides(AnnotationIntrospector intr) Deprecated.
JsonFormat.Value	findPropertyFormat(MapperConfig<?> config, Class<?> baseType) Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings
JsonInclude.Value	findPropertyInclusion(MapperConfig<?> config, Class<?> baseType) Convenience method that is roughly equivalent to
<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.
<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).
PropertyName	getFullName() Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
AnnotatedMember	getMember() Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
PropertyMetadata	getMetadata() Accessor for additional optional information about property.
String	getName() Method to get logical name of the property
JavaType	getType() Method to get declared type of the property.
PropertyName	getWrapperName() If property is indicated to be wrapped, name of wrapper element to use.
boolean	isRequired() Whether value for property is marked as required using annotations or associated schema.
boolean	isVirtual() Accessor for checking whether there is an actual physical property behind this property abstraction or not.
BeanProperty.Std	withType(JavaType type)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_name

protected final PropertyName _name

_type

protected final JavaType _type

_wrapperName

protected final PropertyName _wrapperName

_metadata

protected final PropertyMetadata _metadata

_member

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)

Constructor Detail

Std

public Std(PropertyName name,
           JavaType type,
           PropertyName wrapperName,
           AnnotatedMember member,
           PropertyMetadata metadata)

Std

@Deprecated
public Std(PropertyName name,
                       JavaType type,
                       PropertyName wrapperName,
                       Annotations contextAnnotations,
                       AnnotatedMember member,
                       PropertyMetadata metadata)

Deprecated. Since 2.9

Std

public Std(BeanProperty.Std base,
           JavaType newType)

Since:

2.6

Method Detail

withType

public BeanProperty.Std withType(JavaType type)

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> acls)

Description copied from interface: BeanProperty

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 AnnotationIntrospectors) should be accessed through AnnotationIntrospector.

Specified by:

getAnnotation in interface BeanProperty

getContextAnnotation

public <A extends Annotation> A getContextAnnotation(Class<A> acls)

Description copied from interface: BeanProperty

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 AnnotationIntrospectors) should be accessed through AnnotationIntrospector.

Specified by:

getContextAnnotation in interface BeanProperty

findFormatOverrides

@Deprecated
public JsonFormat.Value findFormatOverrides(AnnotationIntrospector intr)

Deprecated.

Description copied from interface: BeanProperty

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 BeanProperty.findPropertyFormat(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, java.lang.Class<?>) if such defaults would be useful.

Specified by:

findFormatOverrides in interface BeanProperty

findPropertyFormat

public JsonFormat.Value findPropertyFormat(MapperConfig<?> config,
                                           Class<?> baseType)

Description copied from interface: BeanProperty

Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings

Specified by:

findPropertyFormat in interface BeanProperty

findPropertyInclusion

public JsonInclude.Value findPropertyInclusion(MapperConfig<?> config,
                                               Class<?> baseType)

Description copied from interface: BeanProperty

Convenience method that is roughly equivalent to

   return config.getAnnotationIntrospector().findPropertyInclusion(getMember());

but also considers global default settings for inclusion

Specified by:

findPropertyInclusion in interface BeanProperty

findAliases

public List<PropertyName> findAliases(MapperConfig<?> config)

Description copied from interface: BeanProperty

Method for accessing set of possible alternate names that are accepted during deserialization.

Specified by:

findAliases in interface BeanProperty

Returns:

List (possibly empty) of alternate names; never null

getName

public String getName()

Description copied from interface: BeanProperty

Method to get logical name of the property

Specified by:

getName in interface BeanProperty

Specified by:

getName in interface Named

getFullName

public PropertyName getFullName()

Description copied from interface: BeanProperty

Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).

Specified by:

getFullName in interface BeanProperty

getType

public JavaType getType()

Description copied from interface: BeanProperty

Method to get declared type of the property.

Specified by:

getType in interface BeanProperty

getWrapperName

public PropertyName getWrapperName()

Description copied from interface: BeanProperty

If property is indicated to be wrapped, name of wrapper element to use.

Specified by:

getWrapperName in interface BeanProperty

isRequired

public boolean isRequired()

Description copied from interface: BeanProperty

Whether value for property is marked as required using annotations or associated schema. Equivalent to: getMetadata().isRequired()

Specified by:

isRequired in interface BeanProperty

getMetadata

public PropertyMetadata getMetadata()

Description copied from interface: BeanProperty

Accessor for additional optional information about property.

Specified by:

getMetadata in interface BeanProperty

Returns:

Metadata about property; never null.

getMember

public AnnotatedMember getMember()

Description copied from interface: BeanProperty

Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.

Specified by:

getMember in interface BeanProperty

isVirtual

public boolean isVirtual()

Description copied from interface: BeanProperty

Accessor for checking whether there is an actual physical property behind this property abstraction or not.

Specified by:

isVirtual in interface BeanProperty

depositSchemaProperty

public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor,
                                  SerializerProvider provider)

Implementation of this method throws UnsupportedOperationException, since instances of this implementation should not be used as part of actual structure visited. Rather, other implementations should handle it.

Specified by:

depositSchemaProperty in interface BeanProperty

Parameters:

objectVisitor - Visitor to used as the callback handler