Top Fields Constructors Methods
com.fasterxml.jackson.dataformat.avro.schema

public Class VisitorFormatWrapperImpl

extends Object
implements JsonFormatVisitorWrapper
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper, com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWithSerializerProvider
Known Direct Subclasses
com.fasterxml.jackson.dataformat.avro.schema.AvroSchemaGenerator
Imports
java.time.temporal.Temporal, com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.JavaType, .JsonMappingException, .SerializerProvider, com.fasterxml.jackson.databind.exc.InvalidDefinitionException, com.fasterxml.jackson.databind.jsonFormatVisitors.*, com.fasterxml.jackson.dataformat.avro.AvroSchema, org.apache.avro.Schema

Field Summary

Modifier and TypeField and Description
protected SchemaBuilder
_builder

Visitor used for resolving actual Schema, if structured type (or one with complex configuration)

protected boolean
_logicalTypesEnabled

protected SerializerProvider
_provider

protected final DefinedSchemas
_schemas

protected Schema
_valueSchema

Schema for simple types that do not need a visitor.

protected boolean
_writeEnumAsString

Constructor Summary

AccessConstructor and Description
public
VisitorFormatWrapperImpl(DefinedSchemas schemas, SerializerProvider p)

protected
VisitorFormatWrapperImpl(VisitorFormatWrapperImpl src)

Method Summary

Modifier and TypeMethod and Description
private boolean
_isDateTimeType(JavaType type)

protected <T> T
_throwUnsupported()

protected <T> T
_throwUnsupported(String msg)

protected VisitorFormatWrapperImpl

Returns:

new instance with shared properties and configuration.
createChildWrapper()

Creates new VisitorFormatWrapperImpl instance with shared schemas, serialization provider and same configuration.

public VisitorFormatWrapperImpl
disableLogicalTypes()

Disables Avro schema with Logical Types generation.

public VisitorFormatWrapperImpl
disableWriteEnumAsString()

Disable Java enum to Avro string mapping.

public VisitorFormatWrapperImpl
enableLogicalTypes()

Enables Avro schema with Logical Types generation.

public VisitorFormatWrapperImpl
enableWriteEnumAsString()

Enable Java enum to Avro string mapping.

public JsonAnyFormatVisitor
expectAnyFormat(JavaType
Declared type of visited property (or List element) in Java
convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectAnyFormat.

public JsonArrayFormatVisitor
expectArrayFormat(final JavaType
Declared type of visited property (or List element) in Java
convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectArrayFormat.

public void
expectAvroFormat(AvroSchema schema)

public JsonBooleanFormatVisitor
expectBooleanFormat(JavaType
Declared type of visited property (or List element) in Java
convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectBooleanFormat.

public JsonIntegerFormatVisitor
expectIntegerFormat(JavaType
Declared type of visited property (or List element) in Java
type)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectIntegerFormat.

public JsonMapFormatVisitor
expectMapFormat(JavaType mapType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectMapFormat.

Method called when type is of Java java.util.Map type, and will be serialized as a JSON Object.

public JsonNullFormatVisitor
expectNullFormat(JavaType
Declared type of visited property (or List element) in Java
convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectNullFormat.

public JsonNumberFormatVisitor
expectNumberFormat(JavaType
Declared type of visited property (or List element) in Java
convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectNumberFormat.

public JsonObjectFormatVisitor
expectObjectFormat(JavaType
Declared type of visited property (or List element) in Java
type)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectObjectFormat.

public JsonStringFormatVisitor
expectStringFormat(JavaType
Declared type of visited property (or List element) in Java
type)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectStringFormat.

public Schema
getAvroSchema()

public SerializerProvider
getProvider()

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWithSerializerProvider.getProvider.

protected DefinedSchemas
getSchemas()

public boolean
isLogicalTypesEnabled()

public boolean
isWriteEnumAsStringEnabled()

public void
setProvider(SerializerProvider provider)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWithSerializerProvider.setProvider.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_builderback to summary
protected SchemaBuilder _builder

Visitor used for resolving actual Schema, if structured type (or one with complex configuration)

_logicalTypesEnabledback to summary
protected boolean _logicalTypesEnabled
Since
2.13
_providerback to summary
protected SerializerProvider _provider
_schemasback to summary
protected final DefinedSchemas _schemas
_valueSchemaback to summary
protected Schema _valueSchema

Schema for simple types that do not need a visitor.

_writeEnumAsStringback to summary
protected boolean _writeEnumAsString
Since
2.18

Constructor Detail

VisitorFormatWrapperImplback to summary
public VisitorFormatWrapperImpl(DefinedSchemas schemas, SerializerProvider p)
VisitorFormatWrapperImplback to summary
protected VisitorFormatWrapperImpl(VisitorFormatWrapperImpl src)

Method Detail

_isDateTimeTypeback to summary
private boolean _isDateTimeType(JavaType type)
_throwUnsupportedback to summary
protected <T> T _throwUnsupported()
_throwUnsupportedback to summary
protected <T> T _throwUnsupported(String msg)
createChildWrapperback to summary
protected VisitorFormatWrapperImpl createChildWrapper()

Creates new VisitorFormatWrapperImpl instance with shared schemas, serialization provider and same configuration.

Returns:VisitorFormatWrapperImpl

new instance with shared properties and configuration.

disableLogicalTypesback to summary
public VisitorFormatWrapperImpl disableLogicalTypes()

Disables Avro schema with Logical Types generation.

Since
2.13
disableWriteEnumAsStringback to summary
public VisitorFormatWrapperImpl disableWriteEnumAsString()

Disable Java enum to Avro string mapping.

Since
2.18
enableLogicalTypesback to summary
public VisitorFormatWrapperImpl enableLogicalTypes()

Enables Avro schema with Logical Types generation.

Since
2.13
enableWriteEnumAsStringback to summary
public VisitorFormatWrapperImpl enableWriteEnumAsString()

Enable Java enum to Avro string mapping.

Since
2.18
expectAnyFormatback to summary
public JsonAnyFormatVisitor expectAnyFormat(JavaType convertedType) throws JsonMappingException

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectAnyFormat.

Parameters
convertedType:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectAnyFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectArrayFormatback to summary
public JsonArrayFormatVisitor expectArrayFormat(final JavaType convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectArrayFormat.

Parameters
convertedType:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectArrayFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectAvroFormatback to summary
public void expectAvroFormat(AvroSchema schema)
expectBooleanFormatback to summary
public JsonBooleanFormatVisitor expectBooleanFormat(JavaType convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectBooleanFormat.

Parameters
convertedType:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectBooleanFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectIntegerFormatback to summary
public JsonIntegerFormatVisitor expectIntegerFormat(JavaType type)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectIntegerFormat.

Parameters
type:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectIntegerFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectMapFormatback to summary
public JsonMapFormatVisitor expectMapFormat(JavaType mapType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectMapFormat.

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectMapFormat.

Method called when type is of Java java.util.Map type, and will be serialized as a JSON Object.

Annotations
@Override
expectNullFormatback to summary
public JsonNullFormatVisitor expectNullFormat(JavaType convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectNullFormat.

Parameters
convertedType:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectNullFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectNumberFormatback to summary
public JsonNumberFormatVisitor expectNumberFormat(JavaType convertedType)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectNumberFormat.

Parameters
convertedType:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectNumberFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectObjectFormatback to summary
public JsonObjectFormatVisitor expectObjectFormat(JavaType type)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectObjectFormat.

Parameters
type:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectObjectFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
expectStringFormatback to summary
public JsonStringFormatVisitor expectStringFormat(JavaType type)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectStringFormat.

Parameters
type:JavaType

Doc from com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper.expectStringFormat.

Declared type of visited property (or List element) in Java

Annotations
@Override
getAvroSchemaback to summary
public Schema getAvroSchema()
getProviderback to summary
public SerializerProvider getProvider()

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWithSerializerProvider.getProvider.

Annotations
@Override
getSchemasback to summary
protected DefinedSchemas getSchemas()
isLogicalTypesEnabledback to summary
public boolean isLogicalTypesEnabled()
isWriteEnumAsStringEnabledback to summary
public boolean isWriteEnumAsStringEnabled()
setProviderback to summary
public void setProvider(SerializerProvider provider)

Implements com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWithSerializerProvider.setProvider.

Annotations
@Override