Top Description Inners Fields Constructors Methods
tools.jackson.dataformat.yaml

public Class YAMLMapper

extends ObjectMapper
Class Inheritance
Imports
tools.jackson.core.Version, tools.jackson.databind.ObjectMapper, tools.jackson.databind.cfg.MapperBuilder, .MapperBuilderState

Convenience version of ObjectMapper which is configured with tools.jackson.dataformat.yaml.YAMLFactory.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
YAMLMapper.Builder

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

private static class
YAMLMapper.SharedWrapper

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

Field Summary

Modifier and TypeField and Description
private static final long
Inherited from tools.jackson.databind.ObjectMapper:
_deserializationConfig_deserializationContexts_injectableValues_rootDeserializers_savedBuilderState_serializationConfig_serializationContexts_streamFactory_typeFactory

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public static YAMLMapper.Builder
public static YAMLMapper.Builder
builder(YAMLFactory streamFactory)

protected Object
public YAMLMapper.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 static YAMLMapper
shared()

Accessor method for getting globally shared "default" YAMLMapper instance: one that has default configuration, no modules registered, no config overrides.

public final YAMLFactory
tokenStreamFactory()

Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Overridden with more specific type, since factory we have is always of type YAMLFactory

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.

protected Object
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_writeCloseableValueacceptJsonFormatVisitoracceptJsonFormatVisitoracceptJsonFormatVisitorbooleanNodeclearCachesconstructTypeconstructTypeconvertValueconvertValueconvertValuecreateArrayNodecreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateNonBlockingByteArrayParsercreateNonBlockingByteBufferParsercreateObjectNodecreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParserdeserializationConfiggetInjectableValuesgetNodeFactorygetTypeFactoryisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledmissingNodenullNodereaderreaderreaderreaderreaderreaderreaderreaderreaderreaderForreaderForreaderForreaderForArrayOfreaderForListOfreaderForMapOfreaderForUpdatingreaderWithViewreadTreereadTreereadTreereadTreereadTreereadTreereadTreereadTreereadTreereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuesreadValuesreadValuesregisteredModulesserializationConfigstringNodetreeAsTokenstreeToValuetreeToValuetreeToValueupdateValuevalueToTreewriterwriterwriterwriterwriterwriterwriterwriterwriterwriterwriterForwriterForwriterForwriterWithDefaultPrettyPrinterwriterWithViewwriteTreewriteValuewriteValuewriteValuewriteValuewriteValuewriteValuewriteValueAsByteswriteValueAsStringwriteValueIntoBuffer

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides tools.jackson.databind.ObjectMapper.serialVersionUID.

Constructor Detail

YAMLMapperback to summary
public YAMLMapper()
YAMLMapperback to summary
public YAMLMapper(YAMLFactory f)
YAMLMapperback to summary
public YAMLMapper(YAMLMapper.Builder b)

Method Detail

builderback to summary
public static YAMLMapper.Builder builder()
builderback to summary
public static YAMLMapper.Builder builder(YAMLFactory streamFactory)
readResolveback to summary
protected Object readResolve()

Overrides tools.jackson.databind.ObjectMapper.readResolve.

Annotations
@Override
rebuildback to summary
public YAMLMapper.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
sharedback to summary
public static YAMLMapper shared()

Accessor method for getting globally shared "default" YAMLMapper instance: one that has default configuration, no modules registered, no config overrides. Usable mostly when dealing "untyped" or Tree-style content reading and writing.

tokenStreamFactoryback to summary
public final YAMLFactory tokenStreamFactory()

Overrides tools.jackson.databind.ObjectMapper.tokenStreamFactory.

Overridden with more specific type, since factory we have is always of type YAMLFactory

Annotations
@Override
versionback 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
writeReplaceback to summary
protected Object writeReplace()

Overrides tools.jackson.databind.ObjectMapper.writeReplace.

Annotations
@Override
tools.jackson.dataformat.yaml back to summary

public Class YAMLMapper.Builder

extends MapperBuilder<YAMLMapper, YAMLMapper.Builder>
Class Inheritance

Base implementation for "Vanilla" ObjectMapper, used with YAML backend.
Since
3.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class

Field Summary

Inherited from tools.jackson.databind.cfg.MapperBuilder:
_abstractTypeResolvers_baseSettings_classIntrospector_coercionConfigs_configOverrides_datatypeFeatures_defaultAttributes_defaultPrettyPrinter_deserFeatures_deserializationContexts_deserializerFactory_filterProvider_formatReadFeatures_formatWriteFeatures_injectableValues_mapperFeatures_mixInHandler_modules_problemHandlers_savedState_serFeatures_serializationContexts_serializerFactory_streamFactory_streamReadFeatures_streamWriteFeatures_subtypeResolver_typeFactory_typeResolverProviderDEFAULT_ACCESSOR_NAMINGDEFAULT_ANNOTATION_INTROSPECTORDEFAULT_BASE_SETTINGSDEFAULT_DESER_FEATURESDEFAULT_MAPPER_FEATURESDEFAULT_PRETTY_PRINTERDEFAULT_SER_FEATURESDEFAULT_TYPE_RESOLVER_PROVIDERDEFAULT_TYPE_VALIDATORNO_ABSTRACT_TYPE_RESOLVERS

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
protected MapperBuilderState
public YAMLMapper
build()

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

Method to call to create actual mapper instance.

public YAMLMapper.Builder
configure(YAMLReadFeature feature, boolean state)

public YAMLMapper.Builder
configure(YAMLWriteFeature feature, boolean state)

public YAMLMapper.Builder
disable(YAMLReadFeature... features)

public YAMLMapper.Builder
public YAMLMapper.Builder
enable(YAMLReadFeature... features)

public YAMLMapper.Builder
enable(YAMLWriteFeature... features)

Inherited from tools.jackson.databind.cfg.MapperBuilder:
_constructModuleContext_defaultClassIntrospector_defaultDefaultAttributes_defaultDefaultTypingResolver_defaultDefaultTypingResolver_defaultDeserializationContexts_defaultMixInHandler_defaultPrettyPrinter_defaultSerializationContexts_defaultSerializerFactory_defaultSubtypeResolver_defaultTypeFactory_defaultTypeResolverProvider_thisaccessorNamingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingAsPropertyaddAbstractTypeResolveraddHandleraddMixInaddMixInsaddModuleaddModulesaddModulesaddTypeModifierannotationIntrospectorannotationIntrospectorbaseSettingsbaseSettingsbuildDeserializationConfigbuildSerializationConfigcacheProviderchangeDefaultNullHandlingchangeDefaultPropertyInclusionchangeDefaultVisibilityclassIntrospectorclassIntrospectorclearProblemHandlersconfigureconfigureconfigureconfigureconfigureconfigureconfigureForJackson2constructorDetectordatatypeFeaturesdeactivateDefaultTypingdefaultAttributesdefaultAttributesdefaultBase64VariantdefaultDateFormatdefaultLeniencydefaultLocaledefaultMergeabledefaultPrettyPrinterdefaultPrettyPrinterdefaultTimeZonedeserializationContextsdeserializationContextsdeserializationProblemHandlersdeserializerFactorydeserializerFactorydisabledisabledisabledisabledisabledisableenableenableenableenableenableenableenumNamingStrategyfilterProviderfilterProviderfindAndAddModulesfindAndAddModulesfindModulesfindModuleshandlerInstantiatorinjectableValuesinjectableValuesisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledmixInHandlermixInHandlermixInOverridesnodeFactorypolymorphicTypeValidatorpropertyNamingStrategyregisterSubtypesregisterSubtypesregisterSubtypesremoveAllModulesremoveMixInsaveStateApplyModulesserializationContextsserializationContextsserializerFactoryserializerFactorysetDefaultTypingstreamFactorysubtypeResolversubtypeResolvertypeFactorytypeFactorytypeResolverProvidertypeResolverProviderwithAllCoercionConfigswithAllConfigOverrideswithCoercionConfigwithCoercionConfigwithCoercionConfigDefaultswithConfigOverridewithModules

Constructor Detail

Builderback to summary
public Builder(YAMLFactory f)
Builderback to summary
public Builder(YAMLMapper.Builder.StateImpl state)

Method Detail

_saveStateback to summary
protected MapperBuilderState _saveState()

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

Annotations
@Override
buildback to summary
public YAMLMapper 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
configureback to summary
public YAMLMapper.Builder configure(YAMLReadFeature feature, boolean state)
configureback to summary
public YAMLMapper.Builder configure(YAMLWriteFeature feature, boolean state)
disableback to summary
public YAMLMapper.Builder disable(YAMLReadFeature... features)
disableback to summary
public YAMLMapper.Builder disable(YAMLWriteFeature... features)
enableback to summary
public YAMLMapper.Builder enable(YAMLReadFeature... features)
enableback to summary
public YAMLMapper.Builder enable(YAMLWriteFeature... features)
tools.jackson.dataformat.yaml back to summary

protected Class YAMLMapper.Builder.StateImpl

extends MapperBuilderState
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod 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

serialVersionUIDback to summary
private static final long serialVersionUID

Hides tools.jackson.databind.cfg.MapperBuilderState.serialVersionUID.

Constructor Detail

StateImplback to summary
public StateImpl(YAMLMapper.Builder src)

Method Detail

readResolveback 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.yaml back to summary

private final Class YAMLMapper.SharedWrapper

extends Object
Class Inheritance

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

Field Summary

Modifier and TypeField and Description
private static final YAMLMapper

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static YAMLMapper
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

MAPPERback to summary
private static final YAMLMapper MAPPER

Constructor Detail

SharedWrapperback to summary
private SharedWrapper()

Method Detail

wrappedback to summary
public static YAMLMapper wrapped()