StringRenderer

info.fingo.spata.text.StringRenderer
See theStringRenderer companion trait

Rendering methods from various simple types to String.

Contains renderers for common types, like numbers, dates and times.

Additional renderers may be provided by implementing StringRenderer or FormattedStringRenderer traits and putting given instances in scope. StringRenderer may be implemented if there are no different formatting options for given type, e.g. for integers. For all cases when different formatting options exist, FormattedStringRenderer should be implemented.

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

Renderer for boolean values with support for formats.

Renderer for boolean values with support for formats.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object doubleRendererFmt extends FormattedStringRenderer[Double, DecimalFormat]

Renderer for double values with support for formats.

Renderer for double values with support for formats.

Attributes

Supertypes
trait FormattedStringRenderer[Double, DecimalFormat]
class Object
trait Matchable
class Any
Self type
object intRenderer extends StringRenderer[Int]

Renderer for integer values.

Renderer for integer values.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object longRendererFmt extends FormattedStringRenderer[Long, NumberFormat]

Renderer for long values with support for formats.

Renderer for long values with support for formats.

Attributes

Supertypes
trait FormattedStringRenderer[Long, NumberFormat]
class Object
trait Matchable
class Any
Self type
object numberRendererFmt extends FormattedStringRenderer[Number, DecimalFormat]

Renderer for numeric values (BigDecimal,BigInt` and various Java classes) with support for formats.

Renderer for numeric values (BigDecimal,BigInt` and various Java classes) with support for formats.

Attributes

Supertypes
trait FormattedStringRenderer[Number, DecimalFormat]
trait StringRenderer[Number]
class Object
trait Matchable
class Any
Self type

Renderer for string. Return the original string or empty one for null.

Renderer for string. Return the original string or empty one for null.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object temporalRendererFmt extends FormattedStringRenderer[Temporal, DateTimeFormatter]

Renderer for time/date values with support for formats.

Renderer for time/date values with support for formats.

Attributes

Supertypes
trait FormattedStringRenderer[Temporal, DateTimeFormatter]
trait StringRenderer[Temporal]
class Object
trait Matchable
class Any
Self type

Value members

Concrete methods

def render[A](value: A)(using renderer: StringRenderer[A]): String

Renders desired type to string using default format.

Renders desired type to string using default format.

Type parameters

A

the source type

Value parameters

renderer

the renderer for specific source type

value

the value to render

Attributes

Returns

rendered string

Example
import info.fingo.spata.text.StringRenderer.*
val x = render(123.45)
val y = render(Some(123.45))

Both values, x and y will be set to "123.45".

def render[A, B](value: A, fmt: B)(using renderer: FormattedStringRenderer[A, B]): String

Renders desired type to string based on provided format.

Renders desired type to string based on provided format.

Type parameters

A

the source type

B

type of formatter

Value parameters

fmt

formatter specific for particular input type, e.g. DateTimeFormatter for dates and times

renderer

the renderer for specific source type

value

the value to render

Attributes

Returns

rendered string

Givens

Givens

Renderer for boolean values with support for formats.

Renderer for boolean values with support for formats.

Attributes

Renderer for double values with support for formats.

Renderer for double values with support for formats.

Attributes

given intRenderer: intRenderer.type

Renderer for integer values.

Renderer for integer values.

Attributes

Renderer for long values with support for formats.

Renderer for long values with support for formats.

Attributes

Renderer for numeric values (BigDecimal,BigInt` and various Java classes) with support for formats.

Renderer for numeric values (BigDecimal,BigInt` and various Java classes) with support for formats.

Attributes

given optionRenderer[A](using renderer: StringRenderer[A]): optionRenderer[A]

Renderer for optional values. Allows conversion of any simple renderer to accept Option[A] instead of A, rendering the value from inside the option or returning empty string if not defined.

Renderer for optional values. Allows conversion of any simple renderer to accept Option[A] instead of A, rendering the value from inside the option or returning empty string if not defined.

Type parameters

A

the simple type wrapped by scala.Option

Value parameters

renderer

the renderer for underlying simple type

Attributes

Returns

renderer which accepts optional values

given optionRendererFmt[A, B](using renderer: FormattedStringRenderer[A, B]): optionRendererFmt[A, B]

Renderer for optional values with support for different formats. Allows conversion of any simple renderer to accept Option[A] instead of A, rendering the value from inside the option or returning empty string if not defined.

Renderer for optional values with support for different formats. Allows conversion of any simple renderer to accept Option[A] instead of A, rendering the value from inside the option or returning empty string if not defined.

Type parameters

A

the simple type wrapped by scala.Option

B

type of formatter

Value parameters

renderer

the renderer for underlying simple type

Attributes

Returns

renderer which support formatted input and ccepts optional values

Renderer for string. Return the original string or empty one for null.

Renderer for string. Return the original string or empty one for null.

Attributes

Renderer for time/date values with support for formats.

Renderer for time/date values with support for formats.

Attributes