com.speedment.encoder

Class JsonEncoder<ENTITY>

java.lang.Object

com.speedment.encoder.JsonEncoder<ENTITY>

Type Parameters:

ENTITY - Entity type

All Implemented Interfaces:

Encoder<ENTITY,JsonEncoder<ENTITY>,String>

public final class JsonEncoder<ENTITY>
extends Object
implements Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Author:

Emil Forslund

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Function<ENTITY,String>>	getters

Constructor Summary

Constructors

Constructor and Description
JsonEncoder(Speedment speedment) Constructs an empty JsonEncoder with no fields added to the output renderer.

Method Summary

Modifier and Type	Method and Description
static <ENTITY> JsonEncoder<ENTITY>	allOf(Manager<ENTITY> manager) Creates and return a new JsonEncoder with all the Entity fields added to the renderer.
String	apply(ENTITY entity)
protected static String	jsonField(Speedment speedment, FieldIdentifier<?> identifier)
static String	jsonValue(Object in)
static <ENTITY> JsonEncoder<ENTITY>	noneOf(Manager<ENTITY> manager) Creates and return a new JsonEncoder with no fields added to the renderer.
static <ENTITY> JsonEncoder<ENTITY>	of(Manager<ENTITY> manager, FieldTrait... fields) Creates and return a new JsonEncoder with the provided Entity field(s) added to the renderer.
<D,T,I extends FieldTrait & ReferenceFieldTrait<ENTITY,D,T>> JsonEncoder<ENTITY>	put(I field) Adds this Field to the output renderer.
<D,T,FK_ENTITY,I extends FieldTrait & ReferenceFieldTrait<ENTITY,D,T> & ReferenceForeignKeyFieldTrait<ENTITY,D,FK_ENTITY>> JsonEncoder<ENTITY>	put(I field, Encoder<FK_ENTITY,?,String> builder) Adds this ReferenceForeignKeyField to the output renderer.
<FK_ENTITY> JsonEncoder<ENTITY>	put(String label, Function<ENTITY,FK_ENTITY> getter, Encoder<FK_ENTITY,?,String> builder) Adds a field that corresponds to the label to the output renderer.
<T> JsonEncoder<ENTITY>	put(String label, Function<ENTITY,T> getter) Adds a field that corresponds to the label to the output renderer.
<FK_ENTITY> JsonEncoder<ENTITY>	putStreamer(String label, Function<ENTITY,Stream<FK_ENTITY>> streamer, Encoder<FK_ENTITY,?,String> builder) Adds a field that corresponds to the label to the output renderer.
<FK_ENTITY> JsonEncoder<ENTITY>	putStreamer(String label, Function<ENTITY,Stream<FK_ENTITY>> streamer, Function<FK_ENTITY,String> encoder) Adds a field that corresponds to the label to the output renderer.
JsonEncoder<ENTITY>	remove(FieldTrait field) Removes this Field from the output renderer.
JsonEncoder<ENTITY>	remove(String label) Removes the field that corresponds to the provided label from the output renderer.

Methods inherited from class java.lang.Object

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

Field Detail

getters

protected final Map<String,Function<ENTITY,String>> getters

Constructor Detail

JsonEncoder

public JsonEncoder(Speedment speedment)

Constructs an empty JsonEncoder with no fields added to the output renderer.

Parameters:

speedment - context to use

Method Detail

put

public <D,T,I extends FieldTrait & ReferenceFieldTrait<ENTITY,D,T>> JsonEncoder<ENTITY> put(I field)

Description copied from interface: Encoder

Adds this Field to the output renderer. The field will be rendered using its default class renderer.

Specified by:

put in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Type Parameters:

D - the database type

T - the mapped Java type of the Field

I - Field type

Parameters:

field - to add to the renderer

Returns:

a reference to a resulting Encoder

put

public <D,T,FK_ENTITY,I extends FieldTrait & ReferenceFieldTrait<ENTITY,D,T> & ReferenceForeignKeyFieldTrait<ENTITY,D,FK_ENTITY>> JsonEncoder<ENTITY> put(I field,
                                                                                                                                                          Encoder<FK_ENTITY,?,String> builder)

Description copied from interface: Encoder

Adds this ReferenceForeignKeyField to the output renderer. The field will be rendered such that the foreign key object will be retrieved and then the foreign key object will be rendered using the provided Encoder.

Specified by:

put in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Type Parameters:

D - the database type

T - the mapped Java type of the Field

FK_ENTITY - the mapped Java type of the foreign key Field

I - Field type

Parameters:

field - to add to the renderer

builder - the foreign key encoder

Returns:

a reference to a resulting Encoder

put

public <T> JsonEncoder<ENTITY> put(String label,
                                   Function<ENTITY,T> getter)

Description copied from interface: Encoder

Adds a field that corresponds to the label to the output renderer. The field will be rendered as an Object of type T by applying the provided getter on the Entity and then feeding the returned value to the default class renderer.

Specified by:

put in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Type Parameters:

T - the mapped Java type of the Field

Parameters:

label - the name of the field to add to the output renderer

getter - to apply to the Entity

Returns:

a reference to a resulting Encoder

put

public <FK_ENTITY> JsonEncoder<ENTITY> put(String label,
                                           Function<ENTITY,FK_ENTITY> getter,
                                           Encoder<FK_ENTITY,?,String> builder)

Description copied from interface: Encoder

Adds a field that corresponds to the label to the output renderer. The field will be rendered such that the foreign key object will be retrieved and then the foreign key object will be rendered using the provided Encoder.

Specified by:

put in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Type Parameters:

FK_ENTITY - the mapped Java type of an Entity

Parameters:

label - the name of the field to add to the output renderer

getter - fkFormatter the foreign key encoder

builder - the foreign key encoder

Returns:

a reference to a resulting Encoder

putStreamer

public <FK_ENTITY> JsonEncoder<ENTITY> putStreamer(String label,
                                                   Function<ENTITY,Stream<FK_ENTITY>> streamer,
                                                   Encoder<FK_ENTITY,?,String> builder)

Description copied from interface: Encoder

Adds a field that corresponds to the label to the output renderer. The field will be rendered by applying the provided streamer that will provide a Stream of type FK_ENTITY from an ENTITY. Each Stream element will then be rendered in a subarray by applying the provided fkFormatter.

Specified by:

putStreamer in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Type Parameters:

FK_ENTITY - the mapped Java type of an Entity

Parameters:

label - the name of the field to add to the output renderer

streamer - that can produce a Stream<FK_ENTITY> from an ENTITY

builder - the foreign key encoder

Returns:

a reference to a resulting Encoder

putStreamer

public <FK_ENTITY> JsonEncoder<ENTITY> putStreamer(String label,
                                                   Function<ENTITY,Stream<FK_ENTITY>> streamer,
                                                   Function<FK_ENTITY,String> encoder)

Description copied from interface: Encoder

Adds a field that corresponds to the label to the output renderer. The field will be rendered by applying the provided streamer that will provide a Stream<FK_ENTITY> from an ENTITY. Each Stream element will then be rendered by the provided custom fkMapper that produces an Object that is subsequently rendered using its default class renderer.

Specified by:

putStreamer in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Type Parameters:

FK_ENTITY - the mapped Java type of an Entity

Parameters:

label - the name of the field to add to the output renderer

streamer - that can produce a Stream<FK_ENTITY> from an ENTITY

encoder - the foreign key encoder

Returns:

a reference to a resulting Encoder

remove

public JsonEncoder<ENTITY> remove(String label)

Description copied from interface: Encoder

Removes the field that corresponds to the provided label from the output renderer. If the provided label does not correspond to a field currently existing in the output renderer, the action is silently ignored (no-op).

Specified by:

remove in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Parameters:

label - the name of the field to remove from the output renderer

Returns:

a reference to a resulting Encoder

remove

public JsonEncoder<ENTITY> remove(FieldTrait field)

Description copied from interface: Encoder

Removes this Field from the output renderer. If the provided Field does not correspond to a Field currently existing in the output renderer, the action is silently ignored (no-op).

Specified by:

remove in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

Parameters:

field - to add to the renderer

Returns:

a reference to a resulting Encoder

apply

public String apply(ENTITY entity)

Specified by:

apply in interface Encoder<ENTITY,JsonEncoder<ENTITY>,String>

jsonField

protected static String jsonField(Speedment speedment,
                                  FieldIdentifier<?> identifier)

jsonValue

public static String jsonValue(Object in)

noneOf

public static <ENTITY> JsonEncoder<ENTITY> noneOf(Manager<ENTITY> manager)

Creates and return a new JsonEncoder with no fields added to the renderer.

Type Parameters:

ENTITY - the Entity type

Parameters:

manager - of the entity

Returns:

a new JsonEncoder with no fields added to the renderer

allOf

public static <ENTITY> JsonEncoder<ENTITY> allOf(Manager<ENTITY> manager)

Creates and return a new JsonEncoder with all the Entity fields added to the renderer. The field(s) will be rendered using their default class renderer.

Type Parameters:

ENTITY - the Entity type

Parameters:

manager - of the entity

Returns:

a new JsonEncoder with all the Entity fields added to the renderer

of

@SafeVarargs
public static <ENTITY> JsonEncoder<ENTITY> of(Manager<ENTITY> manager,
                                                           FieldTrait... fields)

Creates and return a new JsonEncoder with the provided Entity field(s) added to the renderer. The field(s) will be rendered using their default class renderer.

Type Parameters:

ENTITY - the Entity type

Parameters:

manager - of the ENTITY

fields - to add to the output renderer

Returns:

a new JsonEncoder with the specified fields added to the renderer