@JsonFormat(JsonFormat.Shape.STRING),
it generates bracket notation for a more concise and human-readable representation.
Otherwise, it defaults to a more verbose standard serialization, explicitly writing out endpoints and bound types.
Usage Example for bracket notation:
@JsonFormat(JsonFormat.Shape.STRING)
private Range<Integer> r;
When the range field is annotated with @JsonFormat(JsonFormat.Shape.STRING), the serializer
will output the range that would look something like: [X..Y] or (X..Y).
{
"lowerEndpoint": X,
"lowerBoundType": "CLOSED",
"upperEndpoint": Y,
"upperBoundType": "CLOSED"
}
| Modifier and Type | Field and Description |
|---|---|
| protected final ValueSerializer | |
| protected final RangeHelper. | |
| protected final JavaType | |
| protected final JsonFormat. |
| Access | Constructor and Description |
|---|---|
| public | |
| protected | RangeSerializer(JavaType type, ValueSerializer<?> endpointSer, RangeHelper.
|
| Modifier and Type | Method and Description |
|---|---|
| private String | |
| private void | |
| public void | acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
Overrides tools. Implements tools. Default implementation specifies no format. |
| public ValueSerializer | createContextual(SerializationContext ctxt, BeanProperty property)
Overrides tools. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). |
| public boolean | isEmpty(SerializationContext ctxt, Range<?> value)
Overrides tools. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values). |
| public void | serialize(Range<?> value, JsonGenerator gen, SerializationContext ctxt)
Implements abstract tools. Method that can be called to ask implementation to serialize values of type this serializer handles. |
| public void | serializeWithType(Range<?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer)
Overrides tools. Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information. |
| _endpointSerializer | back to summary |
|---|---|
| protected final ValueSerializer<Object> _endpointSerializer | |
| _fieldNames | back to summary |
|---|---|
| protected final RangeHelper. | |
| _rangeType | back to summary |
|---|---|
| protected final JavaType _rangeType | |
| _shape | back to summary |
|---|---|
| protected final JsonFormat. | |
| RangeSerializer | back to summary |
|---|---|
| public RangeSerializer(JavaType type) | |
| RangeSerializer | back to summary |
|---|---|
protected RangeSerializer(JavaType type, ValueSerializer<?> endpointSer, RangeHelper.
| |
| _getStringFormat | back to summary |
|---|---|
| private String _getStringFormat(Range<?> range) | |
| _writeContents | back to summary |
|---|---|
| private void _writeContents(Range<?> value, JsonGenerator g, SerializationContext ctxt) throws JacksonException | |
| acceptJsonFormatVisitor | back to summary |
|---|---|
| public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Overrides tools. Implements tools. Doc from tools. Default implementation specifies no format. This behavior is usually overriden by custom serializers.
| |
| createContextual | back to summary |
|---|---|
| public ValueSerializer Overrides tools. Doc from tools. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use. Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.
| |
| isEmpty | back to summary |
|---|---|
| public boolean isEmpty(SerializationContext ctxt, Range<?> value) Overrides tools. Doc from tools. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values). Default implementation will consider only null values to be empty.
| |
| serialize | back to summary |
|---|---|
| public void serialize(Range<?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException Implements abstract tools. Doc from tools. Method that can be called to ask implementation to serialize values of type this serializer handles.
| |
| serializeWithType | back to summary |
|---|---|
| public void serializeWithType(Range<?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException Overrides tools. Doc from tools. Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.
Default implementation will throw For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like: // note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);and implementations for type serialized as JSON Arrays or Objects would differ slightly, as START-ARRAY/END-ARRAY and
START-OBJECT/END-OBJECT pairs
need to be properly handled with respect to serializing of contents.
| |