com.helger.commons.format

Class FormatableObject

java.lang.Object

com.helger.commons.format.FormatableObject

All Implemented Interfaces:

IFormatableObject, IHasStringRepresentation

@NotThreadSafe
public class FormatableObject
extends Object
implements IFormatableObject

This class represents a single object with an additional formatter.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FormatableObject(Object aValue, IFormatter aFormatter) Init the field with a value.
FormatableObject(Object aValue, IHasFormatter aFormatterProvider) Init the field with a value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAsString() Get the value converted to a string with the specified formatter.
IFormatter	getFormatter()
Object	getValue() Get the original value.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FormatableObject

public FormatableObject(@Nullable
                Object aValue,
                @Nullable
                IFormatter aFormatter)

Init the field with a value.

Parameters:

aValue - The value to be used. May be null.

aFormatter - The optional formatter to use. May be null.

FormatableObject

public FormatableObject(@Nullable
                Object aValue,
                @Nonnull
                IHasFormatter aFormatterProvider)

Init the field with a value.

Parameters:

aValue - The value to be used. May be null.

aFormatterProvider - The formatter provider to use. May not be null.

Method Detail

getValue

@Nullable
public Object getValue()

Description copied from interface: IFormatableObject

Get the original value.

Specified by:

getValue in interface IFormatableObject

Returns:

The unformatted value. May be null.

getFormatter

@Nullable
public IFormatter getFormatter()

Specified by:

getFormatter in interface IFormatableObject

Returns:

The formatter to be used for formatting this object. Never null.

getAsString

@Nullable
public String getAsString()

Description copied from interface: IFormatableObject

Get the value converted to a string with the specified formatter.

Specified by:

getAsString in interface IFormatableObject

Specified by:

getAsString in interface IHasStringRepresentation

Returns:

the string representation of the value. May be null dependent on the semantics of the formatter.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object