com.bluelinelabs.logansquare

Class LoganSquare

java.lang.Object

com.bluelinelabs.logansquare.LoganSquare

public class LoganSquare
extends java.lang.Object

The point of all interaction with this library.

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.core.JsonFactory	JSON_FACTORY The JsonFactory that should be used throughout the entire app.

Constructor Summary

Constructors

Constructor and Description
LoganSquare()

Method Summary

Modifier and Type	Method and Description
static <E> JsonMapper<E>	mapperFor(java.lang.Class<E> cls) Returns a JsonMapper for a given class that has been annotated with @JsonObject.
static <E> JsonMapper<E>	mapperFor(ParameterizedType<E> type) Returns a JsonMapper for a given class that has been annotated with @JsonObject.
static <E> JsonMapper<E>	mapperFor(ParameterizedType<E> type, SimpleArrayMap<ParameterizedType,JsonMapper> partialMappers)
static <E> E	parse(java.io.InputStream is, java.lang.Class<E> jsonObjectClass) Parse an object from an InputStream.
static <E> E	parse(java.io.InputStream is, ParameterizedType<E> jsonObjectType) Parse a parameterized object from an InputStream.
static <E> E	parse(java.lang.String jsonString, java.lang.Class<E> jsonObjectClass) Parse an object from a String.
static <E> E	parse(java.lang.String jsonString, ParameterizedType<E> jsonObjectType) Parse a parameterized object from a String.
static <E> java.util.List<E>	parseList(java.io.InputStream is, java.lang.Class<E> jsonObjectClass) Parse a list of objects from an InputStream.
static <E> java.util.List<E>	parseList(java.lang.String jsonString, java.lang.Class<E> jsonObjectClass) Parse a list of objects from a String.
static <E> java.util.Map<java.lang.String,E>	parseMap(java.io.InputStream is, java.lang.Class<E> jsonObjectClass) Parse a map of objects from an InputStream.
static <E> java.util.Map<java.lang.String,E>	parseMap(java.lang.String jsonString, java.lang.Class<E> jsonObjectClass) Parse a map of objects from a String.
static <E> void	registerTypeConverter(java.lang.Class<E> cls, TypeConverter<E> converter) Register a new TypeConverter for parsing and serialization.
static <E> java.lang.String	serialize(E object) Serialize an object to a JSON String.
static <E> void	serialize(E object, java.io.OutputStream os) Serialize an object to an OutputStream.
static <E> java.lang.String	serialize(E object, ParameterizedType<E> parameterizedType) Serialize a parameterized object to a JSON String.
static <E> void	serialize(E object, ParameterizedType<E> parameterizedType, java.io.OutputStream os) Serialize a parameterized object to an OutputStream.
static <E> java.lang.String	serialize(java.util.List<E> list, java.lang.Class<E> jsonObjectClass) Serialize a list of objects to a JSON String.
static <E> void	serialize(java.util.List<E> list, java.io.OutputStream os, java.lang.Class<E> jsonObjectClass) Serialize a list of objects to an OutputStream.
static <E> java.lang.String	serialize(java.util.Map<java.lang.String,E> map, java.lang.Class<E> jsonObjectClass) Serialize a map of objects to a JSON String.
static <E> void	serialize(java.util.Map<java.lang.String,E> map, java.io.OutputStream os, java.lang.Class<E> jsonObjectClass) Serialize a map of objects to an OutputStream.
static boolean	supports(java.lang.Class cls) Returns whether or not LoganSquare can handle a given class.
static boolean	supports(ParameterizedType type) Returns whether or not LoganSquare can handle a given ParameterizedType.
static <E> TypeConverter<E>	typeConverterFor(java.lang.Class<E> cls) Returns a TypeConverter for a given class.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_FACTORY

public static final com.fasterxml.jackson.core.JsonFactory JSON_FACTORY

The JsonFactory that should be used throughout the entire app.

Constructor Detail

LoganSquare

public LoganSquare()

Method Detail

parse

public static <E> E parse(java.io.InputStream is,
                          java.lang.Class<E> jsonObjectClass)
                   throws java.io.IOException

Parse an object from an InputStream.

Parameters:

is - The InputStream, most likely from your networking library.

jsonObjectClass - The @JsonObject class to parse the InputStream into

Throws:

java.io.IOException

parse

public static <E> E parse(java.lang.String jsonString,
                          java.lang.Class<E> jsonObjectClass)
                   throws java.io.IOException

Parse an object from a String. Note: parsing from an InputStream should be preferred over parsing from a String if possible.

Parameters:

jsonString - The JSON string being parsed.

jsonObjectClass - The @JsonObject class to parse the InputStream into

Throws:

java.io.IOException

parse

public static <E> E parse(java.io.InputStream is,
                          ParameterizedType<E> jsonObjectType)
                   throws java.io.IOException

Parse a parameterized object from an InputStream.

Parameters:

is - The InputStream, most likely from your networking library.

jsonObjectType - The ParameterizedType describing the object. Ex: LoganSquare.parse(is, new ParameterizedType<MyModel<OtherModel>>() { });

Throws:

java.io.IOException

parse

public static <E> E parse(java.lang.String jsonString,
                          ParameterizedType<E> jsonObjectType)
                   throws java.io.IOException

Parse a parameterized object from a String. Note: parsing from an InputStream should be preferred over parsing from a String if possible.

Parameters:

jsonString - The JSON string being parsed.

jsonObjectType - The ParameterizedType describing the object. Ex: LoganSquare.parse(is, new ParameterizedType<MyModel<OtherModel>>() { });

Throws:

java.io.IOException

parseList

public static <E> java.util.List<E> parseList(java.io.InputStream is,
                                              java.lang.Class<E> jsonObjectClass)
                                       throws java.io.IOException

Parse a list of objects from an InputStream.

Parameters:

is - The inputStream, most likely from your networking library.

jsonObjectClass - The @JsonObject class to parse the InputStream into

Throws:

java.io.IOException

parseList

public static <E> java.util.List<E> parseList(java.lang.String jsonString,
                                              java.lang.Class<E> jsonObjectClass)
                                       throws java.io.IOException

Parse a list of objects from a String. Note: parsing from an InputStream should be preferred over parsing from a String if possible.

Parameters:

jsonString - The JSON string being parsed.

jsonObjectClass - The @JsonObject class to parse the InputStream into

Throws:

java.io.IOException

parseMap

public static <E> java.util.Map<java.lang.String,E> parseMap(java.io.InputStream is,
                                                             java.lang.Class<E> jsonObjectClass)
                                                      throws java.io.IOException

Parse a map of objects from an InputStream.

Parameters:

is - The inputStream, most likely from your networking library.

jsonObjectClass - The @JsonObject class to parse the InputStream into

Throws:

java.io.IOException

parseMap

public static <E> java.util.Map<java.lang.String,E> parseMap(java.lang.String jsonString,
                                                             java.lang.Class<E> jsonObjectClass)
                                                      throws java.io.IOException

Parse a map of objects from a String. Note: parsing from an InputStream should be preferred over parsing from a String if possible.

Parameters:

jsonString - The JSON string being parsed.

jsonObjectClass - The @JsonObject class to parse the InputStream into

Throws:

java.io.IOException

serialize

public static <E> java.lang.String serialize(E object)
                                      throws java.io.IOException

Serialize an object to a JSON String.

Parameters:

object - The object to serialize.

Throws:

java.io.IOException

serialize

public static <E> void serialize(E object,
                                 java.io.OutputStream os)
                          throws java.io.IOException

Serialize an object to an OutputStream.

Parameters:

object - The object to serialize.

os - The OutputStream being written to.

Throws:

java.io.IOException

serialize

public static <E> java.lang.String serialize(E object,
                                             ParameterizedType<E> parameterizedType)
                                      throws java.io.IOException

Serialize a parameterized object to a JSON String.

Parameters:

object - The object to serialize.

parameterizedType - The ParameterizedType describing the object. Ex: LoganSquare.serialize(object, new ParameterizedType<MyModel<OtherModel>>() { });

Throws:

java.io.IOException

serialize

public static <E> void serialize(E object,
                                 ParameterizedType<E> parameterizedType,
                                 java.io.OutputStream os)
                          throws java.io.IOException

Serialize a parameterized object to an OutputStream.

Parameters:

object - The object to serialize.

parameterizedType - The ParameterizedType describing the object. Ex: LoganSquare.serialize(object, new ParameterizedType<MyModel<OtherModel>>() { }, os);

os - The OutputStream being written to.

Throws:

java.io.IOException

serialize

public static <E> java.lang.String serialize(java.util.List<E> list,
                                             java.lang.Class<E> jsonObjectClass)
                                      throws java.io.IOException

Serialize a list of objects to a JSON String.

Parameters:

list - The list of objects to serialize.

jsonObjectClass - The @JsonObject class of the list elements

Throws:

java.io.IOException

serialize

public static <E> void serialize(java.util.List<E> list,
                                 java.io.OutputStream os,
                                 java.lang.Class<E> jsonObjectClass)
                          throws java.io.IOException

Serialize a list of objects to an OutputStream.

Parameters:

list - The list of objects to serialize.

os - The OutputStream to which the list should be serialized

jsonObjectClass - The @JsonObject class of the list elements

Throws:

java.io.IOException

serialize

public static <E> java.lang.String serialize(java.util.Map<java.lang.String,E> map,
                                             java.lang.Class<E> jsonObjectClass)
                                      throws java.io.IOException

Serialize a map of objects to a JSON String.

Parameters:

map - The map of objects to serialize.

jsonObjectClass - The @JsonObject class of the list elements

Throws:

java.io.IOException

serialize

public static <E> void serialize(java.util.Map<java.lang.String,E> map,
                                 java.io.OutputStream os,
                                 java.lang.Class<E> jsonObjectClass)
                          throws java.io.IOException

Serialize a map of objects to an OutputStream.

Parameters:

map - The map of objects to serialize.

os - The OutputStream to which the list should be serialized

jsonObjectClass - The @JsonObject class of the list elements

Throws:

java.io.IOException

supports

public static boolean supports(java.lang.Class cls)

Returns whether or not LoganSquare can handle a given class.

Parameters:

cls - The class for which support is being checked.

supports

public static boolean supports(ParameterizedType type)

Returns whether or not LoganSquare can handle a given ParameterizedType.

Parameters:

type - The ParameterizedType for which support is being checked.

mapperFor

public static <E> JsonMapper<E> mapperFor(java.lang.Class<E> cls)
                                   throws NoSuchMapperException

Returns a JsonMapper for a given class that has been annotated with @JsonObject.

Parameters:

cls - The class for which the JsonMapper should be fetched.

Throws:

NoSuchMapperException

mapperFor

public static <E> JsonMapper<E> mapperFor(ParameterizedType<E> type)
                                   throws NoSuchMapperException

Returns a JsonMapper for a given class that has been annotated with @JsonObject.

Parameters:

type - The ParameterizedType for which the JsonMapper should be fetched.

Throws:

NoSuchMapperException

mapperFor

public static <E> JsonMapper<E> mapperFor(ParameterizedType<E> type,
                                          SimpleArrayMap<ParameterizedType,JsonMapper> partialMappers)
                                   throws NoSuchMapperException

Throws:

NoSuchMapperException

typeConverterFor

public static <E> TypeConverter<E> typeConverterFor(java.lang.Class<E> cls)
                                             throws NoSuchTypeConverterException

Returns a TypeConverter for a given class.

Parameters:

cls - The class for which the TypeConverter should be fetched.

Throws:

NoSuchTypeConverterException

registerTypeConverter

public static <E> void registerTypeConverter(java.lang.Class<E> cls,
                                             TypeConverter<E> converter)

Register a new TypeConverter for parsing and serialization.

Parameters:

cls - The class for which the TypeConverter should be used.

converter - The TypeConverter