tools.jackson.dataformat.protobuf

public Class ProtobufMapper

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ProtobufMapper.Builder Base implementation for "Vanilla" `ObjectMapper`, used with Protobuf backend.
private static class	ProtobufMapper.SharedWrapper Helper class to contain dynamically constructed "shared" instance of mapper, should one be needed via `shared`.

Field Summary

Modifier and Type	Field and Description
protected volatile DescriptorLoader	_descriptorLoader Lazily constructed instance of `DescriptorLoader`, used for loading structured protoc definitions from multiple files.
private final ReentrantLock	_descriptorLock
protected ProtobufSchemaLoader	_schemaLoader
private static final long	serialVersionUID Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

Inherited from tools.jackson.databind.ObjectMapper:: _deserializationConfig _deserializationContexts _injectableValues _rootDeserializers _savedBuilderState _serializationConfig _serializationContexts _streamFactory _typeFactory

Constructor Summary

Access	Constructor and Description
public	ProtobufMapper()
public	ProtobufMapper(ProtobufFactory f)
public	ProtobufMapper(ProtobufMapper.Builder b)

Method Summary

Modifier and Type	Method and Description
public static ProtobufMapper.Builder	builder()
public static ProtobufMapper.Builder	builder(ProtobufFactory streamFactory)
public DescriptorLoader	descriptorLoader() Accessors that may be used instead of convenience `loadDescriptorSet` methods, if alternate sources need to be used.
public ProtobufSchema	Returns: Generated `ProtobufSchema` generateSchemaFor(JavaType Resolved type to generate `ProtobufSchema` for type) Convenience method for constructing protoc definition that matches given Java type.
public ProtobufSchema	Returns: Generated `ProtobufSchema` generateSchemaFor(Class<?> Type-erased type to generate `ProtobufSchema` for type) Convenience method for constructing protoc definition that matches given Java type.
public ProtobufSchema	Returns: Generated `ProtobufSchema` generateSchemaFor(TypeReference<?> Type to generate `ProtobufSchema` for type) Convenience method for constructing protoc definition that matches given Java type.
public FileDescriptorSet	loadDescriptorSet(URL src)
public FileDescriptorSet	loadDescriptorSet(File src)
public FileDescriptorSet	loadDescriptorSet(InputStream src)
public ProtobufMapper.Builder	rebuild() Overrides tools.jackson.databind.ObjectMapper.rebuild. Method for creating a new `MapperBuilder` for constructing differently configured `ObjectMapper` instance, starting with current configuration including base settings and registered modules.
public ProtobufSchemaLoader	schemaLoader() Accessor for reusable `ProtobufSchemaLoader` which can be used for loading protoc definitions from files and other external sources.
public void	setSchemaLoader(ProtobufSchemaLoader l)
public static ProtobufMapper	shared() Accessor method for getting globally shared "default" `ProtobufMapper` instance: one that has default configuration, no modules registered, no config overrides.
public ProtobufFactory	tokenStreamFactory() Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory. Method that can be used to get hold of `TokenStreamFactory` that this mapper uses if it needs to construct `JsonParser`s and/or `JsonGenerator`s.
public Version	version() Overrides tools.jackson.databind.ObjectMapper.version. Implements tools.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.

Inherited from tools.jackson.databind.ObjectMapper:: _assertNotNull _configAndWriteValue _convert _deserializationContext _deserializationContext _deserializationContext _findRootDeserializer _initForReading _newReader _newReader _newWriter _newWriter _newWriter _readMapAndClose _readTreeAndClose _readValue _serializationContext _serializationContext _verifyNoTrailingTokens _verifySchemaType _writeCloseableValue acceptJsonFormatVisitor acceptJsonFormatVisitor acceptJsonFormatVisitor booleanNode clearCaches constructType constructType convertValue convertValue convertValue createArrayNode createGenerator createGenerator createGenerator createGenerator createGenerator createGenerator createNonBlockingByteArrayParser createNonBlockingByteBufferParser createObjectNode createParser createParser createParser createParser createParser createParser createParser createParser createParser createParser deserializationConfig getInjectableValues getNodeFactory getTypeFactory isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled missingNode nullNode reader reader reader reader reader reader reader reader reader readerFor readerFor readerFor readerForArrayOf readerForListOf readerForMapOf readerForUpdating readerWithView readResolve readTree readTree readTree readTree readTree readTree readTree readTree readTree readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValue readValues readValues readValues registeredModules serializationConfig stringNode treeAsTokens treeToValue treeToValue treeToValue updateValue valueToTree writer writer writer writer writer writer writer writer writer writer writeReplace writerFor writerFor writerFor writerWithDefaultPrettyPrinter writerWithView writeTree writeValue writeValue writeValue writeValue writeValue writeValue writeValueAsBytes writeValueAsString writeValueIntoBuffer

Field Detail

_descriptorLoader	back to summary
protected volatile DescriptorLoader _descriptorLoader Lazily constructed instance of `DescriptorLoader`, used for loading structured protoc definitions from multiple files.

_descriptorLock	back to summary
private final ReentrantLock _descriptorLock

_schemaLoader	back to summary
protected ProtobufSchemaLoader _schemaLoader

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

Constructor Detail

ProtobufMapper	back to summary
public ProtobufMapper()

ProtobufMapper	back to summary
public ProtobufMapper(ProtobufFactory f)

ProtobufMapper	back to summary
public ProtobufMapper(ProtobufMapper.Builder b)

Method Detail

builder	back to summary
public static ProtobufMapper.Builder builder()

builder	back to summary
public static ProtobufMapper.Builder builder(ProtobufFactory streamFactory)

descriptorLoader	back to summary
public DescriptorLoader descriptorLoader() throws IOException Accessors that may be used instead of convenience `loadDescriptorSet` methods, if alternate sources need to be used.

generateSchemaFor back to summary

generateSchemaFor	back to summary
public ProtobufSchema generateSchemaFor(JavaType type) Convenience method for constructing protoc definition that matches given Java type. Uses `ProtobufSchemaGenerator` for generation. Parameters type:JavaType Resolved type to generate `ProtobufSchema` for Returns:ProtobufSchema Generated `ProtobufSchema`

public ProtobufSchema generateSchemaFor(JavaType type)

Convenience method for constructing protoc definition that matches given Java type. Uses ProtobufSchemaGenerator for generation.

Parameters

type:JavaType: Resolved type to generate ProtobufSchema for

Returns:ProtobufSchema

Generated ProtobufSchema

generateSchemaFor back to summary

generateSchemaFor	back to summary
public ProtobufSchema generateSchemaFor(Class<?> type) Convenience method for constructing protoc definition that matches given Java type. Uses `ProtobufSchemaGenerator` for generation. Parameters type:Class<?> Type-erased type to generate `ProtobufSchema` for Returns:ProtobufSchema Generated `ProtobufSchema`

public ProtobufSchema generateSchemaFor(Class<?> type)

Convenience method for constructing protoc definition that matches given Java type. Uses ProtobufSchemaGenerator for generation.

Parameters

type:Class<?>: Type-erased type to generate ProtobufSchema for

Returns:ProtobufSchema

Generated ProtobufSchema

generateSchemaFor back to summary

generateSchemaFor	back to summary
public ProtobufSchema generateSchemaFor(TypeReference<?> type) Convenience method for constructing protoc definition that matches given Java type. Uses `ProtobufSchemaGenerator` for generation. Parameters type:TypeReference<?> Type to generate `ProtobufSchema` for Returns:ProtobufSchema Generated `ProtobufSchema`

public ProtobufSchema generateSchemaFor(TypeReference<?> type)

Convenience method for constructing protoc definition that matches given Java type. Uses ProtobufSchemaGenerator for generation.

Parameters

type:TypeReference<?>: Type to generate ProtobufSchema for

Returns:ProtobufSchema

Generated ProtobufSchema

loadDescriptorSet	back to summary
public FileDescriptorSet loadDescriptorSet(URL src) throws IOException

loadDescriptorSet	back to summary
public FileDescriptorSet loadDescriptorSet(File src) throws IOException

loadDescriptorSet	back to summary
public FileDescriptorSet loadDescriptorSet(InputStream src) throws IOException

rebuild back to summary

rebuild	back to summary
public ProtobufMapper.Builder rebuild() Overrides tools.jackson.databind.ObjectMapper.rebuild. Doc from tools.jackson.databind.ObjectMapper.rebuild. Method for creating a new `MapperBuilder` for constructing differently configured `ObjectMapper` instance, starting with current configuration including base settings and registered modules. Annotations @SuppressWarnings:unchecked @Override

public ProtobufMapper.Builder rebuild()

Overrides tools.jackson.databind.ObjectMapper.rebuild.

Doc from tools.jackson.databind.ObjectMapper.rebuild.

Method for creating a new MapperBuilder for constructing differently configured ObjectMapper instance, starting with current configuration including base settings and registered modules.

Annotations

@SuppressWarnings:unchecked
@Override

schemaLoader	back to summary
public ProtobufSchemaLoader schemaLoader() Accessor for reusable `ProtobufSchemaLoader` which can be used for loading protoc definitions from files and other external sources.

setSchemaLoader	back to summary
public void setSchemaLoader(ProtobufSchemaLoader l)

shared	back to summary
public static ProtobufMapper shared() Accessor method for getting globally shared "default" `ProtobufMapper` instance: one that has default configuration, no modules registered, no config overrides. Usable mostly when dealing "untyped" or Tree-style content reading and writing.

tokenStreamFactory back to summary

tokenStreamFactory	back to summary
public ProtobufFactory tokenStreamFactory() Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory. Doc from tools.jackson.databind.ObjectMapper.tokenStreamFactory. Method that can be used to get hold of `TokenStreamFactory` that this mapper uses if it needs to construct `JsonParser`s and/or `JsonGenerator`s. Warning note that all `ObjectReader` and `ObjectWriter` instances created by this mapper usually share the same configured `TokenStreamFactory`, so changes to its configuration will "leak". To avoid such observed changes you should always use "with()" and "without()" method of `ObjectReader` and `ObjectWriter` for changing `StreamReadFeature` and `StreamWriteFeature` settings to use on per-call basis. Annotations @Override

public ProtobufFactory tokenStreamFactory()

Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Doc from tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Method that can be used to get hold of TokenStreamFactory that this mapper uses if it needs to construct JsonParsers and/or JsonGenerators.

Warning

note that all ObjectReader and ObjectWriter instances created by this mapper usually share the same configured TokenStreamFactory, so changes to its configuration will "leak". To avoid such observed changes you should always use "with()" and "without()" method of ObjectReader and ObjectWriter for changing StreamReadFeature and StreamWriteFeature settings to use on per-call basis.

Annotations

@Override

version	back to summary
public Version version() Overrides tools.jackson.databind.ObjectMapper.version. Implements tools.jackson.core.Versioned.version. Doc from tools.jackson.databind.ObjectMapper.version. Method that will return version information stored in and read from jar that contains this class. Annotations @Override

version

back to summary

public Version version()

Overrides tools.jackson.databind.ObjectMapper.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.databind.ObjectMapper.version.

Method that will return version information stored in and read from jar that contains this class.

Annotations

@Override

tools.jackson.dataformat.protobuf back to summary

public Class ProtobufMapper.Builder

Class Inheritance

extends MapperBuilder<ProtobufMapper, ProtobufMapper.Builder>

java.lang.Object
tools.jackson.databind.cfg.MapperBuilder
tools.jackson.dataformat.protobuf.ProtobufMapper.Builder

Base implementation for "Vanilla" ObjectMapper, used with Protobuf backend.

Since: 3.0

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static class	ProtobufMapper.Builder.StateImpl

Field Summary

Constructor Summary

Access	Constructor and Description
public	Builder(ProtobufFactory f)
public	Builder(ProtobufMapper.Builder.StateImpl State to restore to initialize constructed Builder state) Note while technically public, not intended for external use (since `StateImpl` is not public type)

Method Summary

Modifier and Type	Method and Description
protected MapperBuilderState	_saveState() Implements abstract tools.jackson.databind.cfg.MapperBuilder._saveState.
public ProtobufMapper	build() Implements abstract tools.jackson.databind.cfg.MapperBuilder.build. Method to call to create actual mapper instance.

Inherited from tools.jackson.databind.cfg.MapperBuilder:: _constructModuleContext _defaultClassIntrospector _defaultDefaultAttributes _defaultDefaultTypingResolver _defaultDefaultTypingResolver _defaultDeserializationContexts _defaultMixInHandler _defaultPrettyPrinter _defaultSerializationContexts _defaultSerializerFactory _defaultSubtypeResolver _defaultTypeFactory _defaultTypeResolverProvider _this accessorNaming activateDefaultTyping activateDefaultTyping activateDefaultTyping activateDefaultTypingAsProperty addAbstractTypeResolver addHandler addMixIn addMixIns addModule addModules addModules addTypeModifier annotationIntrospector annotationIntrospector baseSettings baseSettings buildDeserializationConfig buildSerializationConfig cacheProvider changeDefaultNullHandling changeDefaultPropertyInclusion changeDefaultVisibility classIntrospector classIntrospector clearProblemHandlers configure configure configure configure configure configure configureForJackson2 constructorDetector datatypeFeatures deactivateDefaultTyping defaultAttributes defaultAttributes defaultBase64Variant defaultDateFormat defaultLeniency defaultLocale defaultMergeable defaultPrettyPrinter defaultPrettyPrinter defaultTimeZone deserializationContexts deserializationContexts deserializationProblemHandlers deserializerFactory deserializerFactory disable disable disable disable disable disable enable enable enable enable enable enable enumNamingStrategy filterProvider filterProvider findAndAddModules findAndAddModules findModules findModules handlerInstantiator injectableValues injectableValues isEnabled isEnabled isEnabled isEnabled isEnabled isEnabled mixInHandler mixInHandler mixInOverrides nodeFactory polymorphicTypeValidator propertyNamingStrategy registerSubtypes registerSubtypes registerSubtypes removeAllModules removeMixIn saveStateApplyModules serializationContexts serializationContexts serializerFactory serializerFactory setDefaultTyping streamFactory subtypeResolver subtypeResolver typeFactory typeFactory typeResolverProvider typeResolverProvider withAllCoercionConfigs withAllConfigOverrides withCoercionConfig withCoercionConfig withCoercionConfigDefaults withConfigOverride withModules

Constructor Detail

Builder	back to summary
public Builder(ProtobufFactory f)

Builder back to summary

Builder	back to summary
public Builder(ProtobufMapper.Builder.StateImpl state) Note while technically public, not intended for external use (since `StateImpl` is not public type) Parameters state:ProtobufMapper.Builder.StateImpl State to restore to initialize constructed Builder Annotations @SuppressWarnings:exports

public Builder(ProtobufMapper.Builder.StateImpl state)

Note

while technically public, not intended for external use (since StateImpl is not public type)

Parameters

state:ProtobufMapper.Builder.StateImpl: State to restore to initialize constructed Builder

Annotations

@SuppressWarnings:exports

Method Detail

_saveState	back to summary
protected MapperBuilderState _saveState() Implements abstract tools.jackson.databind.cfg.MapperBuilder._saveState. Annotations @Override

_saveState

back to summary

protected MapperBuilderState _saveState()

Implements abstract tools.jackson.databind.cfg.MapperBuilder._saveState.

Annotations

@Override

build back to summary

build	back to summary
public ProtobufMapper build() Implements abstract tools.jackson.databind.cfg.MapperBuilder.build. Doc from tools.jackson.databind.cfg.MapperBuilder.build. Method to call to create actual mapper instance. Implementation detail: usually construction occurs by passing `this` builder instance to constructor of specific mapper type builder builds. Annotations @Override

public ProtobufMapper build()

Implements abstract tools.jackson.databind.cfg.MapperBuilder.build.

Doc from tools.jackson.databind.cfg.MapperBuilder.build.

Method to call to create actual mapper instance.

Implementation detail: usually construction occurs by passing this builder instance to constructor of specific mapper type builder builds.

Annotations

@Override

tools.jackson.dataformat.protobuf back to summary

protected Class ProtobufMapper.Builder.StateImpl

Class Inheritance

extends MapperBuilderState
implements Serializable

java.lang.Object
tools.jackson.databind.cfg.MapperBuilderState
tools.jackson.dataformat.protobuf.ProtobufMapper.Builder.StateImpl

All Implemented Interfaces

java.io.Serializable

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides tools.jackson.databind.cfg.MapperBuilderState.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	StateImpl(ProtobufMapper.Builder src)

Method Summary

Modifier and Type	Method and Description
protected Object	readResolve() Implements abstract tools.jackson.databind.cfg.MapperBuilderState.readResolve. Method required to support JDK deserialization; made `abstract` here to ensure sub-classes must implement it.

Inherited from tools.jackson.databind.cfg.MapperBuilderState:: modules

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides tools.jackson.databind.cfg.MapperBuilderState.serialVersionUID.

Constructor Detail

StateImpl	back to summary
public StateImpl(ProtobufMapper.Builder src)

Method Detail

readResolve	back to summary
protected Object readResolve() Implements abstract tools.jackson.databind.cfg.MapperBuilderState.readResolve. Doc from tools.jackson.databind.cfg.MapperBuilderState.readResolve. Method required to support JDK deserialization; made `abstract` here to ensure sub-classes must implement it. Annotations @Override

readResolve

back to summary

protected Object readResolve()

Implements abstract tools.jackson.databind.cfg.MapperBuilderState.readResolve.

Doc from tools.jackson.databind.cfg.MapperBuilderState.readResolve.

Method required to support JDK deserialization; made `abstract` here to ensure sub-classes must implement it.

Annotations

@Override

tools.jackson.dataformat.protobuf back to summary

private final Class ProtobufMapper.SharedWrapper

Class Inheritance

extends Object

java.lang.Object
tools.jackson.dataformat.protobuf.ProtobufMapper.SharedWrapper

Helper class to contain dynamically constructed "shared" instance of mapper, should one be needed via shared.

Field Summary

Modifier and Type	Field and Description
private static final ProtobufMapper	MAPPER

Constructor Summary

Access	Constructor and Description
private	SharedWrapper()

Method Summary

Modifier and Type	Method and Description
public static ProtobufMapper	wrapped()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

MAPPER	back to summary
private static final ProtobufMapper MAPPER

Constructor Detail

SharedWrapper	back to summary
private SharedWrapper()

Method Detail

wrapped	back to summary
public static ProtobufMapper wrapped()