freemarker.ext.format
Class DateFormat

java.lang.Object
  freemarker.ext.format.DateFormat

All Implemented Interfaces:

TemplateMethodModel2, TemplateModel, java.io.Serializable

public class DateFormat
extends java.lang.Object
implements TemplateMethodModel2, java.io.Serializable

Formats numbers into the specified date format. The numbers can be wrapped Date objects, wrapped Number objects, or TemplateNumberModel values. Conversion of numbers into date values is the same as for java.util.Date values, ie. milliseconds since 1 January 1970 GMT.

Formats are specified using the same pattern as the java.text.SimpleDateFormat class. As a performance optimization, some caching of pre-parsed format templates occurs.

Usage:
From java:

 TemplateModelRoot root = new SimpleHash();

 root.put( "formatDate", freemarker.ext.format.DateFormat.getInstance() );

 ...
 

From your FM-Classic template:

 The following creates a directory path:
 <assign date = 12345678901234>
 <assign output = formatDate( "dd/MM/yyyy HH:mm", date )>
 ${output}

 ...
 

Since:

1.9

Version:

$Id: DateFormat.java 1067 2011-06-06 10:55:28Z run2000 $

Author:

Nicholas Cull

See Also:

Serialized Form

Method Summary

TemplateModel	exec(java.util.List<TemplateModel> arguments) Executes a method call.
static DateFormat	getInstance() Return a singleton instance of this class.
boolean	isEmpty() Is the object empty?

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DateFormat getInstance()

Return a singleton instance of this class.

Returns:

a new DateFormat object

isEmpty

public boolean isEmpty()
                throws TemplateModelException

Is the object empty?

Specified by:

isEmpty in interface TemplateModel

Returns:

true if this object is empty, otherwise false

Throws:

TemplateModelException

exec

public TemplateModel exec(java.util.List<TemplateModel> arguments)
                   throws TemplateModelException

Executes a method call. Arguments are passed as a List of TemplateModel objects.

Specified by:

exec in interface TemplateMethodModel2

Parameters:

arguments - a List of TemplateModel objects containing the values of the arguments passed to the method.

Returns:

the TemplateModel produced by the method, or null.

Throws:

TemplateModelException