com.atlassian.jira.datetime

Class DateTimeVelocityUtils

java.lang.Object

com.atlassian.jira.datetime.DateTimeVelocityUtils

@Immutable
public class DateTimeVelocityUtils
extends Object

Aggregates the most commonly-used date/time formats in a single instance, for use within Velocity templates. All strings returned by this class are in the user's time zone, and are either HTML- or XML-escaped (as appropriate).

Since:

v5.0

Constructor Summary

Constructors

Constructor and Description
DateTimeVelocityUtils(DateTimeFormatter dateTimeFormatter) Creates a new DateTimeFormats instance that will format date/time instances in the time zone of the passed-in DateTimeFormatter.

Method Summary

Modifier and Type	Method and Description
String	formatDMY(Date date) Returns a string representation of the given date/time in DateTimeStyle#DATE format.
String	formatDMYHMS(Date date) Returns a string representation of the given date/time in DateTimeStyle#COMPLETE format.
String	formatRSS(Date date) Returns a string representation of the given date/time in DateTimeStyle#RSS_RFC822_DATE_TIME format.
String	formatTime(Date date) Returns a string representation of the given date/time in DateTimeStyle#TIME format.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeVelocityUtils

public DateTimeVelocityUtils(DateTimeFormatter dateTimeFormatter)

Creates a new DateTimeFormats instance that will format date/time instances in the time zone of the passed-in DateTimeFormatter.

Parameters:

dateTimeFormatter - a DateTimeFormatter

Method Detail

formatDMYHMS

public String formatDMYHMS(Date date)

Returns a string representation of the given date/time in DateTimeStyle#COMPLETE format.

Parameters:

date - a date/time to format

Returns:

an string containing the given date/time (HTML-escaped)

formatDMY

public String formatDMY(Date date)

Returns a string representation of the given date/time in DateTimeStyle#DATE format.

Parameters:

date - a date/time to format

Returns:

an string containing the given date/time (HTML-escaped)

formatTime

public String formatTime(Date date)

Returns a string representation of the given date/time in DateTimeStyle#TIME format.

Parameters:

date - a date/time to format

Returns:

an string containing the given date/time (HTML-escaped)

formatRSS

public String formatRSS(Date date)

Returns a string representation of the given date/time in DateTimeStyle#RSS_RFC822_DATE_TIME format.

Parameters:

date - a date/time to format

Returns:

an string containing the given date/time (XML-escaped)