com.fasterxml.jackson.databind
Class ObjectMapper

java.lang.Object  extended by com.fasterxml.jackson.core.ObjectCodec      extended by com.fasterxml.jackson.databind.ObjectMapper
All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned

public class ObjectMapper
extends com.fasterxml.jackson.core.ObjectCodec
implements com.fasterxml.jackson.core.Versioned

This mapper (or, data binder, or codec) provides functionality for converting between Java objects (instances of JDK provided core classes, beans), and matching JSON constructs. It will use instances of JsonParser and JsonGenerator for implementing actual reading/writing of JSON.

The main conversion API is defined in ObjectCodec, so that implementation details of this class need not be exposed to streaming parser and generator classes.

Note on caching: root-level deserializers are always cached, and accessed using full (generics-aware) type information. This is different from caching of referenced types, which is more limited and is done only for a subset of all deserializer types. The main reason for difference is that at root-level there is no incoming reference (and hence no referencing property, no referral information or annotations to produce differing deserializers), and that the performance impact greatest at root level (since it'll essentially cache the full graph of deserializers involved).


Nested Class Summary
static classObjectMapper.DefaultTypeResolverBuilder
          Customized TypeResolverBuilder that provides type resolver builders used with so-called "default typing" (see enableDefaultTyping() for details).
static classObjectMapper.DefaultTyping
          Enumeration used with enableDefaultTyping() to specify what kind of types (classes) default typing should be used for.
 
Field Summary
protected  DeserializationConfig_deserializationConfig
          Configuration object that defines basic global settings for the serialization process
protected  DefaultDeserializationContext_deserializationContext
          Blueprint context object; stored here to allow custom sub-classes.
protected  InjectableValues_injectableValues
          Provider for values to inject in deserialized POJOs.
protected  com.fasterxml.jackson.core.JsonFactory_jsonFactory
          Factory used to create JsonParser and JsonGenerator instances as necessary.
protected  HashMap<ClassKey,Class<?>>_mixInAnnotations
          Mapping that defines how to apply mix-in annotations: key is the type to received additional annotations, and value is the type that has annotations to "mix in".
protected  ConcurrentHashMap<JavaType,JsonDeserializer<Object>>_rootDeserializers
          We will use a separate main-level Map for keeping track of root-level deserializers.
protected  RootNameLookup_rootNames
          Cache for root names used when root-wrapping is enabled.
protected  SerializationConfig_serializationConfig
          Configuration object that defines basic global settings for the serialization process
protected  SerializerFactory_serializerFactory
          Serializer factory used for constructing serializers.
protected  DefaultSerializerProvider_serializerProvider
          Object that manages access to serializers used for serialization, including caching.
protected  SubtypeResolver_subtypeResolver
          Thing used for registering sub-types, resolving them to super/sub-types as needed.
protected  TypeFactory_typeFactory
          Specific factory used for creating JavaType instances; needed to allow modules to add more custom type handling (mostly to support types of non-Java JVM languages)
protected static AnnotationIntrospectorDEFAULT_ANNOTATION_INTROSPECTOR
           
protected static BaseSettingsDEFAULT_BASE
          Base settings contain defaults used for all ObjectMapper instances.
protected static ClassIntrospectorDEFAULT_INTROSPECTOR
           
protected static VisibilityChecker<?>STD_VISIBILITY_CHECKER
           
 
Constructor Summary
ObjectMapper()
          Default constructor, which will construct the default JsonFactory as necessary, use SerializerProvider as its SerializerProvider, and BeanSerializerFactory as its SerializerFactory.
ObjectMapper(com.fasterxml.jackson.core.JsonFactory jf)
          Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators.
ObjectMapper(com.fasterxml.jackson.core.JsonFactory jf, DefaultSerializerProvider sp, DefaultDeserializationContext dc)
          Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators, and uses given providers for accessing serializers and deserializers.
 
Method Summary
protected  void_configAndWriteValue(com.fasterxml.jackson.core.JsonGenerator jgen, Object value)
          Method called to configure the generator as necessary and then call write functionality
protected  void_configAndWriteValue(com.fasterxml.jackson.core.JsonGenerator jgen, Object value, Class<?> viewClass)
           
protected  Object_convert(Object fromValue, JavaType toValueType)
          Actual conversion implementation: instead of using existing read and write methods, much of code is inlined.
protected  com.fasterxml.jackson.core.PrettyPrinter_defaultPrettyPrinter()
          Helper method that should return default pretty-printer to use for generators constructed by this mapper, when instructed to use default pretty printer.
protected  JsonDeserializer<Object>_findRootDeserializer(DeserializationContext ctxt, JavaType valueType)
          Method called to locate deserializer for the passed root-level value.
protected  com.fasterxml.jackson.core.JsonToken_initForReading(com.fasterxml.jackson.core.JsonParser jp)
          Method called to ensure that given parser is ready for reading content for data binding.
protected  Object_readMapAndClose(com.fasterxml.jackson.core.JsonParser jp, JavaType valueType)
           
protected  Object_readValue(DeserializationConfig cfg, com.fasterxml.jackson.core.JsonParser jp, JavaType valueType)
          Actual implementation of value reading+binding operation.
protected  DefaultSerializerProvider_serializerProvider(SerializationConfig config)
          Overridable helper method used for constructing SerializerProvider to use for serialization.
protected  Object_unwrapAndDeserialize(com.fasterxml.jackson.core.JsonParser jp, DeserializationContext ctxt, DeserializationConfig config, JavaType rootType, JsonDeserializer<Object> deser)
           
 ObjectMapperaddHandler(DeserializationProblemHandler h)
          Method for adding specified DeserializationProblemHandler to be used for handling specific problems during deserialization.
 voidaddMixInAnnotations(Class<?> target, Class<?> mixinSource)
          Method to use for adding mix-in annotations to use for augmenting specified class or interface.
 booleancanDeserialize(JavaType type)
          Method that can be called to check whether mapper thinks it could deserialize an Object of given type.
 booleancanSerialize(Class<?> type)
          Method that can be called to check whether mapper thinks it could serialize an instance of given Class.
 ObjectMapperclearProblemHandlers()
          Method for removing all registered DeserializationProblemHandlers instances from this mapper.
 ObjectMapperconfigure(DeserializationFeature f, boolean state)
          Method for changing state of an on/off deserialization feature for this object mapper.
 ObjectMapperconfigure(com.fasterxml.jackson.core.JsonGenerator.Feature f, boolean state)
          Method for changing state of an on/off JsonGenerator feature for JsonFactory instance this object mapper uses.
 ObjectMapperconfigure(com.fasterxml.jackson.core.JsonParser.Feature f, boolean state)
          Method for changing state of an on/off JsonParser feature for JsonFactory instance this object mapper uses.
 ObjectMapperconfigure(MapperFeature f, boolean state)
          Method for changing state of an on/off mapper feature for this mapper instance.
 ObjectMapperconfigure(SerializationFeature f, boolean state)
          Method for changing state of an on/off serialization feature for this object mapper.
 JavaTypeconstructType(Type t)
          Convenience method for constructing JavaType out of given type (typically java.lang.Class), but without explicit context.
<T> T
convertValue(Object fromValue, Class<T> toValueType)
          Convenience method for doing two-step conversion from given value, into instance of given value type.
<T> T
convertValue(Object fromValue, JavaType toValueType)
           
<T> T
convertValue(Object fromValue, com.fasterxml.jackson.core.type.TypeReference toValueTypeRef)
           
 ArrayNodecreateArrayNode()
           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)
protected  DefaultDeserializationContextcreateDeserializationContext(com.fasterxml.jackson.core.JsonParser jp, DeserializationConfig cfg)
          Internal helper method called to create an instance of DeserializationContext for deserializing a single root value.
 ObjectNodecreateObjectNode()
           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)
 ObjectMapperdisable(DeserializationFeature feature)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperdisable(DeserializationFeature first, DeserializationFeature... f)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperdisable(MapperFeature... f)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperdisable(SerializationFeature f)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperdisable(SerializationFeature first, SerializationFeature... f)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperdisableDefaultTyping()
          Method for disabling automatic inclusion of type information; if so, only explicitly annotated types (ones with JsonTypeInfo) will have additional embedded type information.
 ObjectMapperenable(DeserializationFeature feature)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperenable(DeserializationFeature first, DeserializationFeature... f)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperenable(MapperFeature... f)
          Method for enabling specified MapperConfig features.
 ObjectMapperenable(SerializationFeature f)
          Method for enabling specified DeserializationConfig feature.
 ObjectMapperenable(SerializationFeature first, SerializationFeature... f)
          Method for enabling specified DeserializationConfig features.
 ObjectMapperenableDefaultTyping()
          Convenience method that is equivalent to calling
 ObjectMapperenableDefaultTyping(ObjectMapper.DefaultTyping dti)
          Convenience method that is equivalent to calling
 ObjectMapperenableDefaultTyping(ObjectMapper.DefaultTyping applicability, com.fasterxml.jackson.annotation.JsonTypeInfo.As includeAs)
          Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated with JsonTypeInfo).
 ObjectMapperenableDefaultTypingAsProperty(ObjectMapper.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 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)
 Class<?>findMixInClassFor(Class<?> cls)
           
 JsonSchemagenerateJsonSchema(Class<?> t)
          Generate Json-schema instance for specified class.
 DeserializationConfiggetDeserializationConfig()
          Method that returns the shared default DeserializationConfig object that defines configuration settings for deserialization.
 com.fasterxml.jackson.core.JsonFactorygetJsonFactory()
          Method that can be used to get hold of JsonFactory that this mapper uses if it needs to construct JsonParsers and/or JsonGenerators.
 JsonNodeFactorygetNodeFactory()
          Method that can be used to get hold of JsonNodeFactory that this mapper will use when directly constructing root JsonNode instances for Trees.
 SerializationConfiggetSerializationConfig()
          Method that returns the shared default SerializationConfig object that defines configuration settings for serialization.
 SerializerProvidergetSerializerProvider()
           
 SubtypeResolvergetSubtypeResolver()
          Method for accessing subtype resolver in use.
 TypeFactorygetTypeFactory()
          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.
 booleanisEnabled(DeserializationFeature f)
          Method for checking whether given deserialization-specific feature is enabled.
 booleanisEnabled(com.fasterxml.jackson.core.JsonFactory.Feature f)
          Convenience method, equivalent to:
 booleanisEnabled(com.fasterxml.jackson.core.JsonGenerator.Feature f)
          Convenience method, equivalent to:
 booleanisEnabled(com.fasterxml.jackson.core.JsonParser.Feature f)
          Convenience method, equivalent to:
 booleanisEnabled(MapperFeature f)
          Method for checking whether given Mapper feature is enabled.
 booleanisEnabled(SerializationFeature f)
          Method for checking whether given serialization-specific feature is enabled.
 intmixInCount()
           
 ObjectReaderreader()
          Factory method for constructing ObjectReader with default settings.
 ObjectReaderreader(Class<?> type)
          Factory method for constructing ObjectReader that will read or update instances of specified type
 ObjectReaderreader(DeserializationFeature feature)
          Factory method for constructing ObjectReader with specified feature enabled (compared to settings that this mapper instance has).
 ObjectReaderreader(DeserializationFeature first, DeserializationFeature... other)
          Factory method for constructing ObjectReader with specified features enabled (compared to settings that this mapper instance has).
 ObjectReaderreader(com.fasterxml.jackson.core.FormatSchema schema)
          Factory method for constructing ObjectReader that will pass specific schema object to JsonParser used for reading content.
 ObjectReaderreader(InjectableValues injectableValues)
          Factory method for constructing ObjectReader that will use specified injectable values.
 ObjectReaderreader(JavaType type)
          Factory method for constructing ObjectReader that will read or update instances of specified type
 ObjectReaderreader(JsonNodeFactory f)
          Factory method for constructing ObjectReader that will use specified JsonNodeFactory for constructing JSON trees.
 ObjectReaderreader(com.fasterxml.jackson.core.type.TypeReference<?> type)
          Factory method for constructing ObjectReader that will read or update instances of specified type
 ObjectReaderreaderForUpdating(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.
 ObjectReaderreaderWithView(Class<?> view)
          Factory method for constructing ObjectReader that will deserialize objects using specified JSON View (filter).
 JsonNodereadTree(byte[] content)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
 JsonNodereadTree(File file)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
 JsonNodereadTree(InputStream in)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
<T extends com.fasterxml.jackson.core.TreeNode>
T
readTree(com.fasterxml.jackson.core.JsonParser jp)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
 JsonNodereadTree(Reader r)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
 JsonNodereadTree(String content)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
 JsonNodereadTree(URL source)
          Method to deserialize JSON content as tree expressed using set of JsonNode instances.
<T> T
readValue(byte[] src, Class<T> valueType)
           
<T> T
readValue(byte[] src, int offset, int len, Class<T> valueType)
           
<T> T
readValue(byte[] src, int offset, int len, JavaType valueType)
           
<T> T
readValue(byte[] src, int offset, int len, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> T
readValue(byte[] src, JavaType valueType)
           
<T> T
readValue(byte[] src, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> T
readValue(File src, Class<T> valueType)
           
<T> T
readValue(File src, JavaType valueType)
           
<T> T
readValue(File src, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> T
readValue(InputStream src, Class<T> valueType)
           
<T> T
readValue(InputStream src, JavaType valueType)
           
<T> T
readValue(InputStream src, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> T
readValue(com.fasterxml.jackson.core.JsonParser jp, Class<T> 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 Boolean).
<T> T
readValue(com.fasterxml.jackson.core.JsonParser jp, JavaType valueType)
          Type-safe overloaded method, basically alias for readValues(JsonParser, ResolvedType).
<T> T
readValue(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.core.type.ResolvedType valueType)
          Method to deserialize JSON content into a Java type, reference to which is passed as argument.
<T> T
readValue(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.core.type.TypeReference<?> valueTypeRef)
          Method to deserialize JSON content into a Java type, reference to which is passed as argument.
<T> T
readValue(Reader src, Class<T> valueType)
           
<T> T
readValue(Reader src, JavaType valueType)
           
<T> T
readValue(Reader src, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> T
readValue(String content, Class<T> valueType)
           
<T> T
readValue(String content, JavaType valueType)
           
<T> T
readValue(String content, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> T
readValue(URL src, Class<T> valueType)
           
<T> T
readValue(URL src, JavaType valueType)
           
<T> T
readValue(URL src, com.fasterxml.jackson.core.type.TypeReference valueTypeRef)
           
<T> MappingIterator<T>
readValues(com.fasterxml.jackson.core.JsonParser jp, Class<T> valueType)
          Method for reading sequence of Objects from parser stream.
<T> MappingIterator<T>
readValues(com.fasterxml.jackson.core.JsonParser jp, JavaType valueType)
          Type-safe overloaded method, basically alias for readValues(JsonParser, ResolvedType).
<T> MappingIterator<T>
readValues(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.core.type.ResolvedType valueType)
          Method for reading sequence of Objects from parser stream.
<T> MappingIterator<T>
readValues(com.fasterxml.jackson.core.JsonParser jp, com.fasterxml.jackson.core.type.TypeReference<?> valueTypeRef)
          Method for reading sequence of Objects from parser stream.
 ObjectMapperregisterModule(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.
 voidregisterSubtypes(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).
 voidregisterSubtypes(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).
 ObjectMappersetAnnotationIntrospector(AnnotationIntrospector ai)
          Method for changing AnnotationIntrospector used by this mapper instance for both serialization and deserialization
 ObjectMappersetDateFormat(DateFormat dateFormat)
          Method for configuring the default DateFormat to use when serializing time values as Strings, and deserializing from JSON Strings.
 ObjectMappersetDefaultTyping(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.
 voidsetFilters(FilterProvider filterProvider)
          Convenience method that is equivalent to:
 ObjectsetHandlerInstantiator(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.
 ObjectMappersetInjectableValues(InjectableValues injectableValues)
          Method for configuring InjectableValues which used to find values to inject.
 ObjectMappersetLocale(Locale l)
          Method for overriding default locale to use for formatting.
 voidsetMixInAnnotations(Map<Class<?>,Class<?>> sourceMixins)
          Method to use for defining mix-in annotations to use for augmenting annotations that processable (serializable / deserializable) classes have.
 ObjectMappersetNodeFactory(JsonNodeFactory f)
          Method for specifying JsonNodeFactory to use for constructing root level tree nodes (via method createObjectNode()
 ObjectMappersetPropertyNamingStrategy(PropertyNamingStrategy s)
          Method for setting custom property naming strategy to use.
 ObjectMappersetSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include incl)
          Method for setting defalt POJO property inclusion strategy for serialization.
 ObjectMappersetSerializerFactory(SerializerFactory f)
          Method for setting specific SerializerFactory to use for constructing (bean) serializers.
 ObjectMappersetSerializerProvider(DefaultSerializerProvider p)
          Method for setting specific SerializerProvider to use for handling caching of JsonSerializer instances.
 ObjectMappersetSubtypeResolver(SubtypeResolver str)
          Method for setting custom subtype resolver to use.
 ObjectMappersetTimeZone(TimeZone tz)
          Method for overriding default TimeZone to use for formatting.
 ObjectMappersetTypeFactory(TypeFactory f)
          Method that can be used to override TypeFactory instance used by this mapper.
 ObjectMappersetVisibility(com.fasterxml.jackson.annotation.PropertyAccessor forMethod, com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility visibility)
          Convenience method that allows changing configuration for underlying VisibilityCheckers, to change details of what kinds of properties are auto-detected.
 voidsetVisibilityChecker(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.
 com.fasterxml.jackson.core.JsonParsertreeAsTokens(com.fasterxml.jackson.core.TreeNode n)
          Method for constructing a JsonParser out of JSON tree representation.
<T> T
treeToValue(com.fasterxml.jackson.core.TreeNode n, Class<T> valueType)
          Convenience conversion method that will bind data given JSON tree contains into specific value (usually bean) type.
<T extends JsonNode>
T
valueToTree(Object fromValue)
          Reverse of treeToValue(com.fasterxml.jackson.core.TreeNode, java.lang.Class); given a value (usually bean), will construct equivalent JSON Tree representation.
 com.fasterxml.jackson.core.Versionversion()
          Method that will return version information stored in and read from jar that contains this class.
 ObjectWriterwriter()
          Convenience method for constructing ObjectWriter with default settings.
 ObjectWriterwriter(DateFormat df)
          Factory method for constructing ObjectWriter that will serialize objects using specified DateFormat; or, if null passed, using timestamp (64-bit number.
 ObjectWriterwriter(FilterProvider filterProvider)
          Factory method for constructing ObjectWriter that will serialize objects using specified filter provider.
 ObjectWriterwriter(com.fasterxml.jackson.core.FormatSchema schema)
          Factory method for constructing ObjectWriter that will pass specific schema object to JsonGenerator used for writing content.
 ObjectWriterwriter(com.fasterxml.jackson.core.PrettyPrinter pp)
          Factory method for constructing ObjectWriter that will serialize objects using specified pretty printer for indentation (or if null, no pretty printer)
 ObjectWriterwriter(SerializationFeature feature)
          Factory method for constructing ObjectWriter with specified feature enabled (compared to settings that this mapper instance has).
 ObjectWriterwriter(SerializationFeature first, SerializationFeature... other)
          Factory method for constructing ObjectWriter with specified features enabled (compared to settings that this mapper instance has).
 ObjectWriterwriterWithDefaultPrettyPrinter()
          Factory method for constructing ObjectWriter that will serialize objects using the default pretty printer for indentation
 ObjectWriterwriterWithType(Class<?> rootType)
          Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value.
 ObjectWriterwriterWithType(JavaType rootType)
          Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value.
 ObjectWriterwriterWithType(com.fasterxml.jackson.core.type.TypeReference<?> rootType)
          Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value.
 ObjectWriterwriterWithView(Class<?> serializationView)
          Factory method for constructing ObjectWriter that will serialize objects using specified JSON View (filter).
 voidwriteTree(com.fasterxml.jackson.core.JsonGenerator jgen, JsonNode rootNode)
          Method to serialize given JSON Tree, using generator provided.
 voidwriteValue(File resultFile, Object value)
          Method that can be used to serialize any Java value as JSON output, written to File provided.
 voidwriteValue(com.fasterxml.jackson.core.JsonGenerator jgen, Object value)
          Method that can be used to serialize any Java value as JSON output, using provided JsonGenerator.
 voidwriteValue(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).
 voidwriteValue(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.
 StringwriteValueAsString(Object value)
          Method that can be used to serialize any Java value as a String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_INTROSPECTOR

protected static final ClassIntrospector DEFAULT_INTROSPECTOR

DEFAULT_ANNOTATION_INTROSPECTOR

protected static final AnnotationIntrospector DEFAULT_ANNOTATION_INTROSPECTOR

STD_VISIBILITY_CHECKER

protected static final VisibilityChecker<?> STD_VISIBILITY_CHECKER

DEFAULT_BASE

protected static final BaseSettings DEFAULT_BASE
Base settings contain defaults used for all ObjectMapper instances.


_jsonFactory

protected final com.fasterxml.jackson.core.JsonFactory _jsonFactory
Factory used to create JsonParser and JsonGenerator instances as necessary.


_typeFactory

protected TypeFactory _typeFactory
Specific factory used for creating JavaType instances; needed to allow modules to add more custom type handling (mostly to support types of non-Java JVM languages)


_injectableValues

protected InjectableValues _injectableValues
Provider for values to inject in deserialized POJOs.


_subtypeResolver

protected SubtypeResolver _subtypeResolver
Thing used for registering sub-types, resolving them to super/sub-types as needed.


_rootNames

protected final RootNameLookup _rootNames
Cache for root names used when root-wrapping is enabled.


_mixInAnnotations

protected final HashMap<ClassKey,Class<?>> _mixInAnnotations
Mapping that defines how to apply mix-in annotations: key is the type to received additional annotations, and value is the type that has annotations to "mix in".

Annotations associated with the value classes will be used to override annotations of the key class, associated with the same field or method. They can be further masked by sub-classes: you can think of it as injecting annotations between the target class and its sub-classes (or interfaces)


_serializationConfig

protected SerializationConfig _serializationConfig
Configuration object that defines basic global settings for the serialization process


_serializerProvider

protected DefaultSerializerProvider _serializerProvider
Object that manages access to serializers used for serialization, including caching. It is configured with _serializerFactory to allow for constructing custom serializers.

Note: while serializers are only exposed SerializerProvider, mappers and readers need to access additional API defined by DefaultSerializerProvider


_serializerFactory

protected SerializerFactory _serializerFactory
Serializer factory used for constructing serializers.


_deserializationConfig

protected DeserializationConfig _deserializationConfig
Configuration object that defines basic global settings for the serialization process


_deserializationContext

protected DefaultDeserializationContext _deserializationContext
Blueprint context object; stored here to allow custom sub-classes. Contains references to objects needed for deserialization construction (cache, factory).


_rootDeserializers

protected final ConcurrentHashMap<JavaType,JsonDeserializer<Object>> _rootDeserializers
We will use a separate main-level Map for keeping track of root-level deserializers. This is where most succesful cache lookups get resolved. Map will contain resolvers for all kinds of types, including container types: this is different from the component cache which will only cache bean deserializers.

Given that we don't expect much concurrency for additions (should very quickly converge to zero after startup), let's explicitly define a low concurrency setting.

Since version 1.5, these may are either "raw" deserializers (when no type information is needed for base type), or type-wrapped deserializers (if it is needed)

Constructor Detail

ObjectMapper

public ObjectMapper()
Default constructor, which will construct the default JsonFactory as necessary, use SerializerProvider as its SerializerProvider, and BeanSerializerFactory as its SerializerFactory. This means that it can serialize all standard JDK types, as well as regular Java Beans (based on method names and Jackson-specific annotations), but does not support JAXB annotations.


ObjectMapper

public ObjectMapper(com.fasterxml.jackson.core.JsonFactory jf)
Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators.


ObjectMapper

public ObjectMapper(com.fasterxml.jackson.core.JsonFactory jf,                    DefaultSerializerProvider sp,                    DefaultDeserializationContext dc)
Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators, and uses given providers for accessing serializers and deserializers.

Parameters:
jf - JsonFactory to use: if null, a new MappingJsonFactory will be constructed
sp - SerializerProvider to use: if null, a SerializerProvider will be constructed
dc - Blueprint deserialization context instance to use for creating actual context objects; if null, will construct standard DeserializationContext

Method Detail

version

public com.fasterxml.jackson.core.Version version()
Method that will return version information stored in and read from jar that contains this class.

Specified by:
version in interface com.fasterxml.jackson.core.Versioned

registerModule

public 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.

Parameters:
module - Module to register

getSerializationConfig

public SerializationConfig getSerializationConfig()
Method that returns the shared default SerializationConfig object that defines configuration settings for serialization. Returned object is "live" meaning that changes will be used for future serialization operations for this mapper when using mapper's default configuration


getDeserializationConfig

public DeserializationConfig getDeserializationConfig()
Method that returns the shared default DeserializationConfig object that defines configuration settings for deserialization. Returned object is "live" meaning that changes will be used for future deserialization operations for this mapper when using mapper's default configuration


setSerializerFactory

public ObjectMapper setSerializerFactory(SerializerFactory f)
Method for setting specific SerializerFactory to use for constructing (bean) serializers.


setSerializerProvider

public ObjectMapper setSerializerProvider(DefaultSerializerProvider p)
Method for setting specific SerializerProvider to use for handling caching of JsonSerializer instances.


getSerializerProvider

public SerializerProvider getSerializerProvider()

setMixInAnnotations

public final void setMixInAnnotations(Map<Class<?>,Class<?>> sourceMixins)
Method to use for defining mix-in annotations to use for augmenting annotations that processable (serializable / deserializable) classes have. Mixing in is done when introspecting class annotations and properties. Map passed contains keys that are target classes (ones to augment with new annotation overrides), and values that are source classes (have annotations to use for augmentation). Annotations from source classes (and their supertypes) will override annotations that target classes (and their super-types) have.


addMixInAnnotations

public final void addMixInAnnotations(Class<?> target,                                      Class<?> mixinSource)
Method to use for adding mix-in annotations to use for augmenting specified class or interface. All annotations from mixinSource are taken to override annotations that target (or its supertypes) has.

Parameters:
target - Class (or interface) whose annotations to effectively override
mixinSource - Class (or interface) whose annotations are to be "added" to target's annotations, overriding as necessary

findMixInClassFor

public final Class<?> findMixInClassFor(Class<?> cls)

mixInCount

public final int mixInCount()

getVisibilityChecker

public 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.


setVisibilityChecker

public 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. This default checker is used if no per-class overrides are defined.


setVisibility

public ObjectMapper setVisibility(com.fasterxml.jackson.annotation.PropertyAccessor forMethod,                                  com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility visibility)
Convenience method that allows changing configuration for underlying VisibilityCheckers, to change details of what kinds of properties are auto-detected. Basically short cut for doing:
  mapper.setVisibilityChecker(     mapper.getVisibilityChecker().withVisibility(forMethod, visibility)  );
one common use case would be to do:
  mapper.setVisibility(JsonMethod.FIELD, Visibility.ANY);
which would make all member fields serializable without further annotations, instead of just public fields (default setting).

Parameters:
forMethod - Type of property descriptor affected (field, getter/isGetter, setter, creator)
visibility - Minimum visibility to require for the property descriptors of type
Returns:
Modified mapper instance (that is, "this"), to allow chaining of configuration calls

getSubtypeResolver

public SubtypeResolver getSubtypeResolver()
Method for accessing subtype resolver in use.


setSubtypeResolver

public ObjectMapper setSubtypeResolver(SubtypeResolver str)
Method for setting custom subtype resolver to use.


setAnnotationIntrospector

public ObjectMapper setAnnotationIntrospector(AnnotationIntrospector ai)
Method for changing AnnotationIntrospector used by this mapper instance for both serialization and deserialization


setPropertyNamingStrategy

public ObjectMapper setPropertyNamingStrategy(PropertyNamingStrategy s)
Method for setting custom property naming strategy to use.


setSerializationInclusion

public ObjectMapper setSerializationInclusion(com.fasterxml.jackson.annotation.JsonInclude.Include incl)
Method for setting defalt POJO property inclusion strategy for serialization. Equivalent to:
  mapper.setSerializationConfig(mapper.getSerializationConfig().withSerializationInclusion(incl));


enableDefaultTyping

public ObjectMapper enableDefaultTyping()
Convenience method that is equivalent to calling
  enableObjectTyping(DefaultTyping.OBJECT_AND_NON_CONCRETE);


enableDefaultTyping

public ObjectMapper enableDefaultTyping(ObjectMapper.DefaultTyping dti)
Convenience method that is equivalent to calling
  enableObjectTyping(dti, JsonTypeInfo.As.WRAPPER_ARRAY);


enableDefaultTyping

public ObjectMapper enableDefaultTyping(ObjectMapper.DefaultTyping applicability,                                        com.fasterxml.jackson.annotation.JsonTypeInfo.As includeAs)
Method for enabling automatic inclusion of type information, needed for proper deserialization of polymorphic types (unless types have been annotated with JsonTypeInfo).

Parameters:
applicability - Defines kinds of types for which additional type information is added; see ObjectMapper.DefaultTyping for more information.

enableDefaultTypingAsProperty

public ObjectMapper enableDefaultTypingAsProperty(ObjectMapper.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 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)


disableDefaultTyping

public ObjectMapper disableDefaultTyping()
Method for disabling automatic inclusion of type information; if so, only explicitly annotated types (ones with JsonTypeInfo) will have additional embedded type information.


setDefaultTyping

public 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.

Parameters:
typer - Type information inclusion handler

registerSubtypes

public 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). Type for given class is determined from appropriate annotation; or if missing, default name (unqualified class name)


registerSubtypes

public 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). Name may be provided as part of argument, but if not will be based on annotations or use default name (unqualified class name).


getTypeFactory

public TypeFactory getTypeFactory()
Accessor for getting currently configured TypeFactory instance.


setTypeFactory

public ObjectMapper setTypeFactory(TypeFactory f)
Method that can be used to override TypeFactory instance used by this mapper.

Note: will also set TypeFactory that deserialization and serialization config objects use.


constructType

public JavaType constructType(Type t)
Convenience method for constructing JavaType out of given type (typically java.lang.Class), but without explicit context.


setNodeFactory

public ObjectMapper setNodeFactory(JsonNodeFactory f)
Method for specifying JsonNodeFactory to use for constructing root level tree nodes (via method createObjectNode()


addHandler

public ObjectMapper addHandler(DeserializationProblemHandler h)
Method for adding specified DeserializationProblemHandler to be used for handling specific problems during deserialization.


clearProblemHandlers

public ObjectMapper clearProblemHandlers()
Method for removing all registered DeserializationProblemHandlers instances from this mapper.


setFilters

public 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. For example, some frameworks only allow configuring of ObjectMapper instances and not ObjectWriters.


getJsonFactory

public com.fasterxml.jackson.core.JsonFactory getJsonFactory()
Method that can be used to get hold of JsonFactory that this mapper uses if it needs to construct JsonParsers and/or JsonGenerators.

Specified by:
getJsonFactory in class com.fasterxml.jackson.core.ObjectCodec
Returns:
JsonFactory that this mapper uses when it needs to construct Json parser and generators

setDateFormat

public ObjectMapper setDateFormat(DateFormat dateFormat)
Method for configuring the default DateFormat to use when serializing time values as Strings, and deserializing from JSON Strings. This is preferably to directly modifying SerializationConfig and DeserializationConfig instances. If you need per-request configuration, use writer(DateFormat) to create properly configured ObjectWriter and use that; this because ObjectWriters are thread-safe whereas ObjectMapper itself is only thread-safe when configuring methods (such as this one) are NOT called.


setHandlerInstantiator

public 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.

Parameters:
hi - Instantiator to use; if null, use the default implementation

setInjectableValues

public ObjectMapper setInjectableValues(InjectableValues injectableValues)
Method for configuring InjectableValues which used to find values to inject.


setLocale

public ObjectMapper setLocale(Locale l)
Method for overriding default locale to use for formatting. Default value used is Locale.getDefault().


setTimeZone

public ObjectMapper setTimeZone(TimeZone tz)
Method for overriding default TimeZone to use for formatting. Default value used is TimeZone.getDefault().


configure

public ObjectMapper configure(MapperFeature f,                              boolean state)
Method for changing state of an on/off mapper feature for this mapper instance.


configure

public ObjectMapper configure(SerializationFeature f,                              boolean state)
Method for changing state of an on/off serialization feature for this object mapper.


configure

public ObjectMapper configure(DeserializationFeature f,                              boolean state)
Method for changing state of an on/off deserialization feature for this object mapper.


configure

public ObjectMapper configure(com.fasterxml.jackson.core.JsonParser.Feature f,                              boolean state)
Method for changing state of an on/off JsonParser feature for JsonFactory instance this object mapper uses.

This is method is basically a shortcut method for calling JsonFactory.enable(com.fasterxml.jackson.core.JsonFactory.Feature) on the shared JsonFactory this mapper uses (which is accessible using getJsonFactory()).


configure

public ObjectMapper configure(com.fasterxml.jackson.core.JsonGenerator.Feature f,                              boolean state)
Method for changing state of an on/off JsonGenerator feature for JsonFactory instance this object mapper uses.

This is method is basically a shortcut method for calling JsonFactory.enable(com.fasterxml.jackson.core.JsonFactory.Feature) on the shared JsonFactory this mapper uses (which is accessible using getJsonFactory()).


enable

public ObjectMapper enable(MapperFeature... f)
Method for enabling specified MapperConfig features. Modifies and returns this instance; no new object is created.


disable

public ObjectMapper disable(MapperFeature... f)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


enable

public ObjectMapper enable(DeserializationFeature feature)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


enable

public ObjectMapper enable(DeserializationFeature first,                           DeserializationFeature... f)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


disable

public ObjectMapper disable(DeserializationFeature feature)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


disable

public ObjectMapper disable(DeserializationFeature first,                            DeserializationFeature... f)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


enable

public ObjectMapper enable(SerializationFeature f)
Method for enabling specified DeserializationConfig feature. Modifies and returns this instance; no new object is created.


enable

public ObjectMapper enable(SerializationFeature first,                           SerializationFeature... f)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


disable

public ObjectMapper disable(SerializationFeature f)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


disable

public ObjectMapper disable(SerializationFeature first,                            SerializationFeature... f)
Method for enabling specified DeserializationConfig features. Modifies and returns this instance; no new object is created.


isEnabled

public boolean isEnabled(MapperFeature f)
Method for checking whether given Mapper feature is enabled.


isEnabled

public boolean isEnabled(SerializationFeature f)
Method for checking whether given serialization-specific feature is enabled.


isEnabled

public boolean isEnabled(DeserializationFeature f)
Method for checking whether given deserialization-specific feature is enabled.


isEnabled

public boolean isEnabled(com.fasterxml.jackson.core.JsonFactory.Feature f)
Convenience method, equivalent to:
  getJsonFactory().isEnabled(f);


isEnabled

public boolean isEnabled(com.fasterxml.jackson.core.JsonParser.Feature f)
Convenience method, equivalent to:
  getJsonFactory().isEnabled(f);


isEnabled

public boolean isEnabled(com.fasterxml.jackson.core.JsonGenerator.Feature f)
Convenience method, equivalent to:
  getJsonFactory().isEnabled(f);


getNodeFactory

public 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.

Note: this is just a shortcut for calling

   getDeserializationConfig().getNodeFactory()


readValue

public <T> T readValue(com.fasterxml.jackson.core.JsonParser jp,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
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 Boolean).

Note: this method should NOT be used if the result type is a container (Collection or Map. The reason is that due to type erasure, key and value types can not be introspected when using this method.

Specified by:
readValue in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(com.fasterxml.jackson.core.JsonParser jp,                       com.fasterxml.jackson.core.type.TypeReference<?> valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Method to deserialize JSON content into a Java type, reference to which is passed as argument. Type is passed using so-called "super type token" (see ) and specifically needs to be used if the root type is a parameterized (generic) container type.

Specified by:
readValue in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public final <T> T readValue(com.fasterxml.jackson.core.JsonParser jp,                             com.fasterxml.jackson.core.type.ResolvedType valueType)                  throws IOException,                         com.fasterxml.jackson.core.JsonParseException,                         JsonMappingException
Method to deserialize JSON content into a Java type, reference to which is passed as argument. Type is passed using Jackson specific type; instance of which can be constructed using TypeFactory.

Specified by:
readValue in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(com.fasterxml.jackson.core.JsonParser jp,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Type-safe overloaded method, basically alias for readValues(JsonParser, ResolvedType).

Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readTree

public <T extends com.fasterxml.jackson.core.TreeNode> T readTree(com.fasterxml.jackson.core.JsonParser jp)                                                       throws IOException,                                                              com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Specified by:
readTree in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readValues

public <T> MappingIterator<T> readValues(com.fasterxml.jackson.core.JsonParser jp,                                         com.fasterxml.jackson.core.type.ResolvedType valueType)                              throws IOException,                                     com.fasterxml.jackson.core.JsonProcessingException
Method for reading sequence of Objects from parser stream.

Note that ObjectReader has more complete set of variants.

Specified by:
readValues in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readValues

public <T> MappingIterator<T> readValues(com.fasterxml.jackson.core.JsonParser jp,                                         JavaType valueType)                              throws IOException,                                     com.fasterxml.jackson.core.JsonProcessingException
Type-safe overloaded method, basically alias for readValues(JsonParser, ResolvedType).

Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readValues

public <T> MappingIterator<T> readValues(com.fasterxml.jackson.core.JsonParser jp,                                         Class<T> valueType)                              throws IOException,                                     com.fasterxml.jackson.core.JsonProcessingException
Method for reading sequence of Objects from parser stream.

Specified by:
readValues in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readValues

public <T> MappingIterator<T> readValues(com.fasterxml.jackson.core.JsonParser jp,                                         com.fasterxml.jackson.core.type.TypeReference<?> valueTypeRef)                              throws IOException,                                     com.fasterxml.jackson.core.JsonProcessingException
Method for reading sequence of Objects from parser stream.

Specified by:
readValues in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readTree

public JsonNode readTree(InputStream in)                  throws IOException,                         com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Parameters:
in - Input stream used to read JSON content for building the JSON tree.
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readTree

public JsonNode readTree(Reader r)                  throws IOException,                         com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Parameters:
r - Reader used to read JSON content for building the JSON tree.
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readTree

public JsonNode readTree(String content)                  throws IOException,                         com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Parameters:
content - JSON content to parse to build the JSON tree.
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readTree

public JsonNode readTree(byte[] content)                  throws IOException,                         com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Parameters:
content - JSON content to parse to build the JSON tree.
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readTree

public JsonNode readTree(File file)                  throws IOException,                         com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Parameters:
file - File of which contents to parse as JSON for building a tree instance
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

readTree

public JsonNode readTree(URL source)                  throws IOException,                         com.fasterxml.jackson.core.JsonProcessingException
Method to deserialize JSON content as tree expressed using set of JsonNode instances. Returns root of the resulting tree (where root can consist of just a single node if the current event is a value event, not container).

Parameters:
source - URL to use for fetching contents to parse as JSON for building a tree instance
Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

writeValue

public void writeValue(com.fasterxml.jackson.core.JsonGenerator jgen,                       Object value)                throws IOException,                       com.fasterxml.jackson.core.JsonGenerationException,                       JsonMappingException
Method that can be used to serialize any Java value as JSON output, using provided JsonGenerator.

Specified by:
writeValue in class com.fasterxml.jackson.core.ObjectCodec
Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

writeTree

public void writeTree(com.fasterxml.jackson.core.JsonGenerator jgen,                      JsonNode rootNode)               throws IOException,                      com.fasterxml.jackson.core.JsonProcessingException
Method to serialize given JSON Tree, using generator provided.

Throws:
IOException
com.fasterxml.jackson.core.JsonProcessingException

createObjectNode

public 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)

Specified by:
createObjectNode in class com.fasterxml.jackson.core.ObjectCodec

createArrayNode

public 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)

Specified by:
createArrayNode in class com.fasterxml.jackson.core.ObjectCodec

treeAsTokens

public com.fasterxml.jackson.core.JsonParser treeAsTokens(com.fasterxml.jackson.core.TreeNode n)
Method for constructing a JsonParser out of JSON tree representation.

Specified by:
treeAsTokens in class com.fasterxml.jackson.core.ObjectCodec
Parameters:
n - Root node of the tree that resulting parser will read from

treeToValue

public <T> T treeToValue(com.fasterxml.jackson.core.TreeNode n,                         Class<T> valueType)              throws com.fasterxml.jackson.core.JsonProcessingException
Convenience conversion method that will bind data given JSON tree contains into specific value (usually bean) type.

Equivalent to:

   objectMapper.convertValue(n, valueClass);

Specified by:
treeToValue in class com.fasterxml.jackson.core.ObjectCodec
Throws:
com.fasterxml.jackson.core.JsonProcessingException

valueToTree

public <T extends JsonNode> T valueToTree(Object fromValue)                               throws IllegalArgumentException
Reverse of treeToValue(com.fasterxml.jackson.core.TreeNode, java.lang.Class); given a value (usually bean), will construct equivalent JSON Tree representation. Functionally same as if serializing value into JSON and parsing JSON as tree, but more efficient.

Type Parameters:
T - Actual node type; usually either basic JsonNode or ObjectNode
Parameters:
fromValue - Bean value to convert
Returns:
Root node of the resulting JSON tree
Throws:
IllegalArgumentException

canSerialize

public boolean canSerialize(Class<?> type)
Method that can be called to check whether mapper thinks it could serialize an instance of given Class. Check is done by checking whether a serializer can be found for the type.

Returns:
True if mapper can find a serializer for instances of given class (potentially serializable), false otherwise (not serializable)

canDeserialize

public boolean canDeserialize(JavaType type)
Method that can be called to check whether mapper thinks it could deserialize an Object of given type. Check is done by checking whether a deserializer can be found for the type.

Returns:
True if mapper can find a serializer for instances of given class (potentially serializable), false otherwise (not serializable)

readValue

public <T> T readValue(File src,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(File src,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(File src,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(URL src,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(URL src,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(URL src,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(String content,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(String content,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(String content,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(Reader src,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(Reader src,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(Reader src,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(InputStream src,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(InputStream src,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(InputStream src,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(byte[] src,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(byte[] src,                       int offset,                       int len,                       Class<T> valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(byte[] src,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(byte[] src,                       int offset,                       int len,                       com.fasterxml.jackson.core.type.TypeReference valueTypeRef)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(byte[] src,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

readValue

public <T> T readValue(byte[] src,                       int offset,                       int len,                       JavaType valueType)            throws IOException,                   com.fasterxml.jackson.core.JsonParseException,                   JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

writeValue

public void writeValue(File resultFile,                       Object value)                throws IOException,                       com.fasterxml.jackson.core.JsonGenerationException,                       JsonMappingException
Method that can be used to serialize any Java value as JSON output, written to File provided.

Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

writeValue

public void writeValue(OutputStream out,                       Object value)                throws IOException,                       com.fasterxml.jackson.core.JsonGenerationException,                       JsonMappingException
Method that can be used to serialize any Java value as JSON output, using output stream provided (using encoding JsonEncoding.UTF8).

Note: method does not close the underlying stream explicitly here; however, JsonFactory this mapper uses may choose to close the stream depending on its settings (by default, it will try to close it when JsonGenerator we construct is closed).

Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

writeValue

public void writeValue(Writer w,                       Object value)                throws IOException,                       com.fasterxml.jackson.core.JsonGenerationException,                       JsonMappingException
Method that can be used to serialize any Java value as JSON output, using Writer provided.

Note: method does not close the underlying stream explicitly here; however, JsonFactory this mapper uses may choose to close the stream depending on its settings (by default, it will try to close it when JsonGenerator we construct is closed).

Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

writeValueAsString

public String writeValueAsString(Object value)                          throws IOException,                                 com.fasterxml.jackson.core.JsonGenerationException,                                 JsonMappingException
Method that can be used to serialize any Java value as a String. Functionally equivalent to calling writeValue(Writer,Object) with StringWriter and constructing String, but more efficient.

Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

writeValueAsBytes

public byte[] writeValueAsBytes(Object value)                         throws IOException,                                com.fasterxml.jackson.core.JsonGenerationException,                                JsonMappingException
Method that can be used to serialize any Java value as a byte array. Functionally equivalent to calling writeValue(Writer,Object) with ByteArrayOutputStream and getting bytes, but more efficient. Encoding used will be UTF-8.

Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

writer

public ObjectWriter writer()
Convenience method for constructing ObjectWriter with default settings.


writer

public ObjectWriter writer(SerializationFeature feature)
Factory method for constructing ObjectWriter with specified feature enabled (compared to settings that this mapper instance has).


writer

public ObjectWriter writer(SerializationFeature first,                           SerializationFeature... other)
Factory method for constructing ObjectWriter with specified features enabled (compared to settings that this mapper instance has).


writer

public 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.


writerWithView

public ObjectWriter writerWithView(Class<?> serializationView)
Factory method for constructing ObjectWriter that will serialize objects using specified JSON View (filter).


writerWithType

public ObjectWriter writerWithType(Class<?> rootType)
Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value. Type must be a super-type of runtime type.


writerWithType

public ObjectWriter writerWithType(JavaType rootType)
Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value. Type must be a super-type of runtime type.


writerWithType

public ObjectWriter writerWithType(com.fasterxml.jackson.core.type.TypeReference<?> rootType)
Factory method for constructing ObjectWriter that will serialize objects using specified root type, instead of actual runtime type of value. Type must be a super-type of runtime type.


writer

public ObjectWriter writer(com.fasterxml.jackson.core.PrettyPrinter pp)
Factory method for constructing ObjectWriter that will serialize objects using specified pretty printer for indentation (or if null, no pretty printer)


writerWithDefaultPrettyPrinter

public ObjectWriter writerWithDefaultPrettyPrinter()
Factory method for constructing ObjectWriter that will serialize objects using the default pretty printer for indentation


writer

public ObjectWriter writer(FilterProvider filterProvider)
Factory method for constructing ObjectWriter that will serialize objects using specified filter provider.


writer

public ObjectWriter writer(com.fasterxml.jackson.core.FormatSchema schema)
Factory method for constructing ObjectWriter that will pass specific schema object to JsonGenerator used for writing content.

Parameters:
schema - Schema to pass to generator

reader

public ObjectReader reader()
Factory method for constructing ObjectReader with default settings. Note that the resulting instance is NOT usable as is, without defining expected value type.


reader

public ObjectReader reader(DeserializationFeature feature)
Factory method for constructing ObjectReader with specified feature enabled (compared to settings that this mapper instance has). Note that the resulting instance is NOT usable as is, without defining expected value type.


reader

public ObjectReader reader(DeserializationFeature first,                           DeserializationFeature... other)
Factory method for constructing ObjectReader with specified features enabled (compared to settings that this mapper instance has). Note that the resulting instance is NOT usable as is, without defining expected value type.


readerForUpdating

public 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. Deserialization occurs normally except that the root-level value in JSON is not used for instantiating a new object; instead give updateable object is used as root. Runtime type of value object is used for locating deserializer, unless overridden by other factory methods of ObjectReader


reader

public ObjectReader reader(JavaType type)
Factory method for constructing ObjectReader that will read or update instances of specified type


reader

public ObjectReader reader(Class<?> type)
Factory method for constructing ObjectReader that will read or update instances of specified type


reader

public ObjectReader reader(com.fasterxml.jackson.core.type.TypeReference<?> type)
Factory method for constructing ObjectReader that will read or update instances of specified type


reader

public ObjectReader reader(JsonNodeFactory f)
Factory method for constructing ObjectReader that will use specified JsonNodeFactory for constructing JSON trees.


reader

public ObjectReader reader(com.fasterxml.jackson.core.FormatSchema schema)
Factory method for constructing ObjectReader that will pass specific schema object to JsonParser used for reading content.

Parameters:
schema - Schema to pass to parser

reader

public ObjectReader reader(InjectableValues injectableValues)
Factory method for constructing ObjectReader that will use specified injectable values.

Parameters:
injectableValues - Injectable values to use

readerWithView

public ObjectReader readerWithView(Class<?> view)
Factory method for constructing ObjectReader that will deserialize objects using specified JSON View (filter).


convertValue

public <T> T convertValue(Object fromValue,                          Class<T> toValueType)               throws IllegalArgumentException
Convenience method for doing two-step conversion from given value, into instance of given value type. This is functionality equivalent to first serializing given value into JSON, then binding JSON data into value of given type, but may be executed without fully serializing into JSON. Same converters (serializers, deserializers) will be used as for data binding, meaning same object mapper configuration works.

Throws:
IllegalArgumentException - If conversion fails due to incompatible type; if so, root cause will contain underlying checked exception data binding functionality threw

convertValue

public <T> T convertValue(Object fromValue,                          com.fasterxml.jackson.core.type.TypeReference toValueTypeRef)               throws IllegalArgumentException
Throws:
IllegalArgumentException

convertValue

public <T> T convertValue(Object fromValue,                          JavaType toValueType)               throws IllegalArgumentException
Throws:
IllegalArgumentException

_convert

protected Object _convert(Object fromValue,                          JavaType toValueType)                   throws IllegalArgumentException
Actual conversion implementation: instead of using existing read and write methods, much of code is inlined. Reason for this is that we must avoid wrapping/unwrapping both for efficiency and for correctness. If wrapping/unwrapping is actually desired, caller must use explicit writeValue and readValue methods.

Throws:
IllegalArgumentException

generateJsonSchema

public JsonSchema generateJsonSchema(Class<?> t)                              throws JsonMappingException
Generate Json-schema instance for specified class.

Parameters:
t - The class to generate schema for
Returns:
Constructed JSON schema.
Throws:
JsonMappingException

_serializerProvider

protected DefaultSerializerProvider _serializerProvider(SerializationConfig config)
Overridable helper method used for constructing SerializerProvider to use for serialization.


_defaultPrettyPrinter

protected com.fasterxml.jackson.core.PrettyPrinter _defaultPrettyPrinter()
Helper method that should return default pretty-printer to use for generators constructed by this mapper, when instructed to use default pretty printer.


_configAndWriteValue

protected final void _configAndWriteValue(com.fasterxml.jackson.core.JsonGenerator jgen,                                          Object value)                                   throws IOException,                                          com.fasterxml.jackson.core.JsonGenerationException,                                          JsonMappingException
Method called to configure the generator as necessary and then call write functionality

Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

_configAndWriteValue

protected final void _configAndWriteValue(com.fasterxml.jackson.core.JsonGenerator jgen,                                          Object value,                                          Class<?> viewClass)                                   throws IOException,                                          com.fasterxml.jackson.core.JsonGenerationException,                                          JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonGenerationException
JsonMappingException

createDeserializationContext

protected final DefaultDeserializationContext createDeserializationContext(com.fasterxml.jackson.core.JsonParser jp,                                                                           DeserializationConfig cfg)
Internal helper method called to create an instance of DeserializationContext for deserializing a single root value. Can be overridden if a custom context is needed.


_readValue

protected Object _readValue(DeserializationConfig cfg,                            com.fasterxml.jackson.core.JsonParser jp,                            JavaType valueType)                     throws IOException,                            com.fasterxml.jackson.core.JsonParseException,                            JsonMappingException
Actual implementation of value reading+binding operation.

Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

_readMapAndClose

protected Object _readMapAndClose(com.fasterxml.jackson.core.JsonParser jp,                                  JavaType valueType)                           throws IOException,                                  com.fasterxml.jackson.core.JsonParseException,                                  JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

_initForReading

protected com.fasterxml.jackson.core.JsonToken _initForReading(com.fasterxml.jackson.core.JsonParser jp)                                                        throws IOException,                                                               com.fasterxml.jackson.core.JsonParseException,                                                               JsonMappingException
Method called to ensure that given parser is ready for reading content for data binding.

Returns:
First token to be used for data binding after this call: can never be null as exception will be thrown if parser can not provide more tokens.
Throws:
IOException - if the underlying input source has problems during parsing
com.fasterxml.jackson.core.JsonParseException - if parser has problems parsing content
JsonMappingException - if the parser does not have any more content to map (note: Json "null" value is considered content; enf-of-stream not)

_unwrapAndDeserialize

protected Object _unwrapAndDeserialize(com.fasterxml.jackson.core.JsonParser jp,                                       DeserializationContext ctxt,                                       DeserializationConfig config,                                       JavaType rootType,                                       JsonDeserializer<Object> deser)                                throws IOException,                                       com.fasterxml.jackson.core.JsonParseException,                                       JsonMappingException
Throws:
IOException
com.fasterxml.jackson.core.JsonParseException
JsonMappingException

_findRootDeserializer

protected JsonDeserializer<Object> _findRootDeserializer(DeserializationContext ctxt,                                                         JavaType valueType)                                                  throws JsonMappingException
Method called to locate deserializer for the passed root-level value.

Throws:
JsonMappingException


Copyright © 2012
fasterxml.com. All Rights Reserved.


NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14