Jackson 3.0.1 · tools.jackson.dataformat.avro.schema.RecordVisitor

Field Summary

Modifier and Type	Field and Description
protected final Schema	_avroSchema
protected final boolean	_cfgAddNullDefaults
protected final List<Schema.Field>	_fields
protected final boolean	_overridden Tracks if the schema for this record has been overridden (by an annotation or other means), and calls to the `property` and `optionalProperty` methods should be ignored.
protected final JavaType	_type
private final Schema	_typeSchema When Avro schema for this JavaType (`_type`) results in UNION of multiple Avro types, _typeSchema keeps track of which Avro type in the UNION represents this JavaType (`_type`) so that fields of this JavaType can be set to the right Avro type by `builtAvroSchema()`.
protected final VisitorFormatWrapperImpl	_visitorWrapper

Inherited from tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base:: _provider

Constructor Summary

Access	Constructor and Description
public	RecordVisitor(SerializationContext ctxt, JavaType type, VisitorFormatWrapperImpl visitorWrapper)

Method Summary

Modifier and Type	Method and Description
public Schema	builtAvroSchema() Implements tools.jackson.dataformat.avro.schema.SchemaBuilder.builtAvroSchema.
private static List<Schema>	deduplicateByReference(List<Schema> schemas)
public void	optionalProperty(BeanProperty writer) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.optionalProperty. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.optionalProperty.
public void	optionalProperty(String name, JsonFormatVisitable handler, JavaType type) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.optionalProperty. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.optionalProperty.
public void	property(BeanProperty writer) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.property. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property. Callback method called when a POJO property is being traversed.
public void	property(String name, JsonFormatVisitable handler, JavaType type) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.property. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property. Callback method called when a non-POJO property (typically something like an Enum entry of `java.util.EnumMap` type) is being traversed.
protected Schema	Returns: A schema modified so the first branch matches the type of `defaultValue`; otherwise, `schema` is returned unmodified. reorderUnionToMatchDefaultType(Schema Schema to reorder; If `null` or not a `UNION`, then it is returned unmodified. schema, JsonNode Default value to match with the union defaultValue) A union schema with a default value must always have the schema branch corresponding to the default value first, or Avro will print a warning complaining that the default value is not compatible.
protected Schema.Field	schemaFieldForWriter(BeanProperty prop, boolean optional)

Inherited from tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base:: getContext setContext

Field Detail

_avroSchema	back to summary
protected final Schema _avroSchema

_cfgAddNullDefaults	back to summary
protected final boolean _cfgAddNullDefaults

_fields	back to summary
protected final List<Schema.Field> _fields

_overridden	back to summary
protected final boolean _overridden Tracks if the schema for this record has been overridden (by an annotation or other means), and calls to the `property` and `optionalProperty` methods should be ignored.

_type	back to summary
protected final JavaType _type

_typeSchema back to summary

_typeSchema	back to summary
private final Schema _typeSchema When Avro schema for this JavaType (`_type`) results in UNION of multiple Avro types, _typeSchema keeps track of which Avro type in the UNION represents this JavaType (`_type`) so that fields of this JavaType can be set to the right Avro type by `builtAvroSchema()`. Example: Since 2.19.1

private final Schema _typeSchema

When Avro schema for this JavaType (_type) results in UNION of multiple Avro types, _typeSchema keeps track of which Avro type in the UNION represents this JavaType (_type) so that fields of this JavaType can be set to the right Avro type by builtAvroSchema().
Example:


Since
2.19.1

_visitorWrapper	back to summary
protected final VisitorFormatWrapperImpl _visitorWrapper

Constructor Detail

RecordVisitor	back to summary
public RecordVisitor(SerializationContext ctxt, JavaType type, VisitorFormatWrapperImpl visitorWrapper)

Method Detail

builtAvroSchema	back to summary
public Schema builtAvroSchema() Implements tools.jackson.dataformat.avro.schema.SchemaBuilder.builtAvroSchema. Annotations @Override

builtAvroSchema

back to summary

public Schema builtAvroSchema()

Implements tools.jackson.dataformat.avro.schema.SchemaBuilder.builtAvroSchema.

Annotations

@Override

deduplicateByReference	back to summary
private static List<Schema> deduplicateByReference(List<Schema> schemas)

optionalProperty	back to summary
public void optionalProperty(BeanProperty writer) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.optionalProperty. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.optionalProperty. Annotations @Override

optionalProperty

back to summary

public void optionalProperty(BeanProperty writer)

Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.optionalProperty.

Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.optionalProperty.

Annotations

@Override

optionalProperty	back to summary
public void optionalProperty(String name, JsonFormatVisitable handler, JavaType type) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.optionalProperty. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.optionalProperty. Annotations @Override

optionalProperty

back to summary

public void optionalProperty(String name, JsonFormatVisitable handler, JavaType type)

Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.optionalProperty.

Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.optionalProperty.

Annotations

@Override

property	back to summary
public void property(BeanProperty writer) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.property. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property. Doc from tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property. Callback method called when a POJO property is being traversed. Annotations @Override

property

back to summary

public void property(BeanProperty writer)

Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.property.

Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property.

Doc from tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property.

Callback method called when a POJO property is being traversed.

Annotations

@Override

property back to summary

property	back to summary
public void property(String name, JsonFormatVisitable handler, JavaType type) Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.property. Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property. Doc from tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property. Callback method called when a non-POJO property (typically something like an Enum entry of `java.util.EnumMap` type) is being traversed. With POJOs, `property(BeanProperty)` is called instead. Annotations @Override

public void property(String name, JsonFormatVisitable handler, JavaType type)

Overrides tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.Base.property.

Implements tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property.

Doc from tools.jackson.databind.jsonFormatVisitors.JsonObjectFormatVisitor.property.

Callback method called when a non-POJO property (typically something like an Enum entry of java.util.EnumMap type) is being traversed. With POJOs, property(BeanProperty) is called instead.

Annotations

@Override

reorderUnionToMatchDefaultType back to summary

reorderUnionToMatchDefaultType	back to summary
protected Schema reorderUnionToMatchDefaultType(Schema schema, JsonNode defaultValue) A union schema with a default value must always have the schema branch corresponding to the default value first, or Avro will print a warning complaining that the default value is not compatible. If `schema` is a `UNION` schema and `defaultValue` is non-`null`, this finds the appropriate branch in the union and reorders the union so that it is first. Parameters schema:Schema Schema to reorder; If `null` or not a `UNION`, then it is returned unmodified. defaultValue:JsonNode Default value to match with the union Returns:Schema A schema modified so the first branch matches the type of `defaultValue`; otherwise, `schema` is returned unmodified.

protected Schema reorderUnionToMatchDefaultType(Schema schema, JsonNode defaultValue)

A union schema with a default value must always have the schema branch corresponding to the default value first, or Avro will print a warning complaining that the default value is not compatible. If schema is a UNION schema and defaultValue is non-null, this finds the appropriate branch in the union and reorders the union so that it is first.

Parameters

schema:Schema: Schema to reorder; If null or not a UNION, then it is returned unmodified.
defaultValue:JsonNode: Default value to match with the union

Returns:Schema

A schema modified so the first branch matches the type of defaultValue; otherwise, schema is returned unmodified.

schemaFieldForWriter	back to summary
protected Schema.Field schemaFieldForWriter(BeanProperty prop, boolean optional)

public Class RecordVisitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail