Jackson 2.18.2 · com.fasterxml.jackson.databind.ObjectReader

Modifier and Type	Field and Description
protected final DeserializationConfig	_config General serialization configuration settings; while immutable, can use copy-constructor to create modified instances as necessary.
protected final DefaultDeserializationContext	_context Blueprint instance of deserialization context; used for creating actual instance when needed.
protected final DataFormatReaders	_dataFormatReaders Optional detector used for auto-detecting data format that byte-based input uses.
private final TokenFilter	_filter Filter to be consider for JsonParser.
protected final InjectableValues	_injectableValues Values that can be injected during deserialization, if any.
protected transient JavaType	_jsonNodeType Lazily resolved `JavaType` for `JsonNode`
protected final JsonFactory	_parserFactory Factory used for constructing `JsonGenerator`s
protected final JsonDeserializer<Object>	_rootDeserializer We may pre-fetch deserializer as soon as `_valueType` is known, and if so, reuse it afterwards.
protected final ConcurrentHashMap<JavaType, JsonDeserializer<Object>>	_rootDeserializers Root-level cached deserializers.
protected final FormatSchema	_schema When using data format that uses a schema, schema is passed to parser.
protected final boolean	_unwrapRoot Flag that indicates whether root values are expected to be unwrapped or not
protected final Object	_valueToUpdate Instance to update with data binding; if any.
protected final JavaType	_valueType Declared type of value to instantiate during deserialization.
private static final long	serialVersionUID

Access	Constructor and Description
protected	ObjectReader(ObjectMapper mapper, DeserializationConfig config) Constructor used by `ObjectMapper` for initial instantiation
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.
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.
protected	ObjectReader(ObjectReader base, DeserializationConfig config) Copy constructor used when modifying simple feature flags
protected	ObjectReader(ObjectReader base, JsonFactory f)
protected	ObjectReader(ObjectReader base, TokenFilter filter)

Method Summary

Modifier and Type	Method and Description
protected final 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 final JsonNode	_bindAndCloseAsTree(JsonParser p0)
protected <T> MappingIterator<T>	_bindAndReadValues(JsonParser p)
protected final JsonNode	_bindAsTree(JsonParser p)
protected final JsonNode	_bindAsTreeOrNull(JsonParser p) Same as `_bindAsTree` except end-of-input is reported by returning `null`, not "missing node"
protected JsonParser	_considerFilter(final 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` 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(URL src)
protected InputStream	_inputStream(File f)
protected final JavaType	_jsonNodeType()
protected ObjectReader	_new(ObjectReader base, JsonFactory f) Overridable factory method called by various "withXxx()" methods
protected ObjectReader	_new(ObjectReader base, DeserializationConfig config) Overridable factory method called by various "withXxx()" methods
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
protected <T> MappingIterator<T>	_newIterator(JsonParser p, DeserializationContext ctxt, JsonDeserializer<?> deser, boolean parserManaged) Factory method used to create `MappingIterator` instances; 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 input
protected final void	_verifyNoTrailingTokens(JsonParser p, DeserializationContext ctxt, JavaType bindType)
protected void	_verifySchemaType(FormatSchema schema)
protected ObjectReader	_with(DeserializationConfig newConfig)
public ObjectReader	at(final String pointerExpr) Convenience method to bind from `JsonPointer`.
public ObjectReader	at(final JsonPointer pointer) Convenience method to bind from `JsonPointer` `JsonPointerBasedFilter` is registered and will be used for parsing later.
public JsonNode	createArrayNode() Implements abstract com.fasterxml.jackson.core.ObjectCodec.createArrayNode. Method for construct root level Array nodes for Tree Model instances.
protected DefaultDeserializationContext	createDeserializationContext(JsonParser p) Internal helper method called to create an instance of `DeserializationContext` for deserializing a single root value.
protected DefaultDeserializationContext	createDummyDeserializationContext()
public JsonParser	createNonBlockingByteArrayParser() Factory method for constructing properly initialized `JsonParser` to read content using non-blocking (asynchronous) mode.
public JsonNode	createObjectNode() Implements abstract com.fasterxml.jackson.core.ObjectCodec.createObjectNode. Method for construct root level Object nodes for Tree Model instances.
public JsonParser	createParser(File src) Factory method for constructing properly initialized `JsonParser` to read content from specified `File`.
public JsonParser	createParser(URL src) Factory method for constructing properly initialized `JsonParser` to read content from specified `File`.
public JsonParser	createParser(InputStream in) Factory method for constructing properly initialized `JsonParser` to read content using specified `InputStream`.
public JsonParser	createParser(Reader r) Factory method for constructing properly initialized `JsonParser` to read content using specified `Reader`.
public JsonParser	createParser(byte[] content) Factory method for constructing properly initialized `JsonParser` to read content from specified byte array.
public JsonParser	createParser(byte[] content, int offset, int len) Factory method for constructing properly initialized `JsonParser` to read content from specified byte array.
public JsonParser	createParser(String content) Factory method for constructing properly initialized `JsonParser` to read content from specified String.
public JsonParser	createParser(char[] content) Factory method for constructing properly initialized `JsonParser` to 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.
public JsonParser	createParser(char[] content, int offset, int len) Factory method for constructing properly initialized `JsonParser` to read content from specified character array.
public JsonParser	createParser(DataInput content) Factory method for constructing properly initialized `JsonParser` to read content using specified `DataInput`.
public ObjectReader	forType(JavaType valueType) Method for constructing a new reader instance that is configured to data bind into specified type.
public ObjectReader	forType(Class<?> valueType) Method for constructing a new reader instance that is configured to data bind into specified type.
public ObjectReader	forType(Type valueType) Method for constructing a new reader instance that is configured to data bind into specified type.
public ObjectReader	forType(TypeReference<?> valueTypeRef) Method for constructing a new reader instance that is configured to data bind into specified type.
public ContextAttributes	getAttributes()
public DeserializationConfig	getConfig()
public JsonFactory	getFactory() Overrides com.fasterxml.jackson.core.ObjectCodec.getFactory. Accessor for finding underlying data format factory (`JsonFactory`) codec will use for data binding.
public InjectableValues	getInjectableValues()
public TypeFactory	getTypeFactory()
public JavaType	getValueType()
public boolean	isEnabled(DeserializationFeature f)
public boolean	isEnabled(MapperFeature f)
public boolean	isEnabled(DatatypeFeature f)
public boolean	isEnabled(JsonParser.Feature f)
public boolean	isEnabled(StreamReadFeature f)
public JsonNode	missingNode() Overrides com.fasterxml.jackson.core.TreeCodec.missingNode.
public JsonNode	nullNode() Overrides com.fasterxml.jackson.core.TreeCodec.nullNode.
public <T extends TreeNode> T	readTree(JsonParser p) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readTree. 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.
public JsonNode	readTree(InputStream src) Method that reads content from given input source, using configuration of this reader, and binds it as JSON Tree.
public JsonNode	readTree(Reader src) Same as `readTree(InputStream)` except content accessed through passed-in `Reader`
public JsonNode	readTree(String json) Same as `readTree(InputStream)` except content read from passed-in `String`
public JsonNode	readTree(byte[] json) Same as `readTree(InputStream)` except content read from passed-in byte array.
public JsonNode	readTree(byte[] json, int offset, int len) Same as `readTree(InputStream)` except content read from passed-in byte array.
public JsonNode	readTree(DataInput src) Same as `readTree(InputStream)` except content read using passed-in `DataInput`.
public <T> T	readValue(JsonParser p) Method that binds content read using given parser, using configuration of this reader, including expected result type.
public <T> T	readValue(JsonParser Parser to use for decoding content to bind p, Class<T> Java value type to bind content to valueType) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readValue. 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).
public <T> T	readValue(JsonParser Parser to use for decoding content to bind p, TypeReference<T> Java value type to bind content to valueTypeRef) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readValue. 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).
public <T> T	readValue(JsonParser Parser to use for decoding content to bind p, ResolvedType Java value type to bind content to valueType) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readValue. 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).
public <T> T	readValue(JsonParser p, JavaType valueType) Type-safe overloaded method, basically alias for `readValue(JsonParser, ResolvedType)`.
public <T> T	readValue(InputStream Source to read content from src) Method that binds content read from given input source, using configuration of this reader.
public <T> T	readValue(InputStream Source to read content from src, Class<T> Target type to bind content to valueType) Same as `readValue(InputStream)` except that target value type overridden as `valueType`
public <T> T	readValue(Reader Source to read content from src) Method that binds content read from given input source, using configuration of this reader.
public <T> T	readValue(Reader Source to read content from src, Class<T> Target type to bind content to valueType) Same as `readValue(Reader)` except that target value type overridden as `valueType`
public <T> T	readValue(String String that contains content to read src) Method that binds content read from given JSON string, using configuration of this reader.
public <T> T	readValue(String String that contains content to read src, Class<T> Target type to bind content to valueType) Same as `readValue(String)` except that target value type overridden as `valueType`
public <T> T	readValue(byte[] Byte array that contains encoded content to read content) Method that binds content read from given byte array, using configuration of this reader.
public <T> T	readValue(byte[] Byte array that contains encoded content to read content, Class<T> Target type to bind content to valueType) Same as `readValue(byte[])` except that target value type overridden as `valueType`
public <T> T	readValue(byte[] Byte array that contains encoded content to read buffer, int Offset of the first content byte in `buffer` offset, int Length of content in `buffer`, in bytes length) Method that binds content read from given byte array, using configuration of this reader.
public <T> T	readValue(byte[] Byte array that contains encoded content to read buffer, int Offset of the first content byte in `buffer` offset, int Length of content in `buffer`, in bytes length, Class<T> Target type to bind content to valueType) Same as `readValue(byte[], int, int)` except that target value type overridden as `valueType`
public <T> T	readValue(File File that contains content to read src) Method that binds content read from given `File` using configuration of this reader.
public <T> T	readValue(File File that contains content to read src, Class<T> Target type to bind content to valueType) Same as `readValue(File)` except that target value type overridden as `valueType`
public <T> T	readValue(URL src) Method that binds content read from given input source, using configuration of this reader.
public <T> T	readValue(URL URL pointing to resource that contains content to read src, Class<T> Target type to bind content to valueType) Same as `readValue(URL)` except that target value type overridden as `valueType`
public <T> T	readValue(JsonNode Tree that contains content to convert content) Convenience method for converting results from given JSON tree into given value type.
public <T> T	readValue(JsonNode Tree that contains content to convert content, Class<T> Target type to convert content to valueType) Same as `readValue(JsonNode)` except that target value type overridden as `valueType`
public <T> T	readValue(DataInput src)
public <T> T	readValue(DataInput DataInput that contains content to read content, Class<T> Target type to bind content to valueType) Same as `readValue(DataInput)` except that target value type overridden as `valueType`
public <T> Iterator<T>	readValues(JsonParser Parser to use for decoding content to bind p, Class<T> Java value type to bind content to valueType) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readValues. Convenience method that is equivalent to: withType(valueType).readValues(p);
public <T> Iterator<T>	readValues(JsonParser Parser to use for decoding content to bind p, TypeReference<T> Java value type to bind content to valueTypeRef) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readValues. Convenience method that is equivalent to: withType(valueTypeRef).readValues(p);
public <T> Iterator<T>	readValues(JsonParser Parser to use for decoding content to bind p, ResolvedType Java value type to bind content to valueType) Implements abstract com.fasterxml.jackson.core.ObjectCodec.readValues. Convenience method that is equivalent to: withType(valueType).readValues(p);
public <T> Iterator<T>	readValues(JsonParser p, JavaType valueType) Convenience method that is equivalent to: withType(valueType).readValues(p);
public <T> MappingIterator<T>	readValues(JsonParser p) Method for reading sequence of Objects from parser stream.
public <T> MappingIterator<T>	readValues(InputStream src) Method for reading sequence of Objects from parser stream.
public <T> MappingIterator<T>	readValues(Reader src) Overloaded version of `readValue(InputStream)`.
public <T> MappingIterator<T>	readValues(String String that contains JSON content to parse json) Overloaded version of `readValue(InputStream)`.
public <T> MappingIterator<T>	readValues(byte[] src, int offset, int length) Overloaded version of `readValue(InputStream)`.
public final <T> MappingIterator<T>	readValues(byte[] src) Overloaded version of `readValue(InputStream)`.
public <T> MappingIterator<T>	readValues(File src) Overloaded version of `readValue(InputStream)`.
public <T> MappingIterator<T>	readValues(URL URL to read to access JSON content to parse. src) Overloaded version of `readValue(InputStream)`.
public <T> MappingIterator<T>	readValues(DataInput src)
public JsonParser	treeAsTokens(TreeNode Content to traverse over n) Implements abstract com.fasterxml.jackson.core.ObjectCodec.treeAsTokens. Method for constructing a `JsonParser` for reading contents of a JSON tree, as if it was external serialized JSON content.
public <T> T	treeToValue(TreeNode Tree to convert n, Class<T> Java target value type to convert content to valueType) Implements abstract com.fasterxml.jackson.core.ObjectCodec.treeToValue. Convenience method for converting given JSON tree into instance of specified value type.
public <T> T	treeToValue(TreeNode n, JavaType valueType) Same as `treeToValue(TreeNode, Class)` but with type-resolved target value type.
public Version	version() Implements abstract com.fasterxml.jackson.core.ObjectCodec.version. Implements com.fasterxml.jackson.core.Versioned.version. Method that will return version information stored in and read from jar that contains this class.
public ObjectReader	with(DeserializationFeature feature) Method for constructing a new reader instance that is configured with specified feature enabled.
public ObjectReader	with(DeserializationFeature first, DeserializationFeature... other) Method for constructing a new reader instance that is configured with specified features enabled.
public ObjectReader	with(DatatypeFeature feature) Method for constructing a new reader instance that is configured with specified feature enabled.
public ObjectReader	Returns: Reader instance with specified feature enabled with(JsonParser.Feature Feature to enable feature) Method for constructing a new reader instance that is configured with specified feature enabled.
public ObjectReader	Returns: Reader instance with specified feature enabled with(StreamReadFeature feature) Method for constructing a new reader instance that is configured with specified feature enabled.
public ObjectReader	with(FormatFeature feature) Method for constructing a new reader instance that is configured with specified feature enabled.
public ObjectReader	with(DeserializationConfig config) Mutant factory method that will construct a new instance that has specified underlying `DeserializationConfig`.
public ObjectReader	with(InjectableValues injectableValues) Method for constructing a new instance with configuration that uses passed `InjectableValues` to provide injectable values.
public ObjectReader	with(JsonNodeFactory f) Method for constructing a new reader instance with configuration that uses passed `JsonNodeFactory` for constructing `JsonNode` instances.
public ObjectReader	with(JsonFactory f) Method for constructing a new reader instance with configuration that uses passed `JsonFactory` for constructing underlying Readers.
public ObjectReader	with(FormatSchema schema) Method for constructing a new instance with configuration that passes specified `FormatSchema` to `JsonParser` that is constructed for parsing content.
public ObjectReader	with(Locale l)
public ObjectReader	with(TimeZone tz)
public ObjectReader	with(Base64Variant defaultBase64)
public ObjectReader	with(ContextAttributes attrs)
public ObjectReader	withAttribute(Object key, Object value)
public ObjectReader	withAttributes(Map<?, ?> attrs)
public ObjectReader	withFeatures(DeserializationFeature... features) Method for constructing a new reader instance that is configured with specified features enabled.
public ObjectReader	withFeatures(DatatypeFeature... features) Method for constructing a new reader instance that is configured with specified features enabled.
public ObjectReader	Returns: Reader instance with specified features enabled withFeatures(JsonParser.Feature... Features to enable features) Method for constructing a new reader instance that is configured with specified features enabled.
public ObjectReader	withFeatures(FormatFeature... features) Method for constructing a new reader instance that is configured with specified features enabled.
public ObjectReader	Returns: Newly configured writer instance withFormatDetection(ObjectReader... Data formats accepted, in decreasing order of priority (that is, matches checked in listed order, first match wins) readers) Fluent factory method for constructing a reader that will try to auto-detect underlying data format, using specified list of `JsonFactory` instances, and default `DataFormatReaders` settings (for customized `DataFormatReaders`, you can construct instance yourself).
public ObjectReader	Returns: Newly configured writer instance withFormatDetection(DataFormatReaders DataFormatReaders to use for detecting underlying format. readers) Fluent factory method for constructing a reader that will try to auto-detect underlying data format, using specified `DataFormatReaders`.
public ObjectReader	withHandler(DeserializationProblemHandler h)
public ObjectReader	without(DeserializationFeature feature) Method for constructing a new reader instance that is configured with specified feature disabled.
public ObjectReader	without(DeserializationFeature first, DeserializationFeature... other) Method for constructing a new reader instance that is configured with specified features disabled.
public ObjectReader	without(DatatypeFeature feature) Method for constructing a new reader instance that is configured with specified feature disabled.
public ObjectReader	Returns: Reader instance with specified feature disabled without(JsonParser.Feature Feature to disable feature) Method for constructing a new reader instance that is configured with specified feature disabled.
public ObjectReader	Returns: Reader instance with specified feature enabled without(StreamReadFeature feature) Method for constructing a new reader instance that is configured with specified feature disabled.
public ObjectReader	without(FormatFeature feature) Method for constructing a new reader instance that is configured with specified feature disabled.
public ObjectReader	withoutAttribute(Object key)
public ObjectReader	withoutFeatures(DeserializationFeature... features) Method for constructing a new reader instance that is configured with specified features disabled.
public ObjectReader	withoutFeatures(DatatypeFeature... features) Method for constructing a new reader instance that is configured with specified features disabled.
public ObjectReader	Returns: Reader instance with specified features disabled withoutFeatures(JsonParser.Feature... Features to disable features) Method for constructing a new reader instance that is configured with specified features disabled.
public ObjectReader	withoutFeatures(FormatFeature... features) Method for constructing a new reader instance that is configured with specified features disabled.
public ObjectReader	withoutRootName() Convenience method that is same as calling: `withRootName("")` which will forcibly prevent use of root name wrapping when writing values with this `ObjectReader`.
public ObjectReader	withRootName(String rootName) Method for constructing a new instance with configuration that specifies what root name to expect for "root name unwrapping".
public ObjectReader	withRootName(PropertyName rootName)
public ObjectReader	withType(JavaType valueType) Deprecated since 2.5 Use `forType(JavaType)` instead
public ObjectReader	withType(Class<?> valueType) Deprecated since 2.5 Use `forType(Class)` instead
public ObjectReader	withType(Type valueType) Deprecated since 2.5 Use `forType(java.lang.reflect.Type)` instead
public ObjectReader	withType(TypeReference<?> valueTypeRef) Deprecated since 2.5 Use `forType(TypeReference)` instead
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.
public ObjectReader	withView(Class<?> activeView) Method for constructing a new instance with configuration that uses specified View for filtering.
public void	writeTree(JsonGenerator Generator to use for serializing value g, TreeNode Tree to serialize rootNode) Implements abstract com.fasterxml.jackson.core.ObjectCodec.writeTree. Method for serializing JSON content from given Tree instance, using specified generator.
public void	writeValue(JsonGenerator Generator to use for serializing value gen, Object Value to serialize value) Implements abstract com.fasterxml.jackson.core.ObjectCodec.writeValue. Method to serialize given Java Object, using generator provided.

Inherited from com.fasterxml.jackson.core.ObjectCodec:: getJsonFactory

public Class ObjectReader

Field Summary

Constructor Summary

Method Summary