Module is.codion.framework.domain

Package is.codion.framework.domain.entity

Interface StringFactory.Builder

Enclosing class:

StringFactory

public static interface StringFactory.Builder

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

Method Summary

Modifier and Type	Method	Description
Function<Entity,String>	build()
StringFactory.Builder	text(String text)	Adds the given static text to this StringFactory.Builder
StringFactory.Builder	value(Attribute<?> attribute)	Adds the value mapped to the given key to this StringFactory.Builder
StringFactory.Builder	value(Attribute<?> attribute, Format format)	Adds the value mapped to the given key to this StringProvider
StringFactory.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 StringFactory.Builder

Method Details

value

StringFactory.Builder value(Attribute<?> attribute)

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

Parameters:

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

Returns:

this StringFactory.Builder instance

value

StringFactory.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 StringFactory.Builder instance

value

StringFactory.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 StringFactory.Builder

Parameters:

foreignKey - the foreign key

attribute - the attribute in the referenced entity to use

Returns:

this StringFactory.Builder instance

text

StringFactory.Builder text(String text)

Adds the given static text to this StringFactory.Builder

Parameters:

text - the text to add

Returns:

this StringFactory.Builder instance

build

Function<Entity,String> build()

Returns:

a new string factory function based on this builder