com.helger.commons.format

Interface IFormatter<DATATYPE>

Type Parameters:

DATATYPE - Source data type

All Superinterfaces:

Function<DATATYPE,String>, Serializable

All Known Implementing Classes:

AbstractFormatterString, FormatterBracket, FormatterMinLengthAddLeading, FormatterMinLengthAddTrailing, FormatterStringPrefix, FormatterStringPrefixAndSuffix, FormatterStringSkipPrefix, FormatterStringSkipPrefixAndSuffix, FormatterStringSkipSuffix, FormatterStringSuffix

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IFormatter<DATATYPE>
extends Serializable, Function<DATATYPE,String>

A simple formatter interface that may be used to format arbitrary objects to a string.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
default IFormatter<DATATYPE>	andThen(IFormatter<? super String> after)
String	apply(DATATYPE aValue) Convert the passed value to a formatted string according to the pattern.

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

apply

@Nonnull
String apply(@Nullable
                       DATATYPE aValue)

Convert the passed value to a formatted string according to the pattern.

Specified by:

apply in interface Function<DATATYPE,String>

Parameters:

aValue - The source value to be formatted. May be null.

Returns:

The formatted string. Never null.

Throws:

IllegalArgumentException - if the formatter does not understand the object

andThen

default IFormatter<DATATYPE> andThen(IFormatter<? super String> after)