com.helger.commons.format

Class AbstractFormatterString

java.lang.Object

com.helger.commons.format.AbstractFormatterString

All Implemented Interfaces:

IFormatter

Direct Known Subclasses:

FormatterMinLengthAddLeading, FormatterMinLengthAddTrailing, FormatterStringPrefixAndSuffix, FormatterStringSkipPrefixAndSuffix

public abstract class AbstractFormatterString
extends Object
implements IFormatter

Base implementation class of the IFormatter interface that provides the common functionality.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractFormatterString() Default constructor
AbstractFormatterString(IFormatter aPrevFormatter)

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormattedValue(Object aValue) Convert the passed value to a formatted string according to the pattern.
protected abstract String	getFormattedValueAsString(Object aValue) Convert the passed value from Object to formatted String.
IFormatter	getPreviousFormatter()
protected String	getValueAsString(Object aValue) Convert the source value to a string by using the TypeConverter.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractFormatterString

public AbstractFormatterString()

Default constructor

AbstractFormatterString

public AbstractFormatterString(@Nullable
                       IFormatter aPrevFormatter)

Parameters:

aPrevFormatter - Optional previous formatter to be invoked, before this formatter is invoked. May be null.

Method Detail

getPreviousFormatter

@Nullable
public final IFormatter getPreviousFormatter()

Returns:

The previous formatter to be used before this formatter. May be null.

getValueAsString

@OverrideOnDemand
@Nonnull
protected String getValueAsString(@Nullable
                                               Object aValue)

Convert the source value to a string by using the TypeConverter.

Parameters:

aValue - The value to be converted to a string

Returns:

The string representation of the object and never null .

getFormattedValueAsString

@Nullable
protected abstract String getFormattedValueAsString(@Nullable
                                        Object aValue)

Convert the passed value from Object to formatted String. Use getValueAsString(Object) in implementations of this method to do the base conversion from Object to String.

Parameters:

aValue - The source object. May be null.

Returns:

The formatted string value.

getFormattedValue

@Nullable
public final String getFormattedValue(@Nullable
                                Object aValue)

Description copied from interface: IFormatter

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

Specified by:

getFormattedValue in interface IFormatter

Parameters:

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

Returns:

The formatted string. Never null.

toString

public String toString()

Overrides:

toString in class Object