Package org.springframework.format
Interface FormatterRegistry
- All Superinterfaces:
ConverterRegistry
- All Known Implementing Classes:
DefaultFormattingConversionService,FormattingConversionService
public interface FormatterRegistry extends ConverterRegistry
A registry of field formatting logic.- Since:
- 3.0
- Author:
- Keith Donald, Juergen Hoeller
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddFormatter(Formatter<?> formatter)Adds a Formatter to format fields of a specific type.voidaddFormatterForFieldAnnotation(AnnotationFormatterFactory<? extends Annotation> annotationFormatterFactory)Adds a Formatter to format fields annotated with a specific format annotation.voidaddFormatterForFieldType(Class<?> fieldType, Formatter<?> formatter)Adds a Formatter to format fields of the given type.voidaddFormatterForFieldType(Class<?> fieldType, Printer<?> printer, Parser<?> parser)Adds a Printer/Parser pair to format fields of a specific type.voidaddParser(Parser<?> parser)Adds a Parser to parse fields of a specific type.voidaddPrinter(Printer<?> printer)Adds a Printer to print fields of a specific type.Methods inherited from interface org.springframework.core.convert.converter.ConverterRegistry
addConverter, addConverter, addConverter, addConverterFactory, removeConvertible
Method Detail
addPrinter
void addPrinter(Printer<?> printer)
Adds a Printer to print fields of a specific type. The field type is implied by the parameterized Printer instance.- Parameters:
printer- the printer to add- Since:
- 5.2
- See Also:
addFormatter(Formatter)
addParser
void addParser(Parser<?> parser)
Adds a Parser to parse fields of a specific type. The field type is implied by the parameterized Parser instance.- Parameters:
parser- the parser to add- Since:
- 5.2
- See Also:
addFormatter(Formatter)
addFormatter
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- Since:
- 3.1
- See Also:
addFormatterForFieldType(Class, Formatter)
addFormatterForFieldType
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
fieldTypeis not assignable to T, a coercion to T will be attempted before delegating toformatterto print a field value. On parse, if the parsed object returned byformatteris not assignable to the runtime field type, a coercion to the field type will be attempted before returning the parsed field value.- Parameters:
fieldType- the field type to formatformatter- the formatter to add
addFormatterForFieldType
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 specifiedprinterfor printing and the specifiedparserfor parsing.On print, if the Printer's type T is declared and
fieldTypeis not assignable to T, a coercion to T will be attempted before delegating toprinterto print a field value. On parse, if the object returned by the Parser is not assignable to the runtime field type, a coercion to the field type will be attempted before returning the parsed field value.- Parameters:
fieldType- the field type to formatprinter- the printing part of the formatterparser- the parsing part of the formatter
addFormatterForFieldAnnotation
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