com.speedment.encoder

Interface Encoder<ENTITY,R extends Encoder<ENTITY,R,OUTPUT_TYPE>,OUTPUT_TYPE>

Type Parameters:

ENTITY - Entity type

R - Type of formatter

OUTPUT_TYPE - Target encoder output type

All Known Implementing Classes:

JsonEncoder

public interface Encoder<ENTITY,R extends Encoder<ENTITY,R,OUTPUT_TYPE>,OUTPUT_TYPE>

The Encoder can be used to format an Entity into any kind of strings. Fields can be added, removed and it is also possible to change the way a field is rendered into the resulting String.

A field can also be rendered using another EntityFormatter when that other field is a foreign key or, for that matter, another Field in any Entity.

Author:

Emil Forslund

Method Summary

Modifier and Type	Method and Description
OUTPUT_TYPE	apply(ENTITY entity)
<D,T,I extends FieldTrait & ReferenceFieldTrait<ENTITY,D,T>> R	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>> R	put(I field, Encoder<FK_ENTITY,?,OUTPUT_TYPE> fkFormatter) Adds this ReferenceForeignKeyField to the output renderer.
<FK_ENTITY> R	put(String label, Function<ENTITY,FK_ENTITY> getter, Encoder<FK_ENTITY,?,OUTPUT_TYPE> fkFormatter) Adds a field that corresponds to the label to the output renderer.
<T> R	put(String label, Function<ENTITY,T> getter) Adds a field that corresponds to the label to the output renderer.
<FK_ENTITY> R	putStreamer(String label, Function<ENTITY,Stream<FK_ENTITY>> streamer, Encoder<FK_ENTITY,?,OUTPUT_TYPE> fkFormatter) Adds a field that corresponds to the label to the output renderer.
<FK_ENTITY> R	putStreamer(String label, Function<ENTITY,Stream<FK_ENTITY>> streamer, Function<FK_ENTITY,OUTPUT_TYPE> fkMapper) Adds a field that corresponds to the label to the output renderer.
R	remove(FieldTrait field) Removes this Field from the output renderer.
R	remove(String label) Removes the field that corresponds to the provided label from the output renderer.

Method Detail

apply

OUTPUT_TYPE apply(ENTITY entity)

put

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

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

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

<D,T,FK_ENTITY,I extends FieldTrait & ReferenceFieldTrait<ENTITY,D,T> & ReferenceForeignKeyFieldTrait<ENTITY,D,FK_ENTITY>> R put(I field,
                                                                                                                                 Encoder<FK_ENTITY,?,OUTPUT_TYPE> fkFormatter)

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.

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

fkFormatter - the foreign key encoder

Returns:

a reference to a resulting Encoder

put

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

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.

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

<FK_ENTITY> R put(String label,
                  Function<ENTITY,FK_ENTITY> getter,
                  Encoder<FK_ENTITY,?,OUTPUT_TYPE> fkFormatter)

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.

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

fkFormatter - the foreign key encoder

Returns:

a reference to a resulting Encoder

putStreamer

<FK_ENTITY> R putStreamer(String label,
                          Function<ENTITY,Stream<FK_ENTITY>> streamer,
                          Encoder<FK_ENTITY,?,OUTPUT_TYPE> fkFormatter)

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.

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

fkFormatter - the foreign key encoder

Returns:

a reference to a resulting Encoder

putStreamer

<FK_ENTITY> R putStreamer(String label,
                          Function<ENTITY,Stream<FK_ENTITY>> streamer,
                          Function<FK_ENTITY,OUTPUT_TYPE> fkMapper)

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.

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

fkMapper - the foreign key encoder

Returns:

a reference to a resulting Encoder

remove

R remove(String label)

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).

Parameters:

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

Returns:

a reference to a resulting Encoder

remove

R remove(FieldTrait field)

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).

Parameters:

field - to add to the renderer

Returns:

a reference to a resulting Encoder