io.ebean.text.json

Interface JsonContext

public interface JsonContext

Converts objects to and from JSON format.

Method Summary

Modifier and Type	Method and Description
<T> JsonBeanReader<T>	createBeanReader(BeanType<T> beanType, com.fasterxml.jackson.core.JsonParser parser, JsonReadOptions options) Create and return a new bean reading for the bean type given the JSON options and source.
<T> JsonBeanReader<T>	createBeanReader(Class<T> cls, com.fasterxml.jackson.core.JsonParser parser, JsonReadOptions options) Create and return a new bean reading for the bean type given the JSON options and source.
com.fasterxml.jackson.core.JsonGenerator	createGenerator(Writer writer) Create and return a new JsonGenerator for the given writer.
com.fasterxml.jackson.core.JsonParser	createParser(Reader reader) Create and return a new JsonParser for the given reader.
boolean	isSupportedType(Type genericType) Return true if the type is known as an Entity bean or a List Set or Map of entity beans.
<T> T	toBean(Class<T> cls, com.fasterxml.jackson.core.JsonParser parser) Convert json parser input into a Bean of a specific type.
<T> T	toBean(Class<T> cls, com.fasterxml.jackson.core.JsonParser parser, JsonReadOptions options) Convert json parser input into a Bean of a specific type additionally using JsonReadOptions..
<T> T	toBean(Class<T> rootType, Reader json) Convert json reader input into a Bean of a specific type.
<T> T	toBean(Class<T> rootType, Reader json, JsonReadOptions options) Convert json reader input into a Bean of a specific type additionally using JsonReadOptions.
<T> T	toBean(Class<T> rootType, String json) Convert json string input into a Bean of a specific type.
<T> T	toBean(Class<T> rootType, String json, JsonReadOptions options) Convert json string input into a Bean of a specific type additionally using JsonReadOptions.
String	toJson(Object value) Return the bean or collection as JSON string.
String	toJson(Object value, FetchPath fetchPath) Return the bean or collection as JSON string using FetchPath.
void	toJson(Object value, com.fasterxml.jackson.core.JsonGenerator generator) Write the bean or collection to the JsonGenerator.
void	toJson(Object value, com.fasterxml.jackson.core.JsonGenerator generator, FetchPath fetchPath) Write the bean or collection to the JsonGenerator using the FetchPath.
void	toJson(Object value, com.fasterxml.jackson.core.JsonGenerator generator, JsonWriteOptions options) Deprecated in favour of using PathProperties by itself.
String	toJson(Object value, JsonWriteOptions options) Deprecated in favour of using PathProperties by itself.
void	toJson(Object value, Writer writer) Write the bean or collection in JSON format to the writer.
void	toJson(Object value, Writer writer, FetchPath fetchPath) Write the bean or collection as json to the writer using the FetchPath.
void	toJson(Object value, Writer writer, JsonWriteOptions options) Deprecated in favour of using PathProperties by itself.
<T> List<T>	toList(Class<T> cls, com.fasterxml.jackson.core.JsonParser json) Convert json parser input into a list of beans of a specific type.
<T> List<T>	toList(Class<T> cls, com.fasterxml.jackson.core.JsonParser json, JsonReadOptions options) Convert json parser input into a list of beans of a specific type additionally using JsonReadOptions.
<T> List<T>	toList(Class<T> rootType, Reader json) Convert json reader input into a list of beans of a specific type.
<T> List<T>	toList(Class<T> rootType, Reader json, JsonReadOptions options) Convert json reader input into a list of beans of a specific type additionally using JsonReadOptions.
<T> List<T>	toList(Class<T> rootType, String json) Convert json string input into a list of beans of a specific type.
<T> List<T>	toList(Class<T> rootType, String json, JsonReadOptions options) Convert json string input into a list of beans of a specific type additionally using JsonReadOptions.
Object	toObject(Type genericType, com.fasterxml.jackson.core.JsonParser jsonParser) Use the genericType to determine if this should be converted into a List or bean.
Object	toObject(Type genericType, Reader json) Use the genericType to determine if this should be converted into a List or bean.
Object	toObject(Type genericType, String json) Use the genericType to determine if this should be converted into a List or bean.
void	writeScalar(com.fasterxml.jackson.core.JsonGenerator generator, Object scalarValue) Write a scalar types known to Ebean to Jackson.

Method Detail

toBean

<T> T toBean(Class<T> rootType,
             String json)
      throws JsonIOException

Convert json string input into a Bean of a specific type.

Throws:

JsonIOException - When IOException occurs

toBean

<T> T toBean(Class<T> rootType,
             String json,
             JsonReadOptions options)
      throws JsonIOException

Convert json string input into a Bean of a specific type additionally using JsonReadOptions.

Throws:

JsonIOException - When IOException occurs

toBean

<T> T toBean(Class<T> rootType,
             Reader json)
      throws JsonIOException

Convert json reader input into a Bean of a specific type.

Throws:

JsonIOException - When IOException occurs

toBean

<T> T toBean(Class<T> rootType,
             Reader json,
             JsonReadOptions options)
      throws JsonIOException

Convert json reader input into a Bean of a specific type additionally using JsonReadOptions.

Throws:

JsonIOException - When IOException occurs

toBean

<T> T toBean(Class<T> cls,
             com.fasterxml.jackson.core.JsonParser parser)
      throws JsonIOException

Convert json parser input into a Bean of a specific type.

Throws:

JsonIOException - When IOException occurs

toBean

<T> T toBean(Class<T> cls,
             com.fasterxml.jackson.core.JsonParser parser,
             JsonReadOptions options)
      throws JsonIOException

Convert json parser input into a Bean of a specific type additionally using JsonReadOptions..

Throws:

JsonIOException - When IOException occurs

createBeanReader

<T> JsonBeanReader<T> createBeanReader(Class<T> cls,
                                       com.fasterxml.jackson.core.JsonParser parser,
                                       JsonReadOptions options)
                                throws JsonIOException

Create and return a new bean reading for the bean type given the JSON options and source.

Note that JsonOption provides an option for setting a persistence context and also enabling further lazy loading. Further lazy loading requires a persistence context so if that is set on then a persistence context is created if there is not one set.

Throws:

JsonIOException

createBeanReader

<T> JsonBeanReader<T> createBeanReader(BeanType<T> beanType,
                                       com.fasterxml.jackson.core.JsonParser parser,
                                       JsonReadOptions options)
                                throws JsonIOException

Create and return a new bean reading for the bean type given the JSON options and source.

Note that JsonOption provides an option for setting a persistence context and also enabling further lazy loading. Further lazy loading requires a persistence context so if that is set on then a persistence context is created if there is not one set.

Throws:

JsonIOException

toList

<T> List<T> toList(Class<T> rootType,
                   String json)
            throws JsonIOException

Convert json string input into a list of beans of a specific type.

Throws:

JsonIOException - When IOException occurs

toList

<T> List<T> toList(Class<T> rootType,
                   String json,
                   JsonReadOptions options)
            throws JsonIOException

Convert json string input into a list of beans of a specific type additionally using JsonReadOptions.

Throws:

JsonIOException - When IOException occurs

toList

<T> List<T> toList(Class<T> rootType,
                   Reader json)
            throws JsonIOException

Convert json reader input into a list of beans of a specific type.

Throws:

JsonIOException - When IOException occurs

toList

<T> List<T> toList(Class<T> rootType,
                   Reader json,
                   JsonReadOptions options)
            throws JsonIOException

Convert json reader input into a list of beans of a specific type additionally using JsonReadOptions.

Throws:

JsonIOException - When IOException occurs

toList

<T> List<T> toList(Class<T> cls,
                   com.fasterxml.jackson.core.JsonParser json)
            throws JsonIOException

Convert json parser input into a list of beans of a specific type.

Throws:

JsonIOException - When IOException occurs

toList

<T> List<T> toList(Class<T> cls,
                   com.fasterxml.jackson.core.JsonParser json,
                   JsonReadOptions options)
            throws JsonIOException

Convert json parser input into a list of beans of a specific type additionally using JsonReadOptions.

Throws:

JsonIOException - When IOException occurs

toObject

Object toObject(Type genericType,
                Reader json)
         throws JsonIOException

Use the genericType to determine if this should be converted into a List or bean.

Throws:

JsonIOException - When IOException occurs

toObject

Object toObject(Type genericType,
                String json)
         throws JsonIOException

Use the genericType to determine if this should be converted into a List or bean.

Throws:

JsonIOException - When IOException occurs

toObject

Object toObject(Type genericType,
                com.fasterxml.jackson.core.JsonParser jsonParser)
         throws JsonIOException

Use the genericType to determine if this should be converted into a List or bean.

Throws:

JsonIOException - When IOException occurs

toJson

String toJson(Object value)
       throws JsonIOException

Return the bean or collection as JSON string.

Throws:

JsonIOException - When IOException occurs

toJson

void toJson(Object value,
            Writer writer)
     throws JsonIOException

Write the bean or collection in JSON format to the writer.

Throws:

JsonIOException - When IOException occurs

toJson

void toJson(Object value,
            com.fasterxml.jackson.core.JsonGenerator generator)
     throws JsonIOException

Write the bean or collection to the JsonGenerator.

Throws:

JsonIOException - When IOException occurs

toJson

String toJson(Object value,
              FetchPath fetchPath)
       throws JsonIOException

Return the bean or collection as JSON string using FetchPath.

Throws:

JsonIOException - When IOException occurs

toJson

void toJson(Object value,
            Writer writer,
            FetchPath fetchPath)
     throws JsonIOException

Write the bean or collection as json to the writer using the FetchPath.

Throws:

JsonIOException

toJson

void toJson(Object value,
            com.fasterxml.jackson.core.JsonGenerator generator,
            FetchPath fetchPath)
     throws JsonIOException

Write the bean or collection to the JsonGenerator using the FetchPath.

Throws:

JsonIOException

toJson

void toJson(Object value,
            com.fasterxml.jackson.core.JsonGenerator generator,
            JsonWriteOptions options)
     throws JsonIOException

Deprecated in favour of using PathProperties by itself. Write json to the JsonGenerator using the JsonWriteOptions.

Throws:

JsonIOException

toJson

void toJson(Object value,
            Writer writer,
            JsonWriteOptions options)
     throws JsonIOException

Deprecated in favour of using PathProperties by itself. With additional options.

Throws:

JsonIOException - When IOException occurs

toJson

String toJson(Object value,
              JsonWriteOptions options)
       throws JsonIOException

Deprecated in favour of using PathProperties by itself. Convert a bean or collection to json string.

Throws:

JsonIOException - When IOException occurs

isSupportedType

boolean isSupportedType(Type genericType)

Return true if the type is known as an Entity bean or a List Set or Map of entity beans.

createGenerator

com.fasterxml.jackson.core.JsonGenerator createGenerator(Writer writer)
                                                  throws JsonIOException

Create and return a new JsonGenerator for the given writer.

Throws:

JsonIOException - When IOException occurs

createParser

com.fasterxml.jackson.core.JsonParser createParser(Reader reader)
                                            throws JsonIOException

Create and return a new JsonParser for the given reader.

Throws:

JsonIOException - When IOException occurs

writeScalar

void writeScalar(com.fasterxml.jackson.core.JsonGenerator generator,
                 Object scalarValue)
          throws IOException

Write a scalar types known to Ebean to Jackson.

Ebean has built in support for java8 and Joda types as well as the other standard JDK types like URI, URL, UUID etc. This is a fast simple way to write any of those types to Jackson.

Throws:

IOException