org.everit.http.restclient

Interface JSONObjectMapper

public interface JSONObjectMapper

Libraries that use REST Client should provide a JSONObjectMapper that tells the REST client how to convert from String to JSON and vice versa.

Method Summary

Modifier and Type	Method and Description
<T> T	convertValue(Object fromValue, Class<T> toValueType) Converts a value from an object to another type.
<T> T	convertValue(Object fromValue, TypeReference<T> toValueTypeRef) Converts a value from an object to another type.
<T> T	fromJSON(String json, Class<T> valueType) Converts a JSON string to a type.
<T> T	fromJSON(String json, TypeReference<T> valueTypeRef) Converts a JSON string to a type.
String	toJSON(Object object) Converts an object to JSON.

Method Detail

convertValue

<T> T convertValue(Object fromValue,
                   Class<T> toValueType)

Converts a value from an object to another type. Some implementations may do this directly, other implementations do it by converting the object first to JSON than to the other type. This is useful when an object contains a map property that can be converted to a real type.

Type Parameters:

T - The type of the destination instance.

Parameters:

fromValue - The object that would be converted.

toValueType - The destination type.

Returns:

The converted new object with the destination type.

convertValue

<T> T convertValue(Object fromValue,
                   TypeReference<T> toValueTypeRef)

Converts a value from an object to another type. Some implementations may do this directly, other implementations do it by converting the object first to JSON than to the other type. This is useful when an object contains a map property that can be converted to a real type.

Type Parameters:

T - The type of the destination instance.

Parameters:

fromValue - The object that would be converted.

toValueTypeRef - Reference to the destination type.

Returns:

The converted new object with the destination type.

fromJSON

<T> T fromJSON(String json,
               Class<T> valueType)

Converts a JSON string to a type.

Type Parameters:

T - The type to convert the JSON to.

Parameters:

json - The JSON as string.

valueType - The type as class type that the JSON will be converted to.

Returns:

The generated instance.

fromJSON

<T> T fromJSON(String json,
               TypeReference<T> valueTypeRef)

Converts a JSON string to a type.

Type Parameters:

T - The type to convert the JSON to.

Parameters:

json - The JSON as string.

valueTypeRef - The type as reference type that the JSON will be converted to.

Returns:

The generated instance.

toJSON

String toJSON(Object object)

Converts an object to JSON.

Parameters:

object - The object that is converted to JSON.

Returns: