org.boon.json

Interface ObjectMapper

All Known Implementing Classes:

ObjectMapperImpl

public interface ObjectMapper

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	fromJson(byte[] bytes)
<T> T	fromJson(byte[] bytes, Class<T> clazz)
Object	fromJson(char[] chars)
<T> T	fromJson(char[] chars, Class<T> clazz)
Object	fromJson(InputStream reader)
<T> T	fromJson(InputStream reader, Class<T> clazz)
Object	fromJson(Reader reader)
<T> T	fromJson(Reader reader, Class<T> clazz)
Object	fromJson(String json)
<T> T	fromJson(String json, Class<T> clazz)
JsonParserAndMapper	parser()
<T extends Collection<C>,C> T	readValue(byte[] src, Charset charset, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T> T	readValue(byte[] src, Class<T> valueType) Method to deserialize JSON content into a non-container type typically a bean or wrapper type.
<T extends Collection<C>,C> T	readValue(byte[] src, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T> T	readValue(char[] src, Class<T> valueType) Method to deserialize JSON content into a non-container type typically a bean or wrapper type.
<T extends Collection<C>,C> T	readValue(char[] src, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T> T	readValue(File src, Class<T> valueType) Method to deserialize JSON content into a non-container type typically a bean or wrapper type.
<T extends Collection<C>,C> T	readValue(File src, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T extends Collection<C>,C> T	readValue(InputStream src, Charset charset, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T> T	readValue(InputStream src, Class<T> valueType) Method to deserialize JSON content into a non-container type typically a bean or wrapper type.
<T extends Collection<C>,C> T	readValue(InputStream src, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T> T	readValue(Reader src, Class<T> valueType) Method to deserialize JSON content into a non-container type typically a bean or wrapper type.
<T extends Collection<C>,C> T	readValue(Reader src, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
<T> T	readValue(String src, Class<T> valueType) Method to deserialize JSON content into a non-container type typically a bean or wrapper type.
<T extends Collection<C>,C> T	readValue(String src, Class<T> valueType, Class<C> componentType) Method to deserialize JSON content into a container like Set or List.
JsonSerializer	serializer()
String	toJson(Object value)
void	toJson(Object value, Appendable appendable)
void	writeValue(File dest, Object value) Method that can be used to serialize any Java value as JSON output, written to File provided.
void	writeValue(OutputStream dest, Object value) Method that can be used to serialize any Java value as JSON output, using output stream provided (using encoding UTF8.
void	writeValue(Writer dest, Object value) Method that can be used to serialize any Java value as JSON output, using Writer provided.
byte[]	writeValueAsBytes(Object value) Method that can be used to serialize any Java value as a byte array.
byte[]	writeValueAsBytes(Object value, Charset charset) Method that can be used to serialize any Java value as a byte array.
char[]	writeValueAsCharArray(Object value) Method that can be used to serialize any Java value as a char[].
String	writeValueAsString(Object value) Method that can be used to serialize any Java value as a String.

Method Detail

readValue

<T> T readValue(String src,
              Class<T> valueType)

Method to deserialize JSON content into a non-container type typically a bean or wrapper type.

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

readValue

<T> T readValue(File src,
              Class<T> valueType)

Method to deserialize JSON content into a non-container type typically a bean or wrapper type.

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

readValue

<T> T readValue(byte[] src,
              Class<T> valueType)

Method to deserialize JSON content into a non-container type typically a bean or wrapper type.

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

readValue

<T> T readValue(char[] src,
              Class<T> valueType)

Method to deserialize JSON content into a non-container type typically a bean or wrapper type.

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

readValue

<T> T readValue(Reader src,
              Class<T> valueType)

Method to deserialize JSON content into a non-container type typically a bean or wrapper type.

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

readValue

<T> T readValue(InputStream src,
              Class<T> valueType)

Method to deserialize JSON content into a non-container type typically a bean or wrapper type.

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

readValue

<T extends Collection<C>,C> T readValue(String src,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(File src,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(byte[] src,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(char[] src,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(Reader src,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(InputStream src,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(byte[] src,
                                      Charset charset,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

readValue

<T extends Collection<C>,C> T readValue(InputStream src,
                                      Charset charset,
                                      Class<T> valueType,
                                      Class<C> componentType)

Method to deserialize JSON content into a container like Set or List.

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

writeValue

void writeValue(File dest,
              Object value)

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

writeValue

void writeValue(OutputStream dest,
              Object value)

Method that can be used to serialize any Java value as JSON output, using output stream provided (using encoding UTF8.

Note: method does not close the underlying stream explicitly here.

writeValue

void writeValue(Writer dest,
              Object value)

Method that can be used to serialize any Java value as JSON output, using Writer provided.

Note: method does not close the underlying stream explicitly here.

writeValueAsString

String writeValueAsString(Object value)

Method that can be used to serialize any Java value as a String. Functionally equivalent to calling writeValue(Writer,Object) with StringWriter and constructing String, but more efficient.

writeValueAsCharArray

char[] writeValueAsCharArray(Object value)

Method that can be used to serialize any Java value as a char[]. Functionally equivalent to calling writeValue(Writer,Object) with StringWriter and constructing String, but more efficient.

writeValueAsBytes

byte[] writeValueAsBytes(Object value)

Method that can be used to serialize any Java value as a byte array. Encoding used will be UTF-8.

writeValueAsBytes

byte[] writeValueAsBytes(Object value,
                       Charset charset)

Method that can be used to serialize any Java value as a byte array.

parser

JsonParserAndMapper parser()

serializer

JsonSerializer serializer()

toJson

String toJson(Object value)

toJson

void toJson(Object value,
          Appendable appendable)

fromJson

<T> T fromJson(String json,
             Class<T> clazz)

fromJson

<T> T fromJson(byte[] bytes,
             Class<T> clazz)

fromJson

<T> T fromJson(char[] chars,
             Class<T> clazz)

fromJson

<T> T fromJson(Reader reader,
             Class<T> clazz)

fromJson

<T> T fromJson(InputStream reader,
             Class<T> clazz)

fromJson

Object fromJson(String json)

fromJson

Object fromJson(Reader reader)

fromJson

Object fromJson(byte[] bytes)

fromJson

Object fromJson(char[] chars)

fromJson

Object fromJson(InputStream reader)