public interface ContextualSerializer
JsonSerializers can implement to get a callback that can be used to create contextual instances of serializer to use for handling properties of supported type. This can be useful for serializers that can be configured by annotations, or should otherwise have differing behavior depending on what kind of property is being serialized.
Note that in cases where serializer needs both contextualization and
resolution -- that is, implements both this interface and
-- resolution via
ResolvableSerializer occurs first, and contextual
resolution (via this interface) later on.
|Modifier and Type||Method and Description|
Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) throws JsonMappingException
prov- Serializer provider to use for accessing config, other serializers
property- Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)
Copyright © 2021 JBoss by Red Hat. All rights reserved.