in.abilng.ndjson

Class NdJsonObjectMapper

java.lang.Object

in.abilng.ndjson.NdJsonObjectMapper

public class NdJsonObjectMapper
extends Object

Constructor Summary

Constructors

Constructor and Description
NdJsonObjectMapper() Default constructor, which will construct the default JsonFactory as necessary, use SerializerProvider as its SerializerProvider, and BeanSerializerFactory as its SerializerFactory.
NdJsonObjectMapper(com.fasterxml.jackson.core.JsonFactory jf) Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators.
NdJsonObjectMapper(com.fasterxml.jackson.core.JsonFactory jf, com.fasterxml.jackson.databind.ser.DefaultSerializerProvider sp, com.fasterxml.jackson.databind.deser.DefaultDeserializationContext dc) Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators, and uses given providers for accessing serializers and deserializers.

Method Summary

Modifier and Type	Method and Description
<T> Stream<T>	readValue(InputStream in, Class<T> valueType) Method to deserialize JSON Stream into Stream of Java type, reference to which is passed as argument.
<T> List<T>	readValueAsList(InputStream in, Class<T> valueType) Method to deserialize JSON Stream into List of Java type, reference to which is passed as argument.
NdJsonObjectMapper	registerModule(com.fasterxml.jackson.databind.Module module) Method for registering a module that can extend functionality provided by this mapper; for example, by adding providers for custom serializers and deserializers.
NdJsonObjectMapper	registerModules(com.fasterxml.jackson.databind.Module... modules) Convenience method for registering specified modules in order; functionally equivalent to:
void	writeValue(OutputStream out, List<Object> value) Method that can be used to serialize any Java List of value as JSON output, written to OutputStream provided.
void	writeValue(OutputStream out, Stream<Object> value) Method that can be used to serialize any Java Stream of value as JSON output, written to OutputStream provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NdJsonObjectMapper

public NdJsonObjectMapper()

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

NdJsonObjectMapper

public NdJsonObjectMapper(com.fasterxml.jackson.core.JsonFactory jf)

Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators.

Parameters:

jf - JsonFactory to use: if null, a new MappingJsonFactory will be constructed

NdJsonObjectMapper

public NdJsonObjectMapper(com.fasterxml.jackson.core.JsonFactory jf,
                          com.fasterxml.jackson.databind.ser.DefaultSerializerProvider sp,
                          com.fasterxml.jackson.databind.deser.DefaultDeserializationContext dc)

Constructs instance that uses specified JsonFactory for constructing necessary JsonParsers and/or JsonGenerators, and uses given providers for accessing serializers and deserializers.

Parameters:

jf - JsonFactory to use: if null, a new MappingJsonFactory will be constructed

sp - SerializerProvider to use: if null, a SerializerProvider will be constructed

dc - Blueprint deserialization context instance to use for creating actual context objects; if null, will construct standard DeserializationContext

Method Detail

registerModule

public NdJsonObjectMapper registerModule(com.fasterxml.jackson.databind.Module module)

Method for registering a module that can extend functionality provided by this mapper; for example, by adding providers for custom serializers and deserializers.

Parameters:

module - Module to register

Returns:

NdJsonObjectMapper

registerModules

public NdJsonObjectMapper registerModules(com.fasterxml.jackson.databind.Module... modules)

Convenience method for registering specified modules in order; functionally equivalent to:

 for (Module module : modules) {
        registerModule(module);
 }
 

Parameters:

modules - Modules to register

Returns:

NdJsonObjectMapper

readValue

public <T> Stream<T> readValue(InputStream in,
                               Class<T> valueType)
                        throws NdJsonRunTimeException,
                               com.fasterxml.jackson.core.JsonParseException,
                               com.fasterxml.jackson.databind.JsonMappingException

Method to deserialize JSON Stream into Stream of Java type, reference to which is passed as argument.

Type Parameters:

T - The expected class of the Object.

Parameters:

in - Input Stream

valueType - Class of Object

Returns:

Stream of Objects

Throws:

NdJsonRunTimeException - if a low-level I/O problem (unexpected end-of-input, network error) occurs (passed through as-is without additional wrapping

com.fasterxml.jackson.core.JsonParseException - if underlying input contains invalid content of type JsonParser supports (JSON for default case)

com.fasterxml.jackson.databind.JsonMappingException - if the input JSON structure does not match structure expected for result type (or has other mismatch issues)

readValueAsList

public <T> List<T> readValueAsList(InputStream in,
                                   Class<T> valueType)
                            throws NdJsonRunTimeException,
                                   com.fasterxml.jackson.core.JsonParseException,
                                   com.fasterxml.jackson.databind.JsonMappingException

Method to deserialize JSON Stream into List of Java type, reference to which is passed as argument.

Type Parameters:

T - The expected class of the Object.

Parameters:

in - Input Stream

valueType - Class of Object

Returns:

List of Objects

Throws:

NdJsonRunTimeException - if a low-level I/O problem (unexpected end-of-input, network error) occurs (passed through as-is without additional wrapping

com.fasterxml.jackson.core.JsonParseException - if underlying input contains invalid content of type JsonParser supports (JSON for default case)

com.fasterxml.jackson.databind.JsonMappingException - if the input JSON structure does not match structure expected for result type (or has other mismatch issues)

writeValue

public void writeValue(OutputStream out,
                       Stream<Object> value)
                throws NdJsonRunTimeException,
                       com.fasterxml.jackson.core.JsonGenerationException,
                       com.fasterxml.jackson.databind.JsonMappingException

Method that can be used to serialize any Java Stream of value as JSON output, written to OutputStream provided.

Parameters:

out - Output Stream

value - Stream of Java Objects

Throws:

NdJsonRunTimeException - if a low-level I/O problem (unexpected end-of-input, network error) occurs (passed through as-is without additional wrapping

com.fasterxml.jackson.core.JsonGenerationException - Exception type for exceptions during JSON writing, such as trying to output content in wrong context

com.fasterxml.jackson.databind.JsonMappingException - if any fatal problems with mapping of content.

writeValue

public void writeValue(OutputStream out,
                       List<Object> value)
                throws NdJsonRunTimeException,
                       com.fasterxml.jackson.core.JsonGenerationException,
                       com.fasterxml.jackson.databind.JsonMappingException

Method that can be used to serialize any Java List of value as JSON output, written to OutputStream provided.

Parameters:

out - Output Stream

value - List of Java Objects

Throws:

NdJsonRunTimeException - if a low-level I/O problem (unexpected end-of-input, network error) occurs (passed through as-is without additional wrapping

com.fasterxml.jackson.core.JsonGenerationException - Exception type for exceptions during JSON writing, such as trying to output content in wrong context

com.fasterxml.jackson.databind.JsonMappingException - if any fatal problems with mapping of content.