Module is.codion.framework.domain

Package is.codion.framework.domain.entity

Interface EntityFormatter.Builder

Enclosing class:

EntityFormatter

public static sealed interface EntityFormatter.Builder

A Builder for a formatter function, which provides toString() values for entities.

Method Summary

Modifier and Type	Method	Description
Function<Entity,String>	build()
EntityFormatter.Builder	text(String text)	Adds the given static text to this EntityFormatter.Builder
EntityFormatter.Builder	value(Attribute<?> attribute)	Adds the value mapped to the given key to this EntityFormatter.Builder
EntityFormatter.Builder	value(Attribute<?> attribute, Format format)	Adds the value mapped to the given key to this StringProvider
EntityFormatter.Builder	value(ForeignKey foreignKey, Attribute<?> attribute)	Adds the value mapped to the given attribute in the Entity instance mapped to the given foreign key to this EntityFormatter.Builder

Method Details

value

EntityFormatter.Builder value(Attribute<?> attribute)

Adds the value mapped to the given key to this EntityFormatter.Builder

Parameters:

attribute - the attribute which value should be added to the string representation

Returns:

this EntityFormatter.Builder instance

value

EntityFormatter.Builder value(Attribute<?> attribute,
 Format format)

Adds the value mapped to the given key to this StringProvider

Parameters:

attribute - the attribute which value should be added to the string representation

format - the Format to use when appending the value

Returns:

this EntityFormatter.Builder instance

value

EntityFormatter.Builder value(ForeignKey foreignKey,
 Attribute<?> attribute)

Adds the value mapped to the given attribute in the Entity instance mapped to the given foreign key to this EntityFormatter.Builder

Parameters:

foreignKey - the foreign key

attribute - the attribute in the referenced entity to use

Returns:

this EntityFormatter.Builder instance

text

EntityFormatter.Builder text(String text)

Adds the given static text to this EntityFormatter.Builder

Parameters:

text - the text to add

Returns:

this EntityFormatter.Builder instance

build

Function<Entity,String> build()

Returns:

a new string formatter based on this builder