Java com.fasterxml.jackson.databind ObjectMapper fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for com.fasterxml.jackson.databind ObjectMapper.

The text is from its open source code.

Subclass

com.fasterxml.jackson.databind.ObjectMapper has subclasses.
Click this link to see all its subclasses.

Constructor

	ObjectMapper() Default constructor, which will construct the default JsonFactory as necessary, use SerializerProvider as its SerializerProvider , and BeanSerializerFactory as its SerializerFactory .
	ObjectMapper(JsonFactory jf) Constructs instance that uses specified JsonFactory for constructing necessary JsonParser s and/or JsonGenerator s.
	ObjectMapper(ObjectMapper src) Copy-constructor, mostly used to support #copy .

Method

void	acceptJsonFormatVisitor(Class type, JsonFormatVisitorWrapper visitor) Method for visiting type hierarchy for given type, using specified visitor.
void	acceptJsonFormatVisitor(JavaType type, JsonFormatVisitorWrapper visitor) Method for visiting type hierarchy for given type, using specified visitor.
ObjectMapper	addHandler(DeserializationProblemHandler h) Method for adding specified DeserializationProblemHandler to be used for handling specific problems during deserialization.
void	addMixInAnnotations(Class target, Class mixinSource) Method to use for adding mix-in annotations to use for augmenting specified class or interface.
boolean	canDeserialize(JavaType type) Method that can be called to check whether mapper thinks it could deserialize an Object of given type.
boolean	canSerialize(Class type) Method that can be called to check whether mapper thinks it could serialize an instance of given Class.
ObjectMapper	configure(MapperFeature f, boolean state) Method for changing state of an on/off mapper feature for this mapper instance.
ObjectMapper	configure(SerializationFeature f, boolean state) Method for changing state of an on/off serialization feature for this object mapper.
ObjectMapper	configure(DeserializationFeature f, boolean state) Method for changing state of an on/off deserialization feature for this object mapper.
ObjectMapper	configure(JsonParser.Feature f, boolean state) Method for changing state of an on/off JsonParser feature for JsonFactory instance this object mapper uses.
ObjectMapper	configure(JsonGenerator.Feature f, boolean state) Method for changing state of an on/off JsonGenerator feature for JsonFactory instance this object mapper uses.
JavaType	constructType(Type t) Convenience method for constructing JavaType out of given type (typically `java.lang.Class`), but without explicit context.
T	convertValue(Object fromValue, Class toValueType) Convenience method for doing two-step conversion from given value, into instance of given value type.
T	convertValue(Object fromValue, TypeReference toValueTypeRef)
T	convertValue(Object fromValue, JavaType toValueType)
ObjectMapper	copy() Method for creating a new ObjectMapper instance that has same initial configuration as this instance.
ArrayNode	createArrayNode() Note: return type is co-variant, as basic ObjectCodec abstraction can not refer to concrete node types (as it's part of core package, whereas impls are part of mapper package)
ObjectNode	createObjectNode() Note: return type is co-variant, as basic ObjectCodec abstraction can not refer to concrete node types (as it's part of core package, whereas impls are part of mapper package)
ObjectMapper	disable(MapperFeature... f) Method for enabling specified DeserializationConfig features.
ObjectMapper	disable(DeserializationFeature feature) Method for enabling specified DeserializationConfig features.
ObjectMapper	disable(SerializationFeature f) Method for enabling specified DeserializationConfig features.
ObjectMapper	disable(DeserializationFeature first, DeserializationFeature... f) Method for enabling specified DeserializationConfig features.
ObjectMapper	disable(SerializationFeature first, SerializationFeature... f) Method for enabling specified DeserializationConfig features.
ObjectMapper	enable(MapperFeature... f) Method for enabling specified MapperConfig features.
ObjectMapper	enable(DeserializationFeature feature) Method for enabling specified DeserializationConfig features.
ObjectMapper	enable(SerializationFeature f) Method for enabling specified DeserializationConfig feature.
ObjectMapper	enable(DeserializationFeature first, DeserializationFeature... f) Method for enabling specified DeserializationConfig features.
ObjectMapper	enable(SerializationFeature first, SerializationFeature... f) Method for enabling specified DeserializationConfig features.
ObjectMapper	enableDefaultTyping(DefaultTyping dti) Convenience method that is equivalent to calling enableObjectTyping(dti, JsonTypeInfo.As.WRAPPER_ARRAY);
ObjectMapper	enableDefaultTyping() Convenience method that is equivalent to calling enableObjectTyping(DefaultTyping.OBJECT_AND_NON_CONCRETE);
ObjectMapper	enableDefaultTyping(DefaultTyping applicability, JsonTypeInfo.As includeAs) Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated with com.fasterxml.jackson.annotation.JsonTypeInfo ).
ObjectMapper	enableDefaultTypingAsProperty(DefaultTyping applicability, String propertyName) Method for enabling automatic inclusion of type information -- needed for proper deserialization of polymorphic types (unless types have been annotated with com.fasterxml.jackson.annotation.JsonTypeInfo ) -- using "As.PROPERTY" inclusion mechanism and specified property name to use for inclusion (default being "@class" since default type information always uses class name as type identifier)
ObjectMapper	findAndRegisterModules() Convenience method that is functionally equivalent to: `mapper.registerModules(mapper.findModules()); As with #findModules() , no caching is done for modules, so care needs to be taken to either create and share a single mapper instance; or to cache introspected set of modules.`
Class	findMixInClassFor(Class cls)
List	findModules(ClassLoader classLoader) Method for locating available methods, using JDK ServiceLoader facility, along with module-provided SPI.
List	findModules() Method for locating available methods, using JDK ServiceLoader facility, along with module-provided SPI.
com.fasterxml.jackson.databind.jsonschema.JsonSchema	generateJsonSchema(Class t) Generate Json-schema instance for specified class.
Class	getClass() Returns the runtime class of this Object .
DeserializationConfig	getDeserializationConfig() Method that returns the shared default DeserializationConfig object that defines configuration settings for deserialization.
DeserializationContext	getDeserializationContext() Method for getting current DeserializationContext .
JsonFactory	getFactory() Method that can be used to get hold of JsonFactory that this mapper uses if it needs to construct JsonParser s and/or JsonGenerator s.
JsonFactory	getJsonFactory()
JsonNodeFactory	getNodeFactory() Method that can be used to get hold of JsonNodeFactory that this mapper will use when directly constructing root JsonNode instances for Trees.
SerializationConfig	getSerializationConfig() Method that returns the shared default SerializationConfig object that defines configuration settings for serialization.
SerializerFactory	getSerializerFactory() Method for getting current SerializerFactory .
SerializerProvider	getSerializerProvider()
SubtypeResolver	getSubtypeResolver() Method for accessing subtype resolver in use.
TypeFactory	getTypeFactory() Accessor for getting currently configured TypeFactory instance.
VisibilityChecker	getVisibilityChecker() Method for accessing currently configured visibility checker; object used for determining whether given property element (method, field, constructor) can be auto-detected or not.
ObjectReader	reader() Factory method for constructing ObjectReader with default settings.
ObjectReader	reader(DeserializationFeature feature) Factory method for constructing ObjectReader with specified feature enabled (compared to settings that this mapper instance has).
ObjectReader	reader(JavaType type) Factory method for constructing ObjectReader that will read or update instances of specified type
ObjectReader	reader(Class type) Factory method for constructing ObjectReader that will read or update instances of specified type
ObjectReader	reader(TypeReference type) Factory method for constructing ObjectReader that will read or update instances of specified type
ObjectReader	reader(JsonNodeFactory f) Factory method for constructing ObjectReader that will use specified JsonNodeFactory for constructing JSON trees.
ObjectReader	reader(FormatSchema schema) Factory method for constructing ObjectReader that will pass specific schema object to JsonParser used for reading content.
ObjectReader	reader(InjectableValues injectableValues) Factory method for constructing ObjectReader that will use specified injectable values.
ObjectReader	reader(Base64Variant defaultBase64) Factory method for constructing ObjectReader that will use specified Base64 encoding variant for Base64-encoded binary data.
ObjectReader	reader(ContextAttributes attrs) Factory method for constructing ObjectReader that will use specified default attributes.
ObjectReader	readerForUpdating(Object valueToUpdate) Factory method for constructing ObjectReader that will update given Object (usually Bean, but can be a Collection or Map as well, but NOT an array) with JSON data.
T	readTree(JsonParser jp) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
JsonNode	readTree(InputStream in) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
JsonNode	readTree(Reader r) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
JsonNode	readTree(String content) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
JsonNode	readTree(byte[] content) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
JsonNode	readTree(File file) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
JsonNode	readTree(URL source) Method to deserialize JSON content as tree expressed using set of JsonNode instances.
T	readValue(JsonParser jp, Class valueType) Method to deserialize JSON content into a non-container type (it can be an array type, however): typically a bean, array or a wrapper type (like java.lang.Boolean ).
T	readValue(JsonParser jp, TypeReference valueTypeRef) Method to deserialize JSON content into a Java type, reference to which is passed as argument.
T	readValue(JsonParser jp, ResolvedType valueType) Method to deserialize JSON content into a Java type, reference to which is passed as argument.
T	readValue(JsonParser jp, JavaType valueType) Type-safe overloaded method, basically alias for #readValue(JsonParser,ResolvedType) .
T	readValue(File src, Class valueType)
T	readValue(File src, TypeReference valueTypeRef)
T	readValue(File src, JavaType valueType)
T	readValue(URL src, Class valueType)
T	readValue(URL src, TypeReference valueTypeRef)
T	readValue(URL src, JavaType valueType)
T	readValue(String content, Class valueType)
T	readValue(String content, TypeReference valueTypeRef)
T	readValue(String content, JavaType valueType)
T	readValue(Reader src, Class valueType)
T	readValue(Reader src, TypeReference valueTypeRef)
T	readValue(Reader src, JavaType valueType)
T	readValue(InputStream src, Class valueType)
T	readValue(InputStream src, TypeReference valueTypeRef)
T	readValue(InputStream src, JavaType valueType)
T	readValue(byte[] src, Class valueType)
T	readValue(byte[] src, TypeReference valueTypeRef)
T	readValue(byte[] src, JavaType valueType)
MappingIterator	readValues(JsonParser jp, ResolvedType valueType) Method for reading sequence of Objects from parser stream.
MappingIterator	readValues(JsonParser jp, JavaType valueType) Type-safe overloaded method, basically alias for #readValues(JsonParser,ResolvedType) .
MappingIterator	readValues(JsonParser jp, Class valueType) Type-safe overloaded method, basically alias for #readValues(JsonParser,ResolvedType) .
MappingIterator	readValues(JsonParser jp, TypeReference valueTypeRef) Method for reading sequence of Objects from parser stream.
ObjectMapper	registerModule(Module module) Method for registering a module that can extend functionality provided by this mapper; for example, by adding providers for custom serializers and deserializers.
ObjectMapper	registerModules(Module... modules) Convenience method for registering specified modules in order; functionally equivalent to: for (Module module : modules) { registerModule(module); }
ObjectMapper	registerModules(Iterable modules) Convenience method for registering specified modules in order; functionally equivalent to: for (Module module : modules) { registerModule(module); }
void	registerSubtypes(Class... classes) Method for registering specified class as a subtype, so that typename-based resolution can link supertypes to subtypes (as an alternative to using annotations).
void	registerSubtypes(NamedType... types) Method for registering specified class as a subtype, so that typename-based resolution can link supertypes to subtypes (as an alternative to using annotations).
ObjectMapper	setAnnotationIntrospector(AnnotationIntrospector ai) Method for changing AnnotationIntrospector used by this mapper instance for both serialization and deserialization
ObjectMapper	setAnnotationIntrospectors(AnnotationIntrospector serializerAI, AnnotationIntrospector deserializerAI) Method for changing AnnotationIntrospector instances used by this mapper instance for serialization and deserialization, specifying them separately so that different introspection can be used for different aspects
ObjectMapper	setConfig(DeserializationConfig config) Method that allows overriding of the underlying DeserializationConfig object.
ObjectMapper	setConfig(SerializationConfig config) Method that allows overriding of the underlying SerializationConfig object, which contains serialization-specific configuration settings.
ObjectMapper	setDateFormat(DateFormat dateFormat) Method for configuring the default DateFormat to use when serializing time values as Strings, and deserializing from JSON Strings.
ObjectMapper	setDefaultTyping(TypeResolverBuilder typer) Method for enabling automatic inclusion of type information, using specified handler object for determining which types this affects, as well as details of how information is embedded.
void	setFilters(FilterProvider filterProvider) Convenience method that is equivalent to: mapper.setFilters(mapper.getSerializationConfig().withFilters(filterProvider)); Note that usually it is better to use method #writer(FilterProvider) ; however, sometimes this method is more convenient.
Object	setHandlerInstantiator(HandlerInstantiator hi) Method for configuring HandlerInstantiator to use for creating instances of handlers (such as serializers, deserializers, type and type id resolvers), given a class.
ObjectMapper	setInjectableValues(InjectableValues injectableValues) Method for configuring InjectableValues which used to find values to inject.
ObjectMapper	setLocale(Locale l) Method for overriding default locale to use for formatting.
ObjectMapper	setNodeFactory(JsonNodeFactory f) Method for specifying JsonNodeFactory to use for constructing root level tree nodes (via method #createObjectNode
ObjectMapper	setPropertyNamingStrategy(PropertyNamingStrategy s) Method for setting custom property naming strategy to use.
ObjectMapper	setSerializationInclusion(JsonInclude.Include incl) Method for setting defalt POJO property inclusion strategy for serialization.
ObjectMapper	setSerializerFactory(SerializerFactory f) Method for setting specific SerializerFactory to use for constructing (bean) serializers.
ObjectMapper	setSerializerProvider(DefaultSerializerProvider p) Method for setting specific SerializerProvider to use for handling caching of JsonSerializer instances.
ObjectMapper	setSubtypeResolver(SubtypeResolver str) Method for setting custom subtype resolver to use.
ObjectMapper	setTimeZone(TimeZone tz) Method for overriding default TimeZone to use for formatting.
ObjectMapper	setVisibility(PropertyAccessor forMethod, JsonAutoDetect.Visibility visibility) Convenience method that allows changing configuration for underlying VisibilityChecker s, to change details of what kinds of properties are auto-detected.
void	setVisibilityChecker(VisibilityChecker vc) Method for setting currently configured visibility checker; object used for determining whether given property element (method, field, constructor) can be auto-detected or not.
String	toString() Returns a string representation of the object.
JsonParser	treeAsTokens(TreeNode n) Method for constructing a JsonParser out of JSON tree representation.
T	treeToValue(TreeNode n, Class valueType) Convenience conversion method that will bind data given JSON tree contains into specific value (usually bean) type.
T	valueToTree(Object fromValue) Reverse of #treeToValue ; given a value (usually bean), will construct equivalent JSON Tree representation.
Version	version() Method that will return version information stored in and read from jar that contains this class.
ObjectWriter	writer() Convenience method for constructing ObjectWriter with default settings.
ObjectWriter	writer(SerializationFeature feature) Factory method for constructing ObjectWriter with specified feature enabled (compared to settings that this mapper instance has).
ObjectWriter	writer(DateFormat df) Factory method for constructing ObjectWriter that will serialize objects using specified DateFormat ; or, if null passed, using timestamp (64-bit number.
ObjectWriter	writer(PrettyPrinter pp) Factory method for constructing ObjectWriter that will serialize objects using specified pretty printer for indentation (or if null, no pretty printer)
ObjectWriter	writer(FilterProvider filterProvider) Factory method for constructing ObjectWriter that will serialize objects using specified filter provider.
ObjectWriter	writer(FormatSchema schema) Factory method for constructing ObjectWriter that will pass specific schema object to JsonGenerator used for writing content.
ObjectWriter	writer(Base64Variant defaultBase64) Factory method for constructing ObjectWriter that will use specified Base64 encoding variant for Base64-encoded binary data.
ObjectWriter	writer(CharacterEscapes escapes) Factory method for constructing ObjectReader that will use specified character escaping details for output.
ObjectWriter	writer(ContextAttributes attrs) Factory method for constructing ObjectWriter that will use specified default attributes.
ObjectWriter	writerWithDefaultPrettyPrinter() Factory method for constructing ObjectWriter that will serialize objects using the default pretty printer for indentation
ObjectWriter	writerWithType(Class rootType) Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value.
ObjectWriter	writerWithType(TypeReference rootType) Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value.
ObjectWriter	writerWithType(JavaType rootType) Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value.
ObjectWriter	writerWithView(Class serializationView) Factory method for constructing ObjectWriter that will serialize objects using specified JSON View (filter).
void	writeTree(JsonGenerator jgen, TreeNode rootNode)
void	writeTree(JsonGenerator jgen, JsonNode rootNode) Method to serialize given JSON Tree, using generator provided.
void	writeValue(JsonGenerator jgen, Object value) Method that can be used to serialize any Java value as JSON output, using provided JsonGenerator .
void	writeValue(File resultFile, Object value) Method that can be used to serialize any Java value as JSON output, written to File provided.
void	writeValue(OutputStream out, Object value) Method that can be used to serialize any Java value as JSON output, using output stream provided (using encoding JsonEncoding#UTF8 ).
void	writeValue(Writer w, Object value) Method that can be used to serialize any Java value as JSON output, using Writer provided.
byte[]	writeValueAsBytes(Object value) Method that can be used to serialize any Java value as a byte array.
String	writeValueAsString(Object value) Method that can be used to serialize any Java value as a String.