Package net.tangly.gleam.model

Interface JsonField<T,U>

Type Parameters:

T - type of the entity owning the field

U - type of the property

All Known Implementing Classes:

JsonArray, JsonProperty

public sealed interface JsonField<T,U>
permits JsonProperty<T,U>, JsonArray<T,U>

Defines the abstraction of a mapping between a Java property - simple type, another class mapped to a JSON entity, or a collection mapped to a JSON array - and a JSON property, type, or array.

Method Summary

Modifier and Type	Method	Description
void	exports(T entity, @NotNull org.json.JSONObject object)	Export the JSON value from the associated property after an optional conversion.
void	imports(T entity, @NotNull org.json.JSONObject object)	Import the JSON value and set the associated property after an optional conversion.
String	key()	Return the JSON property key name storing the property in a JSON structure.
static String	string(org.json.JSONObject object, String key)

Method Details

imports

void imports(@NotNull
 T entity,
 @NotNull
 @NotNull org.json.JSONObject object)

Import the JSON value and set the associated property after an optional conversion. Multiple JSON values can be used if the object is complex.

Parameters:

entity - entity which property will be imported and set

object - JSON object containing the values

See Also:

• JsonProperty.exports(Object, JSONObject)

exports

void exports(@NotNull
 T entity,
 @NotNull
 @NotNull org.json.JSONObject object)

Export the JSON value from the associated property after an optional conversion. Multiple JSON values can be written if the object is a complex one.

Parameters:

entity - entity which property will be exported as TSV value

object - JSON object to write the TSV value(s)

See Also:

• JsonProperty.imports(Object, JSONObject)

key

String key()

Return the JSON property key name storing the property in a JSON structure.

Returns:

key of the property

string

static String string(org.json.JSONObject object,
 String key)