Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.deser.impl

public final Class ObjectIdValueProperty

extends SettableBeanProperty
Class Inheritance
Imports
java.io.IOException, java.lang.annotation.Annotation, com.fasterxml.jackson.core.JsonParser, .JsonToken, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.deser.*, com.fasterxml.jackson.databind.introspect.AnnotatedMember
Specialized SettableBeanProperty implementation used for virtual property that represents Object Id that is used for some POJO types (or properties).

Field Summary

Modifier and TypeField and Description
protected final ObjectIdReader
_objectIdReader

private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.deser.SettableBeanProperty:
_contextAnnotations_managedReferenceName_nullProvider_objectIdInfo_propertyIndex_propName_type_valueDeserializer_valueTypeDeserializer_viewMatcher_wrapperNameMISSING_VALUE_DESERIALIZER

Constructor Summary

AccessConstructor and Description
public
ObjectIdValueProperty(ObjectIdReader objectIdReader, PropertyMetadata metadata)

protected
ObjectIdValueProperty(ObjectIdValueProperty src, JsonDeserializer<?> deser, NullValueProvider nva)

protected
ObjectIdValueProperty(ObjectIdValueProperty src, PropertyName newName)

Method Summary

Modifier and TypeMethod and Description
public void
deserializeAndSet(JsonParser p, DeserializationContext ctxt, Object instance)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserializeAndSet.

Method called to deserialize appropriate value, given parser (and context), and set it using appropriate mechanism.

public Object
deserializeSetAndReturn(JsonParser p, DeserializationContext ctxt, Object instance)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserializeSetAndReturn.

Alternative to deserializeAndSet that returns either return value of setter method called (if one is), or null to indicate that no return value is available.

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

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.getAnnotation.

Implements com.fasterxml.jackson.databind.BeanProperty.getAnnotation.

Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.

public AnnotatedMember
getMember()

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.getMember.

Implements com.fasterxml.jackson.databind.BeanProperty.getMember.

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

public void
set(Object instance, Object value)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.set.

Method called to assign given value to this property, on specified Object.

public Object
setAndReturn(Object instance, Object value)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.setAndReturn.

Method called to assign given value to this property, on specified Object, and return whatever delegating accessor returned (if anything)

Note

this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.

public SettableBeanProperty
withName(PropertyName
Name to use for the new instance.
newName)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.withName.

Fluent factory method for constructing and returning a new instance with specified property name.

public SettableBeanProperty
withNullProvider(NullValueProvider nva)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.withNullProvider.

public SettableBeanProperty
withValueDeserializer(JsonDeserializer<?>
Deserializer to assign to the new property instance
deser)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.withValueDeserializer.

Fluent factory method for constructing and returning a new instance with specified value deserializer.

Inherited from com.fasterxml.jackson.databind.deser.SettableBeanProperty:
_throwAsIOE_throwAsIOE_throwAsIOE_throwAsIOEassignIndexdepositSchemaPropertydeserializedeserializeWithfixAccessgetContextAnnotationgetCreatorIndexgetDeclaringClassgetFullNamegetInjectableValueIdgetManagedReferenceNamegetNamegetNullValueProvidergetObjectIdInfogetPropertyIndexgetTypegetValueDeserializergetValueTypeDeserializergetWrapperNamehasValueDeserializerhasValueTypeDeserializerhasViewsisIgnorableisInjectionOnlymarkAsIgnorablesetManagedReferenceNamesetObjectIdInfosetViewstoStringvisibleInViewwithSimpleName

Field Detail

_objectIdReaderback to summary
protected final ObjectIdReader _objectIdReader
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase.serialVersionUID.

Constructor Detail

ObjectIdValuePropertyback to summary
public ObjectIdValueProperty(ObjectIdReader objectIdReader, PropertyMetadata metadata)
ObjectIdValuePropertyback to summary
protected ObjectIdValueProperty(ObjectIdValueProperty src, JsonDeserializer<?> deser, NullValueProvider nva)
ObjectIdValuePropertyback to summary
protected ObjectIdValueProperty(ObjectIdValueProperty src, PropertyName newName)

Method Detail

deserializeAndSetback to summary
public void deserializeAndSet(JsonParser p, DeserializationContext ctxt, Object instance) throws IOException

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserializeAndSet.

Doc from com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserializeAndSet.

Method called to deserialize appropriate value, given parser (and context), and set it using appropriate mechanism. Pre-condition is that passed parser must point to the first token that should be consumed to produce the value (the only value for scalars, multiple for Objects and Arrays).

Annotations
@Override
deserializeSetAndReturnback to summary
public Object deserializeSetAndReturn(JsonParser p, DeserializationContext ctxt, Object instance) throws IOException

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserializeSetAndReturn.

Doc from com.fasterxml.jackson.databind.deser.SettableBeanProperty.deserializeSetAndReturn.

Alternative to deserializeAndSet that returns either return value of setter method called (if one is), or null to indicate that no return value is available. Mostly used to support Builder style deserialization.

Annotations
@Override
getAnnotationback to summary
public <A extends Annotation> A getAnnotation(Class<A> acls)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.getAnnotation.

Implements com.fasterxml.jackson.databind.BeanProperty.getAnnotation.

Doc from com.fasterxml.jackson.databind.BeanProperty.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 AnnotationIntrospectors) should be accessed through AnnotationIntrospector.

Annotations
@Override
getMemberback to summary
public AnnotatedMember getMember()

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.getMember.

Implements com.fasterxml.jackson.databind.BeanProperty.getMember.

Doc from com.fasterxml.jackson.databind.BeanProperty.getMember.

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

Annotations
@Override
setback to summary
public void set(Object instance, Object value) throws IOException

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.set.

Doc from com.fasterxml.jackson.databind.deser.SettableBeanProperty.set.

Method called to assign given value to this property, on specified Object.

Note

this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.

Annotations
@Override
setAndReturnback to summary
public Object setAndReturn(Object instance, Object value) throws IOException

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.setAndReturn.

Doc from com.fasterxml.jackson.databind.deser.SettableBeanProperty.setAndReturn.

Method called to assign given value to this property, on specified Object, and return whatever delegating accessor returned (if anything)

Note

this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.

Annotations
@Override
withNameback to summary
public SettableBeanProperty withName(PropertyName newName)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.withName.

Doc from com.fasterxml.jackson.databind.deser.SettableBeanProperty.withName.

Fluent factory method for constructing and returning a new instance with specified property name. Note that this method should NOT change configuration of this instance.

Parameters
newName:PropertyName

Name to use for the new instance.

Returns:SettableBeanProperty

Newly constructed instance, if property name differs from the one used for this instance; or 'this' if not.

Annotations
@Override
withNullProviderback to summary
public SettableBeanProperty withNullProvider(NullValueProvider nva)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.withNullProvider.

Annotations
@Override
withValueDeserializerback to summary
public SettableBeanProperty withValueDeserializer(JsonDeserializer<?> deser)

Implements abstract com.fasterxml.jackson.databind.deser.SettableBeanProperty.withValueDeserializer.

Doc from com.fasterxml.jackson.databind.deser.SettableBeanProperty.withValueDeserializer.

Fluent factory method for constructing and returning a new instance with specified value deserializer. Note that this method should NOT change configuration of this instance.

Parameters
deser:JsonDeserializer<?>

Deserializer to assign to the new property instance

Returns:SettableBeanProperty

Newly constructed instance, if value deserializer differs from the one used for this instance; or 'this' if not.

Annotations
@Override