Module tools.jackson.dataformat.avro

Package tools.jackson.dataformat.avro.schema

Class AvroSchemaGenerator

java.lang.Object

tools.jackson.dataformat.avro.schema.VisitorFormatWrapperImpl

tools.jackson.dataformat.avro.schema.AvroSchemaGenerator

All Implemented Interfaces:

tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper, tools.jackson.databind.jsonFormatVisitors.WithGettableSerializationContext, tools.jackson.databind.jsonFormatVisitors.WithSettableSerializationContext

public class AvroSchemaGenerator
extends VisitorFormatWrapperImpl

Class that can generate an AvroSchema for a given Java POJO, using definitions Jackson would use for serialization. An instance is typically given to ObjectMapper.acceptJsonFormatVisitor(java.lang.Class<?>, tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper) which will invoke necessary callbacks.

For default configuration of things like "Logical Types support", see Javadocs of VisitorFormatWrapperImpl.

Nested Class Summary

Nested classes/interfaces inherited from interface tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper

tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.Base

Field Summary

Fields inherited from class tools.jackson.dataformat.avro.schema.VisitorFormatWrapperImpl

_builder, _context, _logicalTypesEnabled, _schemas, _valueSchema, _writeEnumAsString, DEFAULT_ENUM_AS_STRING, DEFAULT_LOGICAL_TYPES_ENABLED

Constructor Summary

Constructors

Constructor	Description
AvroSchemaGenerator()

Method Summary

Modifier and Type	Method	Description
AvroSchemaGenerator	disableLogicalTypes()	Disables Avro schema with Logical Types generation.
AvroSchemaGenerator	disableWriteEnumAsString()	Disable Java enum to Avro string mapping.
AvroSchemaGenerator	enableLogicalTypes()	Enables Avro schema with Logical Types generation.
AvroSchemaGenerator	enableWriteEnumAsString()	Enable Java enum to Avro string mapping.
AvroSchema	getGeneratedSchema()

Methods inherited from class tools.jackson.dataformat.avro.schema.VisitorFormatWrapperImpl

_throwUnsupported, _throwUnsupported, createChildWrapper, expectAnyFormat, expectArrayFormat, expectAvroFormat, expectBooleanFormat, expectIntegerFormat, expectMapFormat, expectNullFormat, expectNumberFormat, expectObjectFormat, expectStringFormat, getAvroSchema, getContext, getSchemas, isLogicalTypesEnabled, isWriteEnumAsStringEnabled, setContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AvroSchemaGenerator

public AvroSchemaGenerator()

Method Details

getGeneratedSchema

public AvroSchema getGeneratedSchema()

enableLogicalTypes

public AvroSchemaGenerator enableLogicalTypes()

Description copied from class: VisitorFormatWrapperImpl

Enables Avro schema with Logical Types generation.

Overrides:

enableLogicalTypes in class VisitorFormatWrapperImpl

disableLogicalTypes

public AvroSchemaGenerator disableLogicalTypes()

Description copied from class: VisitorFormatWrapperImpl

Disables Avro schema with Logical Types generation.

Overrides:

disableLogicalTypes in class VisitorFormatWrapperImpl

enableWriteEnumAsString

public AvroSchemaGenerator enableWriteEnumAsString()

Description copied from class: VisitorFormatWrapperImpl

Enable Java enum to Avro string mapping.

Overrides:

enableWriteEnumAsString in class VisitorFormatWrapperImpl

disableWriteEnumAsString

public AvroSchemaGenerator disableWriteEnumAsString()

Description copied from class: VisitorFormatWrapperImpl

Disable Java enum to Avro string mapping.

Overrides:

disableWriteEnumAsString in class VisitorFormatWrapperImpl