griffon.core.formatters

Interface Formatter<T>

Type Parameters:

T - the type of instances this Formatter can handle.

All Known Implementing Classes:

AbstractFormatter, BigDecimalFormatter, BigIntegerFormatter, BooleanFormatter, ByteFormatter, CalendarFormatter, ColorFormatter, ColorFormatter, ColorFormatter, DateFormatter, DoubleFormatter, FloatFormatter, IntegerFormatter, LocalDateFormatter, LocalDateTimeFormatter, LocaleFormatter, LocalTimeFormatter, LongFormatter, ShortFormatter

public interface Formatter<T>

Strategy for parsing and formatting instances from and to their literal representation

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(T obj) Formats an instance into its literal representation.
T	parse(java.lang.String str) Parses a literal representation into an instance of type T.

Method Detail

format

@Nullable
java.lang.String format(@Nullable
                                  T obj)

Formats an instance into its literal representation.

The resulting String may be set as an argument to parse(java.lang.String) resulting in a similar instance as the input.

Parameters:

obj - the instance to be formatted

Returns:

A String representing the instance's state.

parse

@Nullable
T parse(@Nullable
                  java.lang.String str)
           throws ParseException

Parses a literal representation into an instance of type T.

The resulting instance T may be set as an argument to format(T) resulting in an equal String as the input.

Parameters:

str - the String to be parsed

Returns:

an instance of type T whose state is initialized given the parameters of the input String.

Throws:

ParseException - if the String cannot be parsed.