Top Description Inners Fields Constructors Methods
com.fasterxml.jackson.dataformat.yaml

public Class YAMLMapper

extends ObjectMapper
Class Inheritance
Imports
com.fasterxml.jackson.databind.ObjectMapper, com.fasterxml.jackson.databind.cfg.MapperBuilder
Convenience version of ObjectMapper which is configured with com.fasterxml.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.

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.ObjectMapper.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.ObjectMapper:
_coercionConfigs_configOverrides_deserializationConfig_deserializationContext_injectableValues_jsonFactory_mixIns_registeredModuleTypes_rootDeserializers_serializationConfig_serializerFactory_serializerProvider_subtypeResolver_typeFactoryDEFAULT_ANNOTATION_INTROSPECTORDEFAULT_BASE

Constructor Summary

AccessConstructor and Description
public
YAMLMapper()

public
YAMLMapper(YAMLFactory f)

public
YAMLMapper(YAMLMapper base)

Method Summary

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

public static YAMLMapper.Builder
builder(YAMLFactory streamFactory)

public YAMLMapper
configure(YAMLGenerator.Feature f, boolean state)

public YAMLMapper
configure(YAMLParser.Feature f, boolean state)

public YAMLMapper
copy()

Overrides com.fasterxml.jackson.databind.ObjectMapper.copy.

Method for creating a new ObjectMapper instance that has same initial configuration as this instance.

public YAMLMapper
disable(YAMLGenerator.Feature f)

public YAMLMapper
disable(YAMLParser.Feature f)

public YAMLMapper
enable(YAMLGenerator.Feature f)

public YAMLMapper
enable(YAMLParser.Feature f)

public final YAMLFactory
getFactory()

Overrides com.fasterxml.jackson.databind.ObjectMapper.getFactory.

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

Inherited from com.fasterxml.jackson.databind.ObjectMapper:
_assertNotNull_checkInvalidCopy_configAndWriteValue_constructDefaultTypeResolverBuilder_convert_findRootDeserializer_initForReading_newReader_newReader_newWriter_newWriter_newWriter_readMapAndClose_readTreeAndClose_readValue_serializerProvider_verifyNoTrailingTokens_verifySchemaType_writeValueAndCloseacceptJsonFormatVisitoracceptJsonFormatVisitoractivateDefaultTypingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingAsPropertyaddHandleraddMixInaddMixInAnnotationscanDeserializecanDeserializecanSerializecanSerializeclearProblemHandlerscoercionConfigDefaultscoercionConfigForcoercionConfigForconfigOverrideconfigureconfigureconfigureconfigureconfigureconfigureconstructTypeconstructTypeconvertValueconvertValueconvertValuecopyWithcreateArrayNodecreateDeserializationContextcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateNonBlockingByteArrayParsercreateObjectNodecreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParserdeactivateDefaultTypingdefaultClassIntrospectordisabledisabledisabledisabledisabledisabledisabledisableDefaultTypingenableenableenableenableenableenableenableenableDefaultTypingenableDefaultTypingenableDefaultTypingenableDefaultTypingAsPropertyfindAndRegisterModulesfindMixInClassForfindModulesfindModulesgenerateJsonSchemagetDateFormatgetDeserializationConfiggetDeserializationContextgetInjectableValuesgetNodeFactorygetPolymorphicTypeValidatorgetPropertyNamingStrategygetRegisteredModuleIdsgetSerializationConfiggetSerializerFactorygetSerializerProvidergetSerializerProviderInstancegetSubtypeResolvergetTypeFactorygetVisibilityCheckerisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledmissingNodemixInCountnullNodereaderreaderreaderreaderreaderreaderreaderreaderreaderreaderreaderreaderForreaderForreaderForreaderForArrayOfreaderForListOfreaderForMapOfreaderForUpdatingreaderWithViewreadTreereadTreereadTreereadTreereadTreereadTreereadTreereadTreereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuesreadValuesreadValuesreadValuesregisterModuleregisterModulesregisterModulesregisterSubtypesregisterSubtypesregisterSubtypessetAccessorNamingsetAnnotationIntrospectorsetAnnotationIntrospectorssetBase64VariantsetCacheProvidersetConfigsetConfigsetConstructorDetectorsetDateFormatsetDefaultAttributessetDefaultLeniencysetDefaultMergeablesetDefaultPrettyPrintersetDefaultPropertyInclusionsetDefaultPropertyInclusionsetDefaultSetterInfosetDefaultTypingsetDefaultVisibilitysetFilterProvidersetFilterssetHandlerInstantiatorsetInjectableValuessetLocalesetMixInAnnotationssetMixInResolversetMixInssetNodeFactorysetPolymorphicTypeValidatorsetPropertyInclusionsetPropertyNamingStrategysetSerializationInclusionsetSerializerFactorysetSerializerProvidersetSubtypeResolversetTimeZonesetTypeFactorysetVisibilitysetVisibilitysetVisibilityCheckertokenStreamFactorytreeAsTokenstreeToValuetreeToValuetreeToValueupdateValuevalueToTreeversionwriterwriterwriterwriterwriterwriterwriterwriterwriterwriterwriterForwriterForwriterForwriterWithDefaultPrettyPrinterwriterWithTypewriterWithTypewriterWithTypewriterWithViewwriteTreewriteTreewriteValuewriteValuewriteValuewriteValuewriteValuewriteValueAsByteswriteValueAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.ObjectMapper.serialVersionUID.

Constructor Detail

YAMLMapperback to summary
public YAMLMapper()
YAMLMapperback to summary
public YAMLMapper(YAMLFactory f)
YAMLMapperback to summary
public YAMLMapper(YAMLMapper base)
Since
2.5

Method Detail

builderback to summary
public static YAMLMapper.Builder builder()
builderback to summary
public static YAMLMapper.Builder builder(YAMLFactory streamFactory)
configureback to summary
public YAMLMapper configure(YAMLGenerator.Feature f, boolean state)
configureback to summary
public YAMLMapper configure(YAMLParser.Feature f, boolean state)
copyback to summary
public YAMLMapper copy()

Overrides com.fasterxml.jackson.databind.ObjectMapper.copy.

Doc from com.fasterxml.jackson.databind.ObjectMapper.copy.

Method for creating a new ObjectMapper instance that has same initial configuration as this instance. Note that this also requires making a copy of the underlying JsonFactory instance.

Method is typically used when multiple, differently configured mappers are needed. Although configuration is shared, cached serializers and deserializers are NOT shared, which means that the new instance may be re-configured before use; meaning that it behaves the same way as if an instance was constructed from scratch.

Annotations
@Override
Since
2.5
disableback to summary
public YAMLMapper disable(YAMLGenerator.Feature f)
disableback to summary
public YAMLMapper disable(YAMLParser.Feature f)
enableback to summary
public YAMLMapper enable(YAMLGenerator.Feature f)
enableback to summary
public YAMLMapper enable(YAMLParser.Feature f)
getFactoryback to summary
public final YAMLFactory getFactory()

Overrides com.fasterxml.jackson.databind.ObjectMapper.getFactory.

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

Returns:YAMLFactory

Doc from com.fasterxml.jackson.core.ObjectCodec.getFactory.

Underlying JsonFactory instance

Annotations
@Override
com.fasterxml.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

Field Summary

Inherited from com.fasterxml.jackson.databind.cfg.MapperBuilder:
_mapper

Constructor Summary

AccessConstructor and Description
public
Builder(YAMLMapper m)

Method Summary

Modifier and TypeMethod and Description
public YAMLMapper.Builder
configure(YAMLParser.Feature f, boolean state)

public YAMLMapper.Builder
configure(YAMLGenerator.Feature f, boolean state)

public YAMLMapper.Builder
disable(YAMLParser.Feature... features)

public YAMLMapper.Builder
disable(YAMLGenerator.Feature... features)

public YAMLMapper.Builder
enable(YAMLParser.Feature... features)

public YAMLMapper.Builder
enable(YAMLGenerator.Feature... features)

Inherited from com.fasterxml.jackson.databind.cfg.MapperBuilder:
_thisaccessorNamingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingAsPropertyaddHandleraddMixInaddModuleaddModulesaddModulesannotationIntrospectorbuildcacheProviderclearProblemHandlersconfigureconfigureconfigureconfigureconfigureconfigureconfigureconfigureconstructorDetectordeactivateDefaultTypingdefaultAttributesdefaultBase64VariantdefaultDateFormatdefaultLeniencydefaultLocaledefaultMergeabledefaultPrettyPrinterdefaultPropertyInclusiondefaultSetterInfodefaultTimeZonedisabledisabledisabledisabledisabledisabledisabledisableenableenableenableenableenableenableenableenablefilterProviderfindAndAddModulesfindModulesfindModuleshandlerInstantiatorinjectableValuesisEnabledisEnabledisEnabledisEnabledisEnablednodeFactorypolymorphicTypeValidatorpropertyNamingStrategyregisterSubtypesregisterSubtypesregisterSubtypesremoveMixInserializationInclusionserializerFactorysetDefaultTypingstreamFactorysubtypeResolvertypeFactoryvisibilityvisibilitywithCoercionConfigwithCoercionConfigwithCoercionConfigDefaultswithConfigOverride

Constructor Detail

Builderback to summary
public Builder(YAMLMapper m)

Method Detail

configureback to summary
public YAMLMapper.Builder configure(YAMLParser.Feature f, boolean state)
configureback to summary
public YAMLMapper.Builder configure(YAMLGenerator.Feature f, boolean state)
disableback to summary
public YAMLMapper.Builder disable(YAMLParser.Feature... features)
disableback to summary
public YAMLMapper.Builder disable(YAMLGenerator.Feature... features)
enableback to summary
public YAMLMapper.Builder enable(YAMLParser.Feature... features)
enableback to summary
public YAMLMapper.Builder enable(YAMLGenerator.Feature... features)