Top Description Fields Constructors Methods
com.fasterxml.jackson.dataformat.protobuf.schemagen

public Class ProtobufSchemaGenerator

extends ProtoBufSchemaVisitor
Class Inheritance
Imports
java.util.*, com.squareup.protoparser.TypeElement, com.fasterxml.jackson.databind.JavaType, .JsonMappingException, com.fasterxml.jackson.databind.jsonFormatVisitors.*, com.fasterxml.jackson.dataformat.protobuf.schema.NativeProtobufSchema, .ProtobufSchema
Class that can generate a ProtobufSchema for a given Java POJO, using definitions Jackson would use for serialization. An instance is typically given to com.fasterxml.jackson.databind.ObjectMapper#acceptJsonFormatVisitor which will invoke necessary callbacks.

Field Summary

Modifier and TypeField and Description
protected HashSet<JavaType>
_generated

protected JavaType
_rootType

Inherited from com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor:
_builder_definedTypeElementBuilders_isNested_simpleType

Constructor Summary

AccessConstructor and Description
public
ProtobufSchemaGenerator()

Method Summary

Modifier and TypeMethod and Description
public JsonArrayFormatVisitor
expectArrayFormat(JavaType
Declared type of visited property (or List element) in Java
convertedType)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectArrayFormat.

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

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

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectBooleanFormat.

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

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

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectIntegerFormat.

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

public JsonMapFormatVisitor
expectMapFormat(JavaType mapType)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectMapFormat.

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 JsonNumberFormatVisitor
expectNumberFormat(JavaType
Declared type of visited property (or List element) in Java
convertedType)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectNumberFormat.

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

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

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectObjectFormat.

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

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

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectStringFormat.

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

public ProtobufSchema
getGeneratedSchema()

public ProtobufSchema
getGeneratedSchema(boolean appendDependencies)

Inherited from com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor:
_throwUnsupported_throwUnsupportedbuildbuildWithDependenciesexpectAnyFormatexpectNullFormatgetSimpleType

Field Detail

_generatedback to summary
protected HashSet<JavaType> _generated
_rootTypeback to summary
protected JavaType _rootType

Constructor Detail

ProtobufSchemaGeneratorback to summary
public ProtobufSchemaGenerator()

Method Detail

expectArrayFormatback to summary
public JsonArrayFormatVisitor expectArrayFormat(JavaType convertedType)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectArrayFormat.

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
expectBooleanFormatback to summary
public JsonBooleanFormatVisitor expectBooleanFormat(JavaType convertedType)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectBooleanFormat.

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)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectIntegerFormat.

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)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectMapFormat.

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
expectNumberFormatback to summary
public JsonNumberFormatVisitor expectNumberFormat(JavaType convertedType)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectNumberFormat.

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)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectObjectFormat.

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)

Overrides com.fasterxml.jackson.dataformat.protobuf.schemagen.ProtoBufSchemaVisitor.expectStringFormat.

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
getGeneratedSchemaback to summary
public ProtobufSchema getGeneratedSchema() throws JsonMappingException
getGeneratedSchemaback to summary
public ProtobufSchema getGeneratedSchema(boolean appendDependencies) throws JsonMappingException