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

Class XMLDurationFormatter

java.lang.Object

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

All Implemented Interfaces:

ValueFormatter<uk.ac.ed.epcc.webapp.model.data.Duration>

public class XMLDurationFormatter
extends java.lang.Object
implements ValueFormatter<uk.ac.ed.epcc.webapp.model.data.Duration>

Formats Duration object so that it is represented as an XML duration. XML Durations may contain units in months and years. As their length of time in hours, minutes and seconds is ambiguous, this formatter will never use such units

Author:

jgreen4

Field Summary

Fields

Modifier and Type	Field and Description
static XMLDurationFormatter	FORMATTER Useful static instance of this object to be used when one doesn't want to generate lots of formatters when one will suffice

Constructor Summary

Constructors

Constructor and Description
XMLDurationFormatter()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	format(uk.ac.ed.epcc.webapp.model.data.Duration duration) Formats the duration as an XML duration.
java.lang.Class<uk.ac.ed.epcc.webapp.model.data.Duration>	getType() Returns the Class all objects acceptable as input to the format method must be assignable to.

Methods inherited from class java.lang.Object

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

Field Detail

FORMATTER

public static final XMLDurationFormatter FORMATTER

Useful static instance of this object to be used when one doesn't want to generate lots of formatters when one will suffice

Constructor Detail

XMLDurationFormatter

public XMLDurationFormatter()

Method Detail

format

public java.lang.String format(uk.ac.ed.epcc.webapp.model.data.Duration duration)

Formats the duration as an XML duration. The units used are hours, minutes, seconds and milliseconds. The duration uses as much of the largest unit as it can before moving down to the next biggest unit until the duration is completely represented. For example. Three hours, sixty minutes will always be represented as PT4H and never, PT3H60M. The formatted string will be as accurate as the duration given to it, but it may be more precise than the given duration.

Specified by:

format in interface ValueFormatter<uk.ac.ed.epcc.webapp.model.data.Duration>

Parameters:

duration - The object to format

Returns:

the duration as an XML duration

See Also:

ValueFormatter.format(java.lang.Object)

getType

public java.lang.Class<uk.ac.ed.epcc.webapp.model.data.Duration> getType()

Description copied from interface: ValueFormatter

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

Specified by:

getType in interface ValueFormatter<uk.ac.ed.epcc.webapp.model.data.Duration>

Returns:

The Type of this ValueFormatter