com.helger.commons.format

Class FormattedObject

java.lang.Object

com.helger.commons.format.FormattedObject

All Implemented Interfaces:

IFormattedObject, IHasStringRepresentation

public class FormattedObject
extends Object
implements IFormattedObject

This class represents a single object with an additional formatter.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
FormattedObject(Object aValue, IFormatter aFormatter) Init the field with a value.
FormattedObject(Object aValue, IFormatterProvider 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

FormattedObject

public FormattedObject(@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.

FormattedObject

public FormattedObject(@Nullable
               Object aValue,
               @Nonnull
               IFormatterProvider aFormatterProvider)

Init the field with a value.

Parameters:

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

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

Method Detail

getValue

@Nullable
public Object getValue()

Description copied from interface: IFormattedObject

Get the original value.

Specified by:

getValue in interface IFormattedObject

Returns:

The unformatted value. May be null.

getFormatter

@Nonnull
public IFormatter getFormatter()

Specified by:

getFormatter in interface IFormattedObject

Returns:

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

getAsString

@Nullable
public String getAsString()

Description copied from interface: IFormattedObject

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

Specified by:

getAsString in interface IFormattedObject

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