Class ObjectReader
- java.lang.Object
-
- com.fasterxml.jackson.core.TreeCodec
-
- com.fasterxml.jackson.core.ObjectCodec
-
- com.fasterxml.jackson.databind.ObjectReader
-
- All Implemented Interfaces:
Versioned,Serializable
public class ObjectReader extends ObjectCodec implements Versioned, Serializable
Builder object that can be used for per-serialization configuration of deserialization parameters, such as root type to use or object to update (instead of constructing new instance).Uses "mutant factory" pattern so that instances are immutable (and thus fully thread-safe with no external synchronization); new instances are constructed for different configurations. Instances are initially constructed by
ObjectMapperand can be reused, shared, cached; both because of thread-safety and because instances are relatively light-weight.NOTE: this class is NOT meant as sub-classable (with Jackson 2.8 and above) by users. It is left as non-final mostly to allow frameworks that require bytecode generation for proxying and similar use cases, but there is no expecation that functionality should be extended by sub-classing.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected DeserializationConfig_configGeneral serialization configuration settings; while immutable, can use copy-constructor to create modified instances as necessary.protected DefaultDeserializationContext_contextBlueprint instance of deserialization context; used for creating actual instance when needed.protected DataFormatReaders_dataFormatReadersOptional detector used for auto-detecting data format that byte-based input uses.protected InjectableValues_injectableValuesValues that can be injected during deserialization, if any.protected JavaType_jsonNodeTypeprotected JsonFactory_parserFactoryFactory used for constructingJsonGeneratorsprotected JsonDeserializer<Object>_rootDeserializerWe may pre-fetch deserializer as soon as_valueTypeis known, and if so, reuse it afterwards.protected ConcurrentHashMap<JavaType,JsonDeserializer<Object>>_rootDeserializersRoot-level cached deserializers.protected FormatSchema_schemaWhen using data format that uses a schema, schema is passed to parser.protected boolean_unwrapRootFlag that indicates whether root values are expected to be unwrapped or notprotected Object_valueToUpdateInstance to update with data binding; if any.protected JavaType_valueTypeDeclared type of value to instantiate during deserialization.
-
Constructor Summary
Constructors Modifier Constructor Description protectedObjectReader(ObjectMapper mapper, DeserializationConfig config)Constructor used byObjectMapperfor initial instantiationprotectedObjectReader(ObjectMapper mapper, DeserializationConfig config, JavaType valueType, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues)Constructor called when a root deserializer should be fetched based on other configuration.protectedObjectReader(ObjectReader base, TokenFilter filter)protectedObjectReader(ObjectReader base, JsonFactory f)protectedObjectReader(ObjectReader base, DeserializationConfig config)Copy constructor used when modifying simple feature flagsprotectedObjectReader(ObjectReader base, DeserializationConfig config, JavaType valueType, JsonDeserializer<Object> rootDeser, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues, DataFormatReaders dataFormatReaders)Copy constructor used for building variations.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void_assertNotNull(String paramName, Object src)protected Object_bind(JsonParser p, Object valueToUpdate)Actual implementation of value reading+binding operation.protected Object_bindAndClose(JsonParser p0)protected JsonNode_bindAndCloseAsTree(JsonParser p0)protected <T> MappingIterator<T>_bindAndReadValues(JsonParser p)protected JsonNode_bindAsTree(JsonParser p)protected JsonNode_bindAsTreeOrNull(JsonParser p)Same as_bindAsTree(com.fasterxml.jackson.core.JsonParser)except end-of-input is reported by returningnull, not "missing node"protected JsonParser_considerFilter(JsonParser p, boolean multiValue)Consider filter when creating JsonParser.protected Object_detectBindAndClose(byte[] src, int offset, int length)protected Object_detectBindAndClose(DataFormatReaders.Match match, boolean forceClosing)protected JsonNode_detectBindAndCloseAsTree(InputStream in)protected <T> MappingIterator<T>_detectBindAndReadValues(DataFormatReaders.Match match, boolean forceClosing)protected JsonDeserializer<Object>_findRootDeserializer(DeserializationContext ctxt)Method called to locate deserializer for the passed root-level value.protected JsonDeserializer<Object>_findTreeDeserializer(DeserializationContext ctxt)protected void_initForMultiRead(DeserializationContext ctxt, JsonParser p)Alternative to_initForReading(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.core.JsonParser)used in cases where reading of multiple values means that we may or may not want to advance the stream, but need to do other initialization.protected JsonToken_initForReading(DeserializationContext ctxt, JsonParser p)protected InputStream_inputStream(File f)protected InputStream_inputStream(URL src)protected JavaType_jsonNodeType()protected ObjectReader_new(ObjectReader base, JsonFactory f)Overridable factory method called by various "withXxx()" methodsprotected ObjectReader_new(ObjectReader base, DeserializationConfig config)Overridable factory method called by various "withXxx()" methodsprotected ObjectReader_new(ObjectReader base, DeserializationConfig config, JavaType valueType, JsonDeserializer<Object> rootDeser, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues, DataFormatReaders dataFormatReaders)Overridable factory method called by various "withXxx()" methodsprotected <T> MappingIterator<T>_newIterator(JsonParser p, DeserializationContext ctxt, JsonDeserializer<?> deser, boolean parserManaged)Factory method used to createMappingIteratorinstances; either default, or custom subtype.protected JsonDeserializer<Object>_prefetchRootDeserializer(JavaType valueType)Method called to locate deserializer ahead of time, if permitted by configuration.protected void_reportUndetectableSource(Object src)protected void_reportUnkownFormat(DataFormatReaders detector, DataFormatReaders.Match match)Method called to indicate that format detection failed to detect format of given inputprotected void_verifyNoTrailingTokens(JsonParser p, DeserializationContext ctxt, JavaType bindType)protected void_verifySchemaType(FormatSchema schema)protected ObjectReader_with(DeserializationConfig newConfig)ObjectReaderat(JsonPointer pointer)Convenience method to bind fromJsonPointerJsonPointerBasedFilteris registered and will be used for parsing later.ObjectReaderat(String pointerExpr)Convenience method to bind fromJsonPointer.JsonNodecreateArrayNode()Method for construct root level Array nodes for Tree Model instances.protected DefaultDeserializationContextcreateDeserializationContext(JsonParser p)Internal helper method called to create an instance ofDeserializationContextfor deserializing a single root value.protected DefaultDeserializationContextcreateDummyDeserializationContext()JsonParsercreateNonBlockingByteArrayParser()Factory method for constructing properly initializedJsonParserto read content using non-blocking (asynchronous) mode.JsonNodecreateObjectNode()Method for construct root level Object nodes for Tree Model instances.JsonParsercreateParser(byte[] content)Factory method for constructing properly initializedJsonParserto read content from specified byte array.JsonParsercreateParser(byte[] content, int offset, int len)Factory method for constructing properly initializedJsonParserto read content from specified byte array.JsonParsercreateParser(char[] content)Factory method for constructing properly initializedJsonParserto read content from specified character array Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.JsonParsercreateParser(char[] content, int offset, int len)Factory method for constructing properly initializedJsonParserto read content from specified character array.JsonParsercreateParser(DataInput content)Factory method for constructing properly initializedJsonParserto read content using specifiedDataInput.JsonParsercreateParser(File src)Factory method for constructing properly initializedJsonParserto read content from specifiedFile.JsonParsercreateParser(InputStream in)Factory method for constructing properly initializedJsonParserto read content using specifiedInputStream.JsonParsercreateParser(Reader r)Factory method for constructing properly initializedJsonParserto read content using specifiedReader.JsonParsercreateParser(String content)Factory method for constructing properly initializedJsonParserto read content from specified String.JsonParsercreateParser(URL src)Factory method for constructing properly initializedJsonParserto read content from specifiedFile.ObjectReaderforType(TypeReference<?> valueTypeRef)Method for constructing a new reader instance that is configured to data bind into specified type.ObjectReaderforType(JavaType valueType)Method for constructing a new reader instance that is configured to data bind into specified type.ObjectReaderforType(Class<?> valueType)Method for constructing a new reader instance that is configured to data bind into specified type.ContextAttributesgetAttributes()DeserializationConfiggetConfig()JsonFactorygetFactory()Accessor for finding underlying data format factory (JsonFactory) codec will use for data binding.InjectableValuesgetInjectableValues()TypeFactorygetTypeFactory()JavaTypegetValueType()booleanisEnabled(JsonParser.Feature f)booleanisEnabled(StreamReadFeature f)booleanisEnabled(DatatypeFeature f)booleanisEnabled(DeserializationFeature f)booleanisEnabled(MapperFeature f)JsonNodemissingNode()JsonNodenullNode()JsonNodereadTree(byte[] json)Same asreadTree(InputStream)except content read from passed-in byte array.JsonNodereadTree(byte[] json, int offset, int len)Same asreadTree(InputStream)except content read from passed-in byte array.<T extends TreeNode>
TreadTree(JsonParser p)Convenience method that binds content read using given parser, using configuration of this reader, except that content is bound as JSON tree instead of configured root value type.JsonNodereadTree(DataInput src)Same asreadTree(InputStream)except content read using passed-inDataInput.JsonNodereadTree(InputStream src)Method that reads content from given input source, using configuration of this reader, and binds it as JSON Tree.JsonNodereadTree(Reader src)Same asreadTree(InputStream)except content accessed through passed-inReaderJsonNodereadTree(String json)Same asreadTree(InputStream)except content read from passed-inString<T> TreadValue(byte[] content)Method that binds content read from given byte array, using configuration of this reader.<T> TreadValue(byte[] buffer, int offset, int length)Method that binds content read from given byte array, using configuration of this reader.<T> TreadValue(byte[] buffer, int offset, int length, Class<T> valueType)Same asreadValue(byte[],int,int)except that target value type overridden asvalueType<T> TreadValue(byte[] content, Class<T> valueType)Same asreadValue(byte[])except that target value type overridden asvalueType<T> TreadValue(JsonParser p)Method that binds content read using given parser, using configuration of this reader, including expected result type.<T> TreadValue(JsonParser p, ResolvedType valueType)Convenience method that binds content read using given parser, using configuration of this reader, except that expected value type is specified with the call (instead of currently configured root type).<T> TreadValue(JsonParser p, TypeReference<T> valueTypeRef)Convenience method that binds content read using given parser, using configuration of this reader, except that expected value type is specified with the call (instead of currently configured root type).<T> TreadValue(JsonParser p, JavaType valueType)Type-safe overloaded method, basically alias forreadValue(JsonParser, ResolvedType).<T> TreadValue(JsonParser p, Class<T> valueType)Convenience method that binds content read using given parser, using configuration of this reader, except that expected value type is specified with the call (instead of currently configured root type).<T> TreadValue(JsonNode content)Convenience method for converting results from given JSON tree into given value type.<T> TreadValue(JsonNode content, Class<T> valueType)Same asreadValue(JsonNode)except that target value type overridden asvalueType<T> TreadValue(DataInput src)<T> TreadValue(DataInput content, Class<T> valueType)Same asreadValue(DataInput)except that target value type overridden asvalueType<T> TreadValue(File src)Method that binds content read from givenFileusing configuration of this reader.<T> TreadValue(File src, Class<T> valueType)Same asreadValue(File)except that target value type overridden asvalueType<T> TreadValue(InputStream src)Method that binds content read from given input source, using configuration of this reader.<T> TreadValue(InputStream src, Class<T> valueType)Same asreadValue(InputStream)except that target value type overridden asvalueType<T> TreadValue(Reader src)Method that binds content read from given input source, using configuration of this reader.<T> TreadValue(Reader src, Class<T> valueType)Same asreadValue(Reader)except that target value type overridden asvalueType<T> TreadValue(String src)Method that binds content read from given JSON string, using configuration of this reader.<T> TreadValue(String src, Class<T> valueType)Same asreadValue(String)except that target value type overridden asvalueType<T> TreadValue(URL src)Method that binds content read from given input source, using configuration of this reader.<T> TreadValue(URL src, Class<T> valueType)Same asreadValue(URL)except that target value type overridden asvalueType<T> MappingIterator<T>readValues(byte[] src)Overloaded version ofreadValue(InputStream).<T> MappingIterator<T>readValues(byte[] src, int offset, int length)Overloaded version ofreadValue(InputStream).<T> MappingIterator<T>readValues(JsonParser p)Method for reading sequence of Objects from parser stream.<T> Iterator<T>readValues(JsonParser p, ResolvedType valueType)Convenience method that is equivalent to:<T> Iterator<T>readValues(JsonParser p, TypeReference<T> valueTypeRef)Convenience method that is equivalent to:<T> Iterator<T>readValues(JsonParser p, JavaType valueType)Convenience method that is equivalent to:<T> Iterator<T>readValues(JsonParser p, Class<T> valueType)Convenience method that is equivalent to:<T> MappingIterator<T>readValues(DataInput src)<T> MappingIterator<T>readValues(File src)Overloaded version ofreadValue(InputStream).<T> MappingIterator<T>readValues(InputStream src)Method for reading sequence of Objects from parser stream.<T> MappingIterator<T>readValues(Reader src)Overloaded version ofreadValue(InputStream).<T> MappingIterator<T>readValues(String json)Overloaded version ofreadValue(InputStream).<T> MappingIterator<T>readValues(URL src)Overloaded version ofreadValue(InputStream).JsonParsertreeAsTokens(TreeNode n)Method for constructing aJsonParserfor reading contents of a JSON tree, as if it was external serialized JSON content.<T> TtreeToValue(TreeNode n, JavaType valueType)Same astreeToValue(TreeNode, Class)but with type-resolved target value type.<T> TtreeToValue(TreeNode n, Class<T> valueType)Convenience method for converting given JSON tree into instance of specified value type.Versionversion()Method that will return version information stored in and read from jar that contains this class.ObjectReaderwith(Base64Variant defaultBase64)ObjectReaderwith(FormatFeature feature)Method for constructing a new reader instance that is configured with specified feature enabled.ObjectReaderwith(FormatSchema schema)Method for constructing a new instance with configuration that passes specifiedFormatSchematoJsonParserthat is constructed for parsing content.ObjectReaderwith(JsonFactory f)Method for constructing a new reader instance with configuration that uses passedJsonFactoryfor constructing underlying Readers.ObjectReaderwith(JsonParser.Feature feature)Method for constructing a new reader instance that is configured with specified feature enabled.ObjectReaderwith(StreamReadFeature feature)Method for constructing a new reader instance that is configured with specified feature enabled.ObjectReaderwith(ContextAttributes attrs)ObjectReaderwith(DatatypeFeature feature)Method for constructing a new reader instance that is configured with specified feature enabled.ObjectReaderwith(DeserializationConfig config)Mutant factory method that will construct a new instance that has specified underlyingDeserializationConfig.ObjectReaderwith(DeserializationFeature feature)Method for constructing a new reader instance that is configured with specified feature enabled.ObjectReaderwith(DeserializationFeature first, DeserializationFeature... other)Method for constructing a new reader instance that is configured with specified features enabled.ObjectReaderwith(InjectableValues injectableValues)Method for constructing a new instance with configuration that uses passedInjectableValuesto provide injectable values.ObjectReaderwith(JsonNodeFactory f)Method for constructing a new reader instance with configuration that uses passedJsonNodeFactoryfor constructingJsonNodeinstances.ObjectReaderwith(Locale l)ObjectReaderwith(TimeZone tz)ObjectReaderwithAttribute(Object key, Object value)ObjectReaderwithAttributes(Map<?,?> attrs)ObjectReaderwithFeatures(FormatFeature... features)Method for constructing a new reader instance that is configured with specified features enabled.ObjectReaderwithFeatures(JsonParser.Feature... features)Method for constructing a new reader instance that is configured with specified features enabled.ObjectReaderwithFeatures(DatatypeFeature... features)Method for constructing a new reader instance that is configured with specified features enabled.ObjectReaderwithFeatures(DeserializationFeature... features)Method for constructing a new reader instance that is configured with specified features enabled.ObjectReaderwithFormatDetection(DataFormatReaders readers)Fluent factory method for constructing a reader that will try to auto-detect underlying data format, using specifiedDataFormatReaders.ObjectReaderwithFormatDetection(ObjectReader... readers)Fluent factory method for constructing a reader that will try to auto-detect underlying data format, using specified list ofJsonFactoryinstances, and defaultDataFormatReaderssettings (for customizedDataFormatReaders, you can construct instance yourself).ObjectReaderwithHandler(DeserializationProblemHandler h)ObjectReaderwithout(FormatFeature feature)Method for constructing a new reader instance that is configured with specified feature disabled.ObjectReaderwithout(JsonParser.Feature feature)Method for constructing a new reader instance that is configured with specified feature disabled.ObjectReaderwithout(StreamReadFeature feature)Method for constructing a new reader instance that is configured with specified feature disabled.ObjectReaderwithout(DatatypeFeature feature)Method for constructing a new reader instance that is configured with specified feature disabled.ObjectReaderwithout(DeserializationFeature feature)Method for constructing a new reader instance that is configured with specified feature disabled.ObjectReaderwithout(DeserializationFeature first, DeserializationFeature... other)Method for constructing a new reader instance that is configured with specified features disabled.ObjectReaderwithoutAttribute(Object key)ObjectReaderwithoutFeatures(FormatFeature... features)Method for constructing a new reader instance that is configured with specified features disabled.ObjectReaderwithoutFeatures(JsonParser.Feature... features)Method for constructing a new reader instance that is configured with specified features disabled.ObjectReaderwithoutFeatures(DatatypeFeature... features)Method for constructing a new reader instance that is configured with specified features disabled.ObjectReaderwithoutFeatures(DeserializationFeature... features)Method for constructing a new reader instance that is configured with specified features disabled.ObjectReaderwithoutRootName()Convenience method that is same as calling:withRootName("")which will forcibly prevent use of root name wrapping when writing values with thisObjectReader.ObjectReaderwithRootName(PropertyName rootName)ObjectReaderwithRootName(String rootName)Method for constructing a new instance with configuration that specifies what root name to expect for "root name unwrapping".ObjectReaderwithType(TypeReference<?> valueTypeRef)Deprecated.since 2.5 UseforType(TypeReference)insteadObjectReaderwithType(JavaType valueType)Deprecated.since 2.5 UseforType(JavaType)insteadObjectReaderwithType(Class<?> valueType)Deprecated.since 2.5 UseforType(Class)insteadObjectReaderwithType(Type valueType)Deprecated.since 2.5 UseforType(Class)insteadObjectReaderwithValueToUpdate(Object value)Method for constructing a new instance with configuration that updates passed Object (as root value), instead of constructing a new value.ObjectReaderwithView(Class<?> activeView)Method for constructing a new instance with configuration that uses specified View for filtering.voidwriteTree(JsonGenerator g, TreeNode rootNode)Method for serializing JSON content from given Tree instance, using specified generator.voidwriteValue(JsonGenerator gen, Object value)Method to serialize given Java Object, using generator provided.-
Methods inherited from class com.fasterxml.jackson.core.ObjectCodec
getJsonFactory
-
-
-
-
Field Detail
-
_config
protected final DeserializationConfig _config
General serialization configuration settings; while immutable, can use copy-constructor to create modified instances as necessary.
-
_context
protected final DefaultDeserializationContext _context
Blueprint instance of deserialization context; used for creating actual instance when needed.
-
_parserFactory
protected final JsonFactory _parserFactory
Factory used for constructingJsonGenerators
-
_unwrapRoot
protected final boolean _unwrapRoot
Flag that indicates whether root values are expected to be unwrapped or not
-
_valueType
protected final JavaType _valueType
Declared type of value to instantiate during deserialization. Defines which deserializer to use; as well as base type of instance to construct if an updatable value is not configured to be used (subject to changes by embedded type information, for polymorphic types). If_valueToUpdateis non-null, only used for locating deserializer.
-
_rootDeserializer
protected final JsonDeserializer<Object> _rootDeserializer
We may pre-fetch deserializer as soon as_valueTypeis known, and if so, reuse it afterwards. This allows avoiding further deserializer lookups and increases performance a bit on cases where readers are reused.- Since:
- 2.1
-
_valueToUpdate
protected final Object _valueToUpdate
Instance to update with data binding; if any. If null, a new instance is created, if non-null, properties of this value object will be updated instead. Note that value can be of almost any type, except notArrayType; array types cannot be modified because array size is immutable.
-
_schema
protected final FormatSchema _schema
When using data format that uses a schema, schema is passed to parser.
-
_injectableValues
protected final InjectableValues _injectableValues
Values that can be injected during deserialization, if any.
-
_dataFormatReaders
protected final DataFormatReaders _dataFormatReaders
Optional detector used for auto-detecting data format that byte-based input uses.NOTE: If defined non-null,
readValue()methods that takeReaderorStringinput will fail with exception, because format-detection only works on byte-sources. Also, if format cannot be detect reliably (as per detector settings), aStreamReadExceptionwill be thrown).- Since:
- 2.1
-
_rootDeserializers
protected final ConcurrentHashMap<JavaType,JsonDeserializer<Object>> _rootDeserializers
Root-level cached deserializers. Passed byObjectMapper, shared with it.
-
_jsonNodeType
protected transient JavaType _jsonNodeType
-
-
Constructor Detail
-
ObjectReader
protected ObjectReader(ObjectMapper mapper, DeserializationConfig config)
Constructor used byObjectMapperfor initial instantiation
-
ObjectReader
protected ObjectReader(ObjectMapper mapper, DeserializationConfig config, JavaType valueType, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues)
Constructor called when a root deserializer should be fetched based on other configuration.
-
ObjectReader
protected ObjectReader(ObjectReader base, DeserializationConfig config, JavaType valueType, JsonDeserializer<Object> rootDeser, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues, DataFormatReaders dataFormatReaders)
Copy constructor used for building variations.
-
ObjectReader
protected ObjectReader(ObjectReader base, DeserializationConfig config)
Copy constructor used when modifying simple feature flags
-
ObjectReader
protected ObjectReader(ObjectReader base, JsonFactory f)
-
ObjectReader
protected ObjectReader(ObjectReader base, TokenFilter filter)
-
-
Method Detail
-
version
public Version version()
Method that will return version information stored in and read from jar that contains this class.- Specified by:
versionin interfaceVersioned- Specified by:
versionin classObjectCodec- Returns:
- Version of the component
-
_new
protected ObjectReader _new(ObjectReader base, JsonFactory f)
Overridable factory method called by various "withXxx()" methods- Since:
- 2.5
-
_new
protected ObjectReader _new(ObjectReader base, DeserializationConfig config)
Overridable factory method called by various "withXxx()" methods- Since:
- 2.5
-
_new
protected ObjectReader _new(ObjectReader base, DeserializationConfig config, JavaType valueType, JsonDeserializer<Object> rootDeser, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues, DataFormatReaders dataFormatReaders)
Overridable factory method called by various "withXxx()" methods- Since:
- 2.5
-
_newIterator
protected <T> MappingIterator<T> _newIterator(JsonParser p, DeserializationContext ctxt, JsonDeserializer<?> deser, boolean parserManaged)
Factory method used to createMappingIteratorinstances; either default, or custom subtype.- Since:
- 2.5
-
_initForReading
protected JsonToken _initForReading(DeserializationContext ctxt, JsonParser p) throws IOException
- Throws:
IOException
-
_initForMultiRead
protected void _initForMultiRead(DeserializationContext ctxt, JsonParser p) throws IOException
Alternative to_initForReading(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.core.JsonParser)used in cases where reading of multiple values means that we may or may not want to advance the stream, but need to do other initialization.Base implementation only sets configured
FormatSchema, if any, on parser.- Throws:
IOException- Since:
- 2.8
-
with
public ObjectReader with(DeserializationFeature feature)
Method for constructing a new reader instance that is configured with specified feature enabled.
-
with
public ObjectReader with(DeserializationFeature first, DeserializationFeature... other)
Method for constructing a new reader instance that is configured with specified features enabled.
-
withFeatures
public ObjectReader withFeatures(DeserializationFeature... features)
Method for constructing a new reader instance that is configured with specified features enabled.
-
without
public ObjectReader without(DeserializationFeature feature)
Method for constructing a new reader instance that is configured with specified feature disabled.
-
without
public ObjectReader without(DeserializationFeature first, DeserializationFeature... other)
Method for constructing a new reader instance that is configured with specified features disabled.
-
withoutFeatures
public ObjectReader withoutFeatures(DeserializationFeature... features)
Method for constructing a new reader instance that is configured with specified features disabled.
-
with
public ObjectReader with(DatatypeFeature feature)
Method for constructing a new reader instance that is configured with specified feature enabled.- Since:
- 2.14
-
withFeatures
public ObjectReader withFeatures(DatatypeFeature... features)
Method for constructing a new reader instance that is configured with specified features enabled.- Since:
- 2.14
-
without
public ObjectReader without(DatatypeFeature feature)
Method for constructing a new reader instance that is configured with specified feature disabled.- Since:
- 2.14
-
withoutFeatures
public ObjectReader withoutFeatures(DatatypeFeature... features)
Method for constructing a new reader instance that is configured with specified features disabled.- Since:
- 2.14
-
with
public ObjectReader with(JsonParser.Feature feature)
Method for constructing a new reader instance that is configured with specified feature enabled.- Parameters:
feature- Feature to enable- Returns:
- Reader instance with specified feature enabled
-
withFeatures
public ObjectReader withFeatures(JsonParser.Feature... features)
Method for constructing a new reader instance that is configured with specified features enabled.- Parameters:
features- Features to enable- Returns:
- Reader instance with specified features enabled
-
without
public ObjectReader without(JsonParser.Feature feature)
Method for constructing a new reader instance that is configured with specified feature disabled.- Parameters:
feature- Feature to disable- Returns:
- Reader instance with specified feature disabled
-
withoutFeatures
public ObjectReader withoutFeatures(JsonParser.Feature... features)
Method for constructing a new reader instance that is configured with specified features disabled.- Parameters:
features- Features to disable- Returns:
- Reader instance with specified features disabled
-
with
public ObjectReader with(StreamReadFeature feature)
Method for constructing a new reader instance that is configured with specified feature enabled.- Returns:
- Reader instance with specified feature enabled
- Since:
- 2.11
-
without
public ObjectReader without(StreamReadFeature feature)
Method for constructing a new reader instance that is configured with specified feature disabled.- Returns:
- Reader instance with specified feature enabled
- Since:
- 2.11
-
with
public ObjectReader with(FormatFeature feature)
Method for constructing a new reader instance that is configured with specified feature enabled.- Since:
- 2.7
-
withFeatures
public ObjectReader withFeatures(FormatFeature... features)
Method for constructing a new reader instance that is configured with specified features enabled.- Since:
- 2.7
-
without
public ObjectReader without(FormatFeature feature)
Method for constructing a new reader instance that is configured with specified feature disabled.- Since:
- 2.7
-
withoutFeatures
public ObjectReader withoutFeatures(FormatFeature... features)
Method for constructing a new reader instance that is configured with specified features disabled.- Since:
- 2.7
-
at
public ObjectReader at(String pointerExpr)
Convenience method to bind fromJsonPointer.JsonPointerBasedFilteris registered and will be used for parsing later.- Since:
- 2.6
-
at
public ObjectReader at(JsonPointer pointer)
Convenience method to bind fromJsonPointerJsonPointerBasedFilteris registered and will be used for parsing later.- Since:
- 2.6
-
with
public ObjectReader with(DeserializationConfig config)
Mutant factory method that will construct a new instance that has specified underlyingDeserializationConfig.NOTE: use of this method is not recommended, as there are many other re-configuration methods available.
-
with
public ObjectReader with(InjectableValues injectableValues)
Method for constructing a new instance with configuration that uses passedInjectableValuesto provide injectable values.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
-
with
public ObjectReader with(JsonNodeFactory f)
Method for constructing a new reader instance with configuration that uses passedJsonNodeFactoryfor constructingJsonNodeinstances.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
-
with
public ObjectReader with(JsonFactory f)
Method for constructing a new reader instance with configuration that uses passedJsonFactoryfor constructing underlying Readers.NOTE: only factories that DO NOT REQUIRE SPECIAL MAPPERS (that is, ones that return
falseforJsonFactory.requiresCustomCodec()) can be used: trying to use one that requires custom codec will throw exception- Since:
- 2.1
-
withRootName
public ObjectReader withRootName(String rootName)
Method for constructing a new instance with configuration that specifies what root name to expect for "root name unwrapping". SeeMapperConfigBase.withRootName(String)for details.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
-
withRootName
public ObjectReader withRootName(PropertyName rootName)
- Since:
- 2.6
-
withoutRootName
public ObjectReader withoutRootName()
Convenience method that is same as calling:withRootName("")which will forcibly prevent use of root name wrapping when writing values with thisObjectReader.- Since:
- 2.6
-
with
public ObjectReader with(FormatSchema schema)
Method for constructing a new instance with configuration that passes specifiedFormatSchematoJsonParserthat is constructed for parsing content.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
-
forType
public ObjectReader forType(JavaType valueType)
Method for constructing a new reader instance that is configured to data bind into specified type.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
- Since:
- 2.5
-
forType
public ObjectReader forType(Class<?> valueType)
Method for constructing a new reader instance that is configured to data bind into specified type.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
- Since:
- 2.5
-
forType
public ObjectReader forType(TypeReference<?> valueTypeRef)
Method for constructing a new reader instance that is configured to data bind into specified type.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
- Since:
- 2.5
-
withType
@Deprecated public ObjectReader withType(JavaType valueType)
Deprecated.since 2.5 UseforType(JavaType)instead
-
withType
@Deprecated public ObjectReader withType(Class<?> valueType)
Deprecated.since 2.5 UseforType(Class)instead
-
withType
@Deprecated public ObjectReader withType(Type valueType)
Deprecated.since 2.5 UseforType(Class)instead
-
withType
@Deprecated public ObjectReader withType(TypeReference<?> valueTypeRef)
Deprecated.since 2.5 UseforType(TypeReference)instead
-
withValueToUpdate
public ObjectReader withValueToUpdate(Object value)
Method for constructing a new instance with configuration that updates passed Object (as root value), instead of constructing a new value.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
-
withView
public ObjectReader withView(Class<?> activeView)
Method for constructing a new instance with configuration that uses specified View for filtering.Note that the method does NOT change state of this reader, but rather construct and returns a newly configured instance.
-
with
public ObjectReader with(Locale l)
-
with
public ObjectReader with(TimeZone tz)
-
withHandler
public ObjectReader withHandler(DeserializationProblemHandler h)
-
with
public ObjectReader with(Base64Variant defaultBase64)
-
withFormatDetection
public ObjectReader withFormatDetection(ObjectReader... readers)
Fluent factory method for constructing a reader that will try to auto-detect underlying data format, using specified list ofJsonFactoryinstances, and defaultDataFormatReaderssettings (for customizedDataFormatReaders, you can construct instance yourself). to construct appropriateJsonParserfor actual parsing.Note: since format detection only works with byte sources, it is possible to get a failure from some 'readValue()' methods. Also, if input cannot be reliably (enough) detected as one of specified types, an exception will be thrown.
Note: not all
JsonFactorytypes can be passed: specifically, ones that require "custom codec" (like XML factory) will not work. Instead, use method that takesObjectReaderinstances instead of factories.- Parameters:
readers- Data formats accepted, in decreasing order of priority (that is, matches checked in listed order, first match wins)- Returns:
- Newly configured writer instance
- Since:
- 2.1
-
withFormatDetection
public ObjectReader withFormatDetection(DataFormatReaders readers)
Fluent factory method for constructing a reader that will try to auto-detect underlying data format, using specifiedDataFormatReaders.NOTE: since format detection only works with byte sources, it is possible to get a failure from some 'readValue()' methods. Also, if input cannot be reliably (enough) detected as one of specified types, an exception will be thrown.
- Parameters:
readers- DataFormatReaders to use for detecting underlying format.- Returns:
- Newly configured writer instance
- Since:
- 2.1
-
with
public ObjectReader with(ContextAttributes attrs)
- Since:
- 2.3
-
withAttributes
public ObjectReader withAttributes(Map<?,?> attrs)
- Since:
- 2.3
-
withAttribute
public ObjectReader withAttribute(Object key, Object value)
- Since:
- 2.3
-
withoutAttribute
public ObjectReader withoutAttribute(Object key)
- Since:
- 2.3
-
_with
protected ObjectReader _with(DeserializationConfig newConfig)
-
isEnabled
public boolean isEnabled(DeserializationFeature f)
-
isEnabled
public boolean isEnabled(MapperFeature f)
-
isEnabled
public boolean isEnabled(DatatypeFeature f)
- Since:
- 2.14
-
isEnabled
public boolean isEnabled(JsonParser.Feature f)
-
isEnabled
public boolean isEnabled(StreamReadFeature f)
- Since:
- 2.11
-
getConfig
public DeserializationConfig getConfig()
- Since:
- 2.2
-
getFactory
public JsonFactory getFactory()
Description copied from class:ObjectCodecAccessor for finding underlying data format factory (JsonFactory) codec will use for data binding.- Overrides:
getFactoryin classObjectCodec- Returns:
- Underlying
JsonFactoryinstance - Since:
- 2.1
-
getTypeFactory
public TypeFactory getTypeFactory()
-
getAttributes
public ContextAttributes getAttributes()
- Since:
- 2.3
-
getInjectableValues
public InjectableValues getInjectableValues()
- Since:
- 2.6
-
getValueType
public JavaType getValueType()
- Since:
- 2.10
-
createParser
public JsonParser createParser(File src) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specifiedFile. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(URL src) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specifiedFile. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(InputStream in) throws IOException
Factory method for constructing properly initializedJsonParserto read content using specifiedInputStream. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(Reader r) throws IOException
Factory method for constructing properly initializedJsonParserto read content using specifiedReader. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(byte[] content) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specified byte array. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(byte[] content, int offset, int len) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specified byte array. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(String content) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specified String. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(char[] content) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specified character array Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(char[] content, int offset, int len) throws IOException
Factory method for constructing properly initializedJsonParserto read content from specified character array. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createParser
public JsonParser createParser(DataInput content) throws IOException
Factory method for constructing properly initializedJsonParserto read content using specifiedDataInput. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
createNonBlockingByteArrayParser
public JsonParser createNonBlockingByteArrayParser() throws IOException
Factory method for constructing properly initializedJsonParserto read content using non-blocking (asynchronous) mode. Parser is not managed (or "owned") by ObjectReader: caller is responsible for properly closing it once content reading is complete.- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(JsonParser p) throws IOException
Method that binds content read using given parser, using configuration of this reader, including expected result type. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Throws:
IOException
-
readValue
public <T> T readValue(JsonParser p, Class<T> valueType) throws IOException
Convenience method that binds content read using given parser, using configuration of this reader, except that expected value type is specified with the call (instead of currently configured root type). Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readValuein classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
p- Parser to use for decoding content to bindvalueType- Java value type to bind content to- Returns:
- Value deserialized
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readValue
public <T> T readValue(JsonParser p, TypeReference<T> valueTypeRef) throws IOException
Convenience method that binds content read using given parser, using configuration of this reader, except that expected value type is specified with the call (instead of currently configured root type). Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readValuein classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
p- Parser to use for decoding content to bindvalueTypeRef- Java value type to bind content to- Returns:
- Value deserialized
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readValue
public <T> T readValue(JsonParser p, ResolvedType valueType) throws IOException
Convenience method that binds content read using given parser, using configuration of this reader, except that expected value type is specified with the call (instead of currently configured root type). Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readValuein classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
p- Parser to use for decoding content to bindvalueType- Java value type to bind content to- Returns:
- Value deserialized
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readValue
public <T> T readValue(JsonParser p, JavaType valueType) throws IOException
Type-safe overloaded method, basically alias forreadValue(JsonParser, ResolvedType).NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Throws:
IOException
-
readValues
public <T> Iterator<T> readValues(JsonParser p, Class<T> valueType) throws IOException
Convenience method that is equivalent to:withType(valueType).readValues(p);
Method reads a sequence of Objects from parser stream. Sequence can be either root-level "unwrapped" sequence (without surrounding JSON array), or a sequence contained in a JSON Array. In either case
JsonParserMUST point to the first token of the first element, OR not point to any token (in which case it is advanced to the next token). This means, specifically, that for wrapped sequences, parser MUST NOT point to the surroundingSTART_ARRAY(one that contains values to read) but rather to the token following it which is the first token of the first value to read.NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readValuesin classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
p- Parser to use for decoding content to bindvalueType- Java value type to bind content to- Returns:
- Iterator for incrementally deserializing values
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readValues
public <T> Iterator<T> readValues(JsonParser p, TypeReference<T> valueTypeRef) throws IOException
Convenience method that is equivalent to:withType(valueTypeRef).readValues(p);
Method reads a sequence of Objects from parser stream. Sequence can be either root-level "unwrapped" sequence (without surrounding JSON array), or a sequence contained in a JSON Array. In either case
JsonParserMUST point to the first token of the first element, OR not point to any token (in which case it is advanced to the next token). This means, specifically, that for wrapped sequences, parser MUST NOT point to the surroundingSTART_ARRAY(one that contains values to read) but rather to the token following it which is the first token of the first value to read.NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readValuesin classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
p- Parser to use for decoding content to bindvalueTypeRef- Java value type to bind content to- Returns:
- Iterator for incrementally deserializing values
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readValues
public <T> Iterator<T> readValues(JsonParser p, ResolvedType valueType) throws IOException
Convenience method that is equivalent to:withType(valueType).readValues(p);
Method reads a sequence of Objects from parser stream. Sequence can be either root-level "unwrapped" sequence (without surrounding JSON array), or a sequence contained in a JSON Array. In either case
JsonParserMUST point to the first token of the first element, OR not point to any token (in which case it is advanced to the next token). This means, specifically, that for wrapped sequences, parser MUST NOT point to the surroundingSTART_ARRAY(one that contains values to read) but rather to the token following it which is the first token of the first value to read.NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readValuesin classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
p- Parser to use for decoding content to bindvalueType- Java value type to bind content to- Returns:
- Iterator for incrementally deserializing values
- Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
readValues
public <T> Iterator<T> readValues(JsonParser p, JavaType valueType) throws IOException
Convenience method that is equivalent to:withType(valueType).readValues(p);
Method reads a sequence of Objects from parser stream. Sequence can be either root-level "unwrapped" sequence (without surrounding JSON array), or a sequence contained in a JSON Array. In either case
JsonParserMUST point to the first token of the first element, OR not point to any token (in which case it is advanced to the next token). This means, specifically, that for wrapped sequences, parser MUST NOT point to the surroundingSTART_ARRAY(one that contains values to read) but rather to the token following it which is the first token of the first value to read.NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Throws:
IOException
-
createArrayNode
public JsonNode createArrayNode()
Description copied from class:ObjectCodecMethod for construct root level Array nodes for Tree Model instances.- Specified by:
createArrayNodein classObjectCodec- Returns:
- Array node created
-
createObjectNode
public JsonNode createObjectNode()
Description copied from class:ObjectCodecMethod for construct root level Object nodes for Tree Model instances.- Specified by:
createObjectNodein classObjectCodec- Returns:
- Object node created
-
missingNode
public JsonNode missingNode()
- Overrides:
missingNodein classTreeCodec- Returns:
- Node that represents "missing" node during traversal: something referenced but that does not exist in content model
-
nullNode
public JsonNode nullNode()
-
treeAsTokens
public JsonParser treeAsTokens(TreeNode n)
Description copied from class:ObjectCodecMethod for constructing aJsonParserfor reading contents of a JSON tree, as if it was external serialized JSON content.- Specified by:
treeAsTokensin classObjectCodec- Parameters:
n- Content to traverse over- Returns:
- Parser constructed for traversing over contents of specified node
-
readTree
public <T extends TreeNode> T readTree(JsonParser p) throws IOException
Convenience method that binds content read using given parser, using configuration of this reader, except that content is bound as JSON tree instead of configured root value type. ReturnsJsonNodethat represents the root of the resulting tree, if there was content to read, ornullif no more content is accessible via passedJsonParser.NOTE! Behavior with end-of-input (no more content) differs between this
readTreemethod, and all other methods that take input source: latter will return "missing node", NOTnullNote: if an object was specified with
withValueToUpdate(java.lang.Object), it will be ignored.NOTE: this method never tries to auto-detect format, since actual (data-format specific) parser is given.
- Specified by:
readTreein classObjectCodec- Returns:
- next tree from
p, ornullif empty. - Throws:
IOException- for low-level read issues, orJsonParseExceptionfor decoding problems
-
writeTree
public void writeTree(JsonGenerator g, TreeNode rootNode)
Description copied from class:ObjectCodecMethod for serializing JSON content from given Tree instance, using specified generator.- Specified by:
writeTreein classObjectCodec- Parameters:
g- Generator to use for serializing valuerootNode- Tree to serialize
-
readValue
public <T> T readValue(InputStream src) throws IOException
Method that binds content read from given input source, using configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).- Parameters:
src- Source to read content from- Throws:
IOException
-
readValue
public <T> T readValue(InputStream src, Class<T> valueType) throws IOException
Same asreadValue(InputStream)except that target value type overridden asvalueType- Parameters:
src- Source to read content fromvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(Reader src) throws IOException
Method that binds content read from given input source, using configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).- Parameters:
src- Source to read content from- Throws:
IOException
-
readValue
public <T> T readValue(Reader src, Class<T> valueType) throws IOException
Same asreadValue(Reader)except that target value type overridden asvalueType- Parameters:
src- Source to read content fromvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(String src) throws JsonProcessingException, JsonMappingException
Method that binds content read from given JSON string, using configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).- Parameters:
src- String that contains content to read- Throws:
JsonProcessingExceptionJsonMappingException
-
readValue
public <T> T readValue(String src, Class<T> valueType) throws IOException
Same asreadValue(String)except that target value type overridden asvalueType- Parameters:
src- String that contains content to readvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(byte[] content) throws IOExceptionMethod that binds content read from given byte array, using configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).- Parameters:
content- Byte array that contains encoded content to read- Throws:
IOException
-
readValue
public <T> T readValue(byte[] content, Class<T> valueType) throws IOExceptionSame asreadValue(byte[])except that target value type overridden asvalueType- Parameters:
content- Byte array that contains encoded content to readvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(byte[] buffer, int offset, int length) throws IOExceptionMethod that binds content read from given byte array, using configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).- Parameters:
buffer- Byte array that contains encoded content to readoffset- Offset of the first content byte inbufferlength- Length of content inbuffer, in bytes- Throws:
IOException
-
readValue
public <T> T readValue(byte[] buffer, int offset, int length, Class<T> valueType) throws IOExceptionSame asreadValue(byte[],int,int)except that target value type overridden asvalueType- Parameters:
buffer- Byte array that contains encoded content to readoffset- Offset of the first content byte inbufferlength- Length of content inbuffer, in bytesvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(File src) throws IOException
Method that binds content read from givenFileusing configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).- Parameters:
src- File that contains content to read- Throws:
IOException
-
readValue
public <T> T readValue(File src, Class<T> valueType) throws IOException
Same asreadValue(File)except that target value type overridden asvalueType- Parameters:
src- File that contains content to readvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(URL src) throws IOException
Method that binds content read from given input source, using configuration of this reader. Value return is either newly constructed, or root value that was specified withwithValueToUpdate(Object).NOTE: handling of
URLis delegated toJsonFactory.createParser(java.net.URL)and usually simply callsURL.openStream(), meaning no special handling is done. If different HTTP connection options are needed you will need to createInputStreamseparately.- Throws:
IOException
-
readValue
public <T> T readValue(URL src, Class<T> valueType) throws IOException
Same asreadValue(URL)except that target value type overridden asvalueType- Parameters:
src- URL pointing to resource that contains content to readvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(JsonNode content) throws IOException
Convenience method for converting results from given JSON tree into given value type. Basically short-cut for:objectReader.readValue(src.traverse())
- Parameters:
content- Tree that contains content to convert- Throws:
IOException
-
readValue
public <T> T readValue(JsonNode content, Class<T> valueType) throws IOException
Same asreadValue(JsonNode)except that target value type overridden asvalueType- Parameters:
content- Tree that contains content to convertvalueType- Target type to convert content to- Throws:
IOException- Since:
- 2.11
-
readValue
public <T> T readValue(DataInput src) throws IOException
- Throws:
IOException
-
readValue
public <T> T readValue(DataInput content, Class<T> valueType) throws IOException
Same asreadValue(DataInput)except that target value type overridden asvalueType- Parameters:
content- DataInput that contains content to readvalueType- Target type to bind content to- Throws:
IOException- Since:
- 2.11
-
readTree
public JsonNode readTree(InputStream src) throws IOException
Method that reads content from given input source, using configuration of this reader, and binds it as JSON Tree. ReturnsJsonNodethat represents the root of the resulting tree, if there was content to read, or "missing node" (instance ofJsonNodefor whichJsonNode.isMissingNode()returns true, and behaves otherwise similar to "null node") if no more content is accessible through passed-in input source.NOTE! Behavior with end-of-input (no more content) differs between this
readTreemethod, andreadTree(JsonParser)-- latter returnsnullfor "no content" case.Note that if an object was specified with a call to
withValueToUpdate(Object)it will just be ignored; result is always a newly constructedJsonNodeinstance.- Throws:
IOException
-
readTree
public JsonNode readTree(Reader src) throws IOException
Same asreadTree(InputStream)except content accessed through passed-inReader- Throws:
IOException
-
readTree
public JsonNode readTree(String json) throws JsonProcessingException, JsonMappingException
Same asreadTree(InputStream)except content read from passed-inString
-
readTree
public JsonNode readTree(byte[] json) throws IOException
Same asreadTree(InputStream)except content read from passed-in byte array.- Throws:
IOException
-
readTree
public JsonNode readTree(byte[] json, int offset, int len) throws IOException
Same asreadTree(InputStream)except content read from passed-in byte array.- Throws:
IOException
-
readTree
public JsonNode readTree(DataInput src) throws IOException
Same asreadTree(InputStream)except content read using passed-inDataInput.- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(JsonParser p) throws IOException
Method for reading sequence of Objects from parser stream.Sequence can be either root-level "unwrapped" sequence (without surrounding JSON array), or a sequence contained in a JSON Array. In either case
JsonParsermust point to the first token of the first element, OR not point to any token (in which case it is advanced to the next token). This means, specifically, that for wrapped sequences, parser MUST NOT point to the surroundingSTART_ARRAYbut rather to the token following it.- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(InputStream src) throws IOException
Method for reading sequence of Objects from parser stream.Sequence can be either wrapped or unwrapped root-level sequence: wrapped means that the elements are enclosed in JSON Array; and unwrapped that elements are directly accessed at main level. Assumption is that iff the first token of the document is
START_ARRAY, we have a wrapped sequence; otherwise unwrapped. For wrapped sequences, leadingSTART_ARRAYis skipped, so that for both cases, underlyingJsonParserwill point to what is expected to be the first token of the first element.Note that the wrapped vs unwrapped logic means that it is NOT possible to use this method for reading an unwrapped sequence of elements written as JSON Arrays: to read such sequences, one has to use
readValues(JsonParser), making sure parser points to the first token of the first element (i.e. the secondSTART_ARRAYwhich is part of the first element).- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(Reader src) throws IOException
Overloaded version ofreadValue(InputStream).- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(String json) throws IOException
Overloaded version ofreadValue(InputStream).- Parameters:
json- String that contains JSON content to parse- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(byte[] src, int offset, int length) throws IOException
Overloaded version ofreadValue(InputStream).- Throws:
IOException
-
readValues
public final <T> MappingIterator<T> readValues(byte[] src) throws IOException
Overloaded version ofreadValue(InputStream).- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(File src) throws IOException
Overloaded version ofreadValue(InputStream).- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(URL src) throws IOException
Overloaded version ofreadValue(InputStream).NOTE: handling of
URLis delegated toJsonFactory.createParser(java.net.URL)and usually simply callsURL.openStream(), meaning no special handling is done. If different HTTP connection options are needed you will need to createInputStreamseparately.- Parameters:
src- URL to read to access JSON content to parse.- Throws:
IOException
-
readValues
public <T> MappingIterator<T> readValues(DataInput src) throws IOException
- Throws:
IOException- Since:
- 2.8
-
treeToValue
public <T> T treeToValue(TreeNode n, Class<T> valueType) throws JsonProcessingException
Description copied from class:ObjectCodecConvenience method for converting given JSON tree into instance of specified value type. This is equivalent to first constructing aJsonParserto iterate over contents of the tree, and using that parser for data binding.- Specified by:
treeToValuein classObjectCodec- Type Parameters:
T- Nominal parameter for target type- Parameters:
n- Tree to convertvalueType- Java target value type to convert content to- Returns:
- Converted value instance
- Throws:
JsonProcessingException- if structural conversion fails
-
treeToValue
public <T> T treeToValue(TreeNode n, JavaType valueType) throws JsonProcessingException
Same astreeToValue(TreeNode, Class)but with type-resolved target value type.- Throws:
JsonProcessingException- Since:
- 2.13
-
writeValue
public void writeValue(JsonGenerator gen, Object value) throws IOException
Description copied from class:ObjectCodecMethod to serialize given Java Object, using generator provided.- Specified by:
writeValuein classObjectCodec- Parameters:
gen- Generator to use for serializing valuevalue- Value to serialize- Throws:
IOException- for low-level write issues, orJsonGenerationExceptionfor decoding problems
-
_bind
protected Object _bind(JsonParser p, Object valueToUpdate) throws IOException
Actual implementation of value reading+binding operation.- Throws:
IOException
-
_bindAndClose
protected Object _bindAndClose(JsonParser p0) throws IOException
- Throws:
IOException
-
_bindAndCloseAsTree
protected final JsonNode _bindAndCloseAsTree(JsonParser p0) throws IOException
- Throws:
IOException
-
_bindAsTree
protected final JsonNode _bindAsTree(JsonParser p) throws IOException
- Throws:
IOException
-
_bindAsTreeOrNull
protected final JsonNode _bindAsTreeOrNull(JsonParser p) throws IOException
Same as_bindAsTree(com.fasterxml.jackson.core.JsonParser)except end-of-input is reported by returningnull, not "missing node"- Throws:
IOException
-
_bindAndReadValues
protected <T> MappingIterator<T> _bindAndReadValues(JsonParser p) throws IOException
- Throws:
IOException- Since:
- 2.1
-
_considerFilter
protected JsonParser _considerFilter(JsonParser p, boolean multiValue)
Consider filter when creating JsonParser.
-
_verifyNoTrailingTokens
protected final void _verifyNoTrailingTokens(JsonParser p, DeserializationContext ctxt, JavaType bindType) throws IOException
- Throws:
IOException- Since:
- 2.9
-
_detectBindAndClose
protected Object _detectBindAndClose(byte[] src, int offset, int length) throws IOException
- Throws:
IOException
-
_detectBindAndClose
protected Object _detectBindAndClose(DataFormatReaders.Match match, boolean forceClosing) throws IOException
- Throws:
IOException
-
_detectBindAndReadValues
protected <T> MappingIterator<T> _detectBindAndReadValues(DataFormatReaders.Match match, boolean forceClosing) throws IOException
- Throws:
IOException
-
_detectBindAndCloseAsTree
protected JsonNode _detectBindAndCloseAsTree(InputStream in) throws IOException
- Throws:
IOException
-
_reportUnkownFormat
protected void _reportUnkownFormat(DataFormatReaders detector, DataFormatReaders.Match match) throws IOException
Method called to indicate that format detection failed to detect format of given input- Throws:
IOException
-
_verifySchemaType
protected void _verifySchemaType(FormatSchema schema)
- Since:
- 2.2
-
createDeserializationContext
protected DefaultDeserializationContext createDeserializationContext(JsonParser p)
Internal helper method called to create an instance ofDeserializationContextfor deserializing a single root value. Can be overridden if a custom context is needed.
-
createDummyDeserializationContext
protected DefaultDeserializationContext createDummyDeserializationContext()
-
_inputStream
protected InputStream _inputStream(URL src) throws IOException
- Throws:
IOException
-
_inputStream
protected InputStream _inputStream(File f) throws IOException
- Throws:
IOException
-
_reportUndetectableSource
protected void _reportUndetectableSource(Object src) throws StreamReadException
- Throws:
StreamReadException
-
_findRootDeserializer
protected JsonDeserializer<Object> _findRootDeserializer(DeserializationContext ctxt) throws DatabindException
Method called to locate deserializer for the passed root-level value.- Throws:
DatabindException
-
_findTreeDeserializer
protected JsonDeserializer<Object> _findTreeDeserializer(DeserializationContext ctxt) throws DatabindException
- Throws:
DatabindException- Since:
- 2.6
-
_prefetchRootDeserializer
protected JsonDeserializer<Object> _prefetchRootDeserializer(JavaType valueType)
Method called to locate deserializer ahead of time, if permitted by configuration. Method also is NOT to throw an exception if access fails.
-
_jsonNodeType
protected final JavaType _jsonNodeType()
- Since:
- 2.10
-
-