public interface

FormatterRegistry

implements ConverterRegistry
org.springframework.format.FormatterRegistry
Known Indirect Subclasses

Class Overview

A registry of field formatting logic.

Summary

Public Methods
abstract void addFormatter(Formatter<?> formatter)
Adds a Formatter to format fields of a specific type.
abstract void addFormatterForFieldAnnotation(AnnotationFormatterFactory<? extends Annotation> annotationFormatterFactory)
Adds a Formatter to format fields annotated with a specific format annotation.
abstract void addFormatterForFieldType(Class<?> fieldType, Formatter<?> formatter)
Adds a Formatter to format fields of the given type.
abstract void addFormatterForFieldType(Class<?> fieldType, Printer<?> printer, Parser<?> parser)
Adds a Printer/Parser pair to format fields of a specific type.
[Expand]
Inherited Methods
From interface org.springframework.core.convert.converter.ConverterRegistry

Public Methods

public abstract void addFormatter (Formatter<?> formatter)

Adds a Formatter to format fields of a specific type. The field type is implied by the parameterized Formatter instance.

Parameters
formatter the formatter to add

public abstract void addFormatterForFieldAnnotation (AnnotationFormatterFactory<? extends Annotation> annotationFormatterFactory)

Adds a Formatter to format fields annotated with a specific format annotation.

Parameters
annotationFormatterFactory the annotation formatter factory to add

public abstract void addFormatterForFieldType (Class<?> fieldType, Formatter<?> formatter)

Adds a Formatter to format fields of the given type.

On print, if the Formatter's type T is declared and fieldType is not assignable to T, a coersion to T will be attempted before delegating to formatter to print a field value. On parse, if the parsed object returned by formatter is not assignable to the runtime field type, a coersion to the field type will be attempted before returning the parsed field value.

Parameters
fieldType the field type to format
formatter the formatter to add

public abstract void addFormatterForFieldType (Class<?> fieldType, Printer<?> printer, Parser<?> parser)

Adds a Printer/Parser pair to format fields of a specific type. The formatter will delegate to the specified printer for printing and the specified parser for parsing.

On print, if the Printer's type T is declared and fieldType is not assignable to T, a coersion to T will be attempted before delegating to printer to print a field value. On parse, if the object returned by the Parser is not assignable to the runtime field type, a coersion to the field type will be attempted before returning the parsed field value.

Parameters
fieldType the field type to format
printer the printing part of the formatter
parser the parsing part of the formatter