Module iu.util.client

Package edu.iu.client

Interface IuJsonAdapter<T>

Type Parameters:

T - target type, may be unchecked

All Known Subinterfaces:

Jose.Extension<T>

public interface IuJsonAdapter<T>

Adapts JSON values to equivalent Java types.

Method Summary

Modifier and Type	Method	Description
static <T> IuJsonAdapter<T>	basic()	Provides a basic JSON type adapter.
static <T> IuJsonAdapter<T>	from(Class<T> type, IuJsonPropertyNameFormat propertyNameFormat, Function<Type,IuJsonAdapter<?>> valueAdapter)	Creates a JSON type adapter that converts from a JavaBeans business object type to and from JSON.
static <T> IuJsonAdapter<T>	from(Function<JsonValue,T> fromJson)	Creates a functional JSON type adapter.
static <T> IuJsonAdapter<T>	from(Function<JsonValue,T> fromJson, Function<T,JsonValue> toJson)	Creates a functional JSON type adapter.
T	fromJson(JsonValue jsonValue)	Converts a JSON parameter value to its Java equivalent.
static <T> IuJsonAdapter<T>	of(Class<? super T> type, IuJsonAdapter<?> valueAdapter)	Provides a JSON type adapter that delegates to another adapter for parameterized values.
static <T> IuJsonAdapter<T>	of(Class<T> type)	Provides a standard JSON type adapter for a Java value.
static <T> IuJsonAdapter<T>	of(Type type)	Provides a JSON type adapter for the erasure of a generic type.
static <T> IuJsonAdapter<T>	of(Type type, Function<Class<?>,IuJsonAdapter<?>> valueAdapter)	Provides a JSON type adapter that delegates to another adapter for parameterized values.
static <T> IuJsonAdapter<T>	text(Function<String,T> parser)	Creates a functional JSON type adapter for text conversion.
static <T> IuJsonAdapter<T>	text(Function<String,T> parser, Function<T,String> print)	Creates a functional JSON type adapter.
static <T> IuJsonAdapter<T>	to(Function<T,JsonValue> toJson)	Creates a functional JSON type adapter.
JsonValue	toJson(T value)	Converts a value to its JSON equivalent.

Method Details

from

static <T> IuJsonAdapter<T> from(Function<JsonValue,T> fromJson)

Creates a functional JSON type adapter.

Type Parameters:

T - target type

Parameters:

fromJson - function that converts from JSON to the target type

Returns:

functional adapter

text

static <T> IuJsonAdapter<T> text(Function<String,T> parser)

Creates a functional JSON type adapter for text conversion.

Type Parameters:

T - target type

Parameters:

parser - parsing function

Returns:

functional adapter

text

static <T> IuJsonAdapter<T> text(Function<String,T> parser,
 Function<T,String> print)

Creates a functional JSON type adapter.

Type Parameters:

T - target type

Parameters:

parser - parsing function

print - printing function

Returns:

functional adapter

to

static <T> IuJsonAdapter<T> to(Function<T,JsonValue> toJson)

Creates a functional JSON type adapter.

Type Parameters:

T - target type

Parameters:

toJson - function that converts from the target type to JSON

Returns:

functional adapter

from

static <T> IuJsonAdapter<T> from(Function<JsonValue,T> fromJson,
 Function<T,JsonValue> toJson)

Creates a functional JSON type adapter.

Type Parameters:

T - target type

Parameters:

fromJson - function that converts from JSON to the target type

toJson - function that converts from the target type to JSON

Returns:

functional adapter

from

static <T> IuJsonAdapter<T> from(Class<T> type,
 IuJsonPropertyNameFormat propertyNameFormat,
 Function<Type,IuJsonAdapter<?>> valueAdapter)

Creates a JSON type adapter that converts from a JavaBeans business object type to and from JSON.

Type Parameters:

T - business object type

Parameters:

type - business object class; must be an interface to convert from JSON, an interface is not required to convert from JSON.

propertyNameFormat - property name format to use for converting to JSON

valueAdapter - value adapter function

Returns:

IuJsonAdapter

basic

static <T> IuJsonAdapter<T> basic()

Provides a basic JSON type adapter.

Returns an adapter that:

• Handles undefined (null) JSON values as null
• Returns JsonValue as-is
• Builds JsonObjectBuilder and JsonArrayBuilder if provided to toJson(Object) as Java values
• Converts between null and JsonValue.NULL
• Converts between Boolean and JsonValue.TRUE/JsonValue.FALSE
• Converts between String and JsonString
• Converts between Number and JsonNumber, fromJson(JsonValue) returns BigDecimal
• Converts between List<?> and JsonArray, with recursive item conversion
• Converts between Map<String, ?> and JsonObject, with recursive conversion
• Converts irreversibly to JsonValue for other types listed in of(Class).

Equivalent to of(Object.class)

Type Parameters:

T - target type, may be used for unchecked cast to a one of the types listed above. For full generic type support and two-way conversion use of(Class)

Returns:

IuJsonAdapter

Throws:

ClassCastException - (potentially upstream) If the target type doesn't match the return type

of

static <T> IuJsonAdapter<T> of(Type type)

Provides a JSON type adapter for the erasure of a generic type.

The adapter returned is aware of ParameterizedType and GenericArrayType arguments indicating item, component, and value types. All types referenced by generic type arguments must be included in the list below.

Supports:

• Boolean and boolean
• Object, see basic() for Object conversion rules
• Void and void, supporting only null values
• toJson(Object) as JsonNumber
  • BigDecimal
  • Byte and byte
  • Double and byte
  • Float and byte
  • Integer and int
  • Long and long
  • Number, as BigDecimal
  • Short and short
• toJson(Object) returns JsonString
  • byte[], via IuText.base64(String) and IuText.base64(byte[])
  • BigInteger
  • CharSequence
  • Calendar, as Date
  • CharSequence, as String
  • Date, as Temporal
  • Duration
  • Enum subtypes
  • Instant
  • LocalDate
  • LocalTime
  • LocalDateTime
  • OffsetDateTime
  • OffsetTime
  • Optional
  • Period
  • SimpleTimeZone
  • String
  • Pattern
  • TimeZone
  • URI
  • URL
  • ZonedDateTime
  • ZoneId
  • ZoneOffset
• toJson(Object) as JsonArray
  • Array type
  • ArrayList
  • Collection, as Queue
  • Deque, as ArrayDeque
  • Enumeration
  • HashSet
  • Iterable, as Collection
  • Iterator
  • LinkedHashSet
  • List, as ArrayList
  • NavigableSet, as TreeSet
  • Queue, as Deque
  • Set, as LinkedHashSet
  • SortedSet, as NavigableSet
  • Properties, enforces values as String
  • TreeSet
  • Stream
• toJson(Object) as JsonObject:
  • LinkedHashMap
  • HashMap
  • Map, as LinkedHashMap
  • SortedMap, as TreeMap
  • Properties
  • TreeMap

Type Parameters:

T - target type

Parameters:

type - target type

Returns:

IuJsonAdapter

of

static <T> IuJsonAdapter<T> of(Class<T> type)

Provides a standard JSON type adapter for a Java value.

Type Parameters:

T - target type

Parameters:

type - target type

Returns:

IuJsonAdapter

See Also:

• of(Type)

of

static <T> IuJsonAdapter<T> of(Class<? super T> type,
 IuJsonAdapter<?> valueAdapter)

Provides a JSON type adapter that delegates to another adapter for parameterized values.

Type Parameters:

T - target type

Parameters:

type - target type

valueAdapter - Value type adapter for JsonStructure conversion, may be null if the Java type doesn't declare parameters, or to use a standard value adapter

Returns:

IuJsonAdapter

See Also:

• of(Type)

of

static <T> IuJsonAdapter<T> of(Type type,
 Function<Class<?>,IuJsonAdapter<?>> valueAdapter)

Provides a JSON type adapter that delegates to another adapter for parameterized values.

Type Parameters:

T - target type

Parameters:

type - target type

valueAdapter - Factory function for supplying a value type adapter for JsonStructure conversion based on the item type.

Returns:

IuJsonAdapter

See Also:

• of(Type)

fromJson

T fromJson(JsonValue jsonValue)

Converts a JSON parameter value to its Java equivalent.

Parameters:

jsonValue - JSON value

Returns:

Java equivalent

toJson

JsonValue toJson(T value)

Converts a value to its JSON equivalent.

Parameters:

value - value

Returns:

JSON equivalent