Package io.ebean.text.json
Interface JsonContext
public interface JsonContext
Converts objects to and from JSON format.
-
Method Summary
Modifier and Type Method 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.JsonGeneratorcreateGenerator(Writer writer)Create and return a new JsonGenerator for the given writer.com.fasterxml.jackson.core.JsonParsercreateParser(Reader reader)Create and return a new JsonParser for the given reader.booleanisSupportedType(Type genericType)Return true if the type is known as an Entity bean or a List Set or Map of entity beans.<T> TtoBean(Class<T> cls, com.fasterxml.jackson.core.JsonParser parser)Convert json parser input into a Bean of a specific type.<T> TtoBean(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> TtoBean(Class<T> rootType, Reader json)Convert json reader input into a Bean of a specific type.<T> TtoBean(Class<T> rootType, Reader json, JsonReadOptions options)Convert json reader input into a Bean of a specific type additionally using JsonReadOptions.<T> TtoBean(Class<T> rootType, String json)Convert json string input into a Bean of a specific type.<T> TtoBean(Class<T> rootType, String json, JsonReadOptions options)Convert json string input into a Bean of a specific type additionally using JsonReadOptions.StringtoJson(Object value)Return the bean or collection as JSON string.voidtoJson(Object value, com.fasterxml.jackson.core.JsonGenerator generator)Write the bean or collection to the JsonGenerator.voidtoJson(Object value, com.fasterxml.jackson.core.JsonGenerator generator, FetchPath fetchPath)Write the bean or collection to the JsonGenerator using the FetchPath.voidtoJson(Object value, com.fasterxml.jackson.core.JsonGenerator generator, JsonWriteOptions options)Deprecated in favour of using PathProperties by itself.StringtoJson(Object value, FetchPath fetchPath)Return the bean or collection as JSON string using FetchPath.StringtoJson(Object value, JsonWriteOptions options)Deprecated in favour of using PathProperties by itself.voidtoJson(Object value, Writer writer)Write the bean or collection in JSON format to the writer.voidtoJson(Object value, Writer writer, FetchPath fetchPath)Write the bean or collection as json to the writer using the FetchPath.voidtoJson(Object value, Writer writer, JsonWriteOptions options)Deprecated in favour of using PathProperties by itself.StringtoJsonPretty(Object value)Return the bean or collection as JSON string in pretty format.<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.ObjecttoObject(Type genericType, com.fasterxml.jackson.core.JsonParser jsonParser)Use the genericType to determine if this should be converted into a List or bean.ObjecttoObject(Type genericType, Reader json)Use the genericType to determine if this should be converted into a List or bean.ObjecttoObject(Type genericType, String json)Use the genericType to determine if this should be converted into a List or bean.voidwriteScalar(com.fasterxml.jackson.core.JsonGenerator generator, Object scalarValue)Write a scalar types known to Ebean to Jackson.
-
Method Details
-
toBean
Convert json string input into a Bean of a specific type.- Throws:
JsonIOException- When IOException occurs
-
toBean
Convert json string input into a Bean of a specific type additionally using JsonReadOptions.- Throws:
JsonIOException- When IOException occurs
-
toBean
Convert json reader input into a Bean of a specific type.- Throws:
JsonIOException- When IOException occurs
-
toBean
Convert json reader input into a Bean of a specific type additionally using JsonReadOptions.- Throws:
JsonIOException- When IOException occurs
-
toBean
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 JsonIOExceptionConvert 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 JsonIOExceptionCreate 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 JsonIOExceptionCreate 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
Convert json string input into a list of beans of a specific type.- Throws:
JsonIOException- When IOException occurs
-
toList
Convert json string input into a list of beans of a specific type additionally using JsonReadOptions.- Throws:
JsonIOException- When IOException occurs
-
toList
Convert json reader input into a list of beans of a specific type.- Throws:
JsonIOException- When IOException occurs
-
toList
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 JsonIOExceptionConvert 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 JsonIOExceptionConvert json parser input into a list of beans of a specific type additionally using JsonReadOptions.- Throws:
JsonIOException- When IOException occurs
-
toObject
Use the genericType to determine if this should be converted into a List or bean.- Throws:
JsonIOException- When IOException occurs
-
toObject
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 JsonIOExceptionUse the genericType to determine if this should be converted into a List or bean.- Throws:
JsonIOException- When IOException occurs
-
toJson
Return the bean or collection as JSON string.- Throws:
JsonIOException- When IOException occurs
-
toJsonPretty
Return the bean or collection as JSON string in pretty format.- Throws:
JsonIOException- When IOException occurs
-
toJson
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 JsonIOExceptionWrite the bean or collection to the JsonGenerator.- Throws:
JsonIOException- When IOException occurs
-
toJson
Return the bean or collection as JSON string using FetchPath.- Throws:
JsonIOException- When IOException occurs
-
toJson
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 JsonIOExceptionWrite 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 JsonIOExceptionDeprecated in favour of using PathProperties by itself. Write json to the JsonGenerator using the JsonWriteOptions.- Throws:
JsonIOException
-
toJson
Deprecated in favour of using PathProperties by itself. With additional options.- Throws:
JsonIOException- When IOException occurs
-
toJson
Deprecated in favour of using PathProperties by itself. Convert a bean or collection to json string.- Throws:
JsonIOException- When IOException occurs
-
isSupportedType
Return true if the type is known as an Entity bean or a List Set or Map of entity beans. -
createGenerator
Create and return a new JsonGenerator for the given writer.- Throws:
JsonIOException- When IOException occurs
-
createParser
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 IOExceptionWrite 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
-