uk.ac.ed.epcc.safe.accounting.formatters.value

Interface ValueFormatter<F>

Type Parameters:

F - The type of object this formatter converts into a String

All Known Subinterfaces:

ValueParser<T>

All Known Implementing Classes:

BooleanParser, DateParser, DateTimeParser, DecimalParser, DefaultFormatter, DefaultFormatter, DetailedPercentFormatter, DoubleParser, FloatParser, IndexedReferenceValueParser, IntegerParser, LongParser, MemoryParser, NumberParser, PbsDateParser, PercentFormatter, ReferenceValueParser, SecondDurationParser, ShortTextPeriodFormatter, SimpleDurationParser, SlurmDurationParser, SlurmMemoryParser, StringParser, TimestampParser, TypeConverterValueParser, XMLDateTimeFormatter, XMLDateTimeParser, XMLDurationFormatter, XMLDurationParser

public interface ValueFormatter<F>

An interface that denotes the implementing object is capable of converting objects of a certain type into strings. Along with the constraints applied by this interface, all classes implementing this interface must define a no-argument constructor which properly constructs the parser. If no actual configuration is required, a constructor may be omitted entirely and the objects default constructor provided automatically by Java will be used instead.

If the class also provides the reverse operation (parsing a string into an object it should implement ValueParser.

Author:

jgreen4

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	format(F object) Formats the specified object into an appropriate String
java.lang.Class<F>	getType() Returns the Class all objects acceptable as input to the format method must be assignable to.

Method Detail

getType

java.lang.Class<F> getType()

Returns the Class all objects acceptable as input to the format method must be assignable to.

Returns:

The Type of this ValueFormatter

format

java.lang.String format(F object)

Formats the specified object into an appropriate String

Throws:

java.lang.NullPointerException - If object is null and this parser does not format null objects.

Parameters:

object - The object to format

Returns:

The string representation of object