public abstract Class BeanSerializerBase

Overrides com.fasterxml.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Get the representation of the schema to which this serializer will conform.

Parameters

typeHint:JavaType

Type of element (entity like property) being visited

Annotations

@Override

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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.

Parameters

provider:SerializerProvider

Serializer provider to use for accessing config, other serializers

property:BeanProperty

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)

Returns:JsonSerializer<?>

Serializer to use for serializing values of specified property; may be this instance or a new instance.

Annotations

@SuppressWarnings:incomplete-switch

@Override

Overrides com.fasterxml.jackson.databind.ser.std.StdSerializer.getSchema.

Implements com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Doc from com.fasterxml.jackson.databind.ser.std.StdSerializer.getSchema.

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Parameters

provider:SerializerProvider

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

The serializer provider.

typeHint:Type

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

A hint about the type.

Returns:JsonNode

Doc from com.fasterxml.jackson.databind.jsonschema.SchemaAware.getSchema.

Json-schema for this serializer.

Annotations

@Deprecated

@Override

Overrides com.fasterxml.jackson.databind.JsonSerializer.properties.

Doc from com.fasterxml.jackson.databind.JsonSerializer.properties.

Accessor for iterating over logical properties that the type handled by this serializer has, from serialization perspective. Actual type of properties, if any, will be com.fasterxml.jackson.databind.ser.BeanPropertyWriter. Of standard Jackson serializers, only com.fasterxml.jackson.databind.ser.BeanSerializer exposes properties.

Annotations

@Override

Implements com.fasterxml.jackson.databind.ser.ResolvableSerializer.resolve.

We need to implement ResolvableSerializer to be able to properly handle cyclic type references.

Parameters

provider:SerializerProvider

Doc from com.fasterxml.jackson.databind.ser.ResolvableSerializer.resolve.

Provider that has constructed serializer this method is called on.

Annotations

@Override

Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

Parameters

bean:Object

Value to serialize; can not be null.

gen:JsonGenerator

Generator used to output resulting Json content

provider:SerializerProvider

Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serializeWithType.

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 UnsupportedOperationException to indicate that proper type handling needs to be implemented.

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);

Parameters

bean:Object

Value to serialize; can not be null.

gen:JsonGenerator

Generator used to output resulting Json content

provider:SerializerProvider

Provider that can be used to get serializers for serializing Objects value contains, if any.

typeSer:TypeSerializer

Type serializer to use for including type information

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonSerializer.usesObjectId.

Doc from com.fasterxml.jackson.databind.JsonSerializer.usesObjectId.

Method that can be called to see whether this serializer instance will use Object Id to handle cyclic references.

Annotations

@Override

Overrides com.fasterxml.jackson.databind.JsonSerializer.withFilterId.

Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)

Annotations

@Override

Since

2.3

Mutant factory used for creating a new instance with different ObjectIdWriter.

Since

2.0